GODOT IS OPEN SOURCE

1 files changed, 395 insertions, 0 deletions

diff --git a/scene/gui/control.h b/scene/gui/control.h
new file mode 100644
index 0000000000..a5d302105f
--- /dev/null
+++ b/scene/gui/control.h
@@ -0,0 +1,395 @@
+/*************************************************************************/
+/*  control.h                                                            */
+/*************************************************************************/
+/*                       This file is part of:                           */
+/*                           GODOT ENGINE                                */
+/*                    http://www.godotengine.org                         */
+/*************************************************************************/
+/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur.                 */
+/*                                                                       */
+/* Permission is hereby granted, free of charge, to any person obtaining */
+/* a copy of this software and associated documentation files (the       */
+/* "Software"), to deal in the Software without restriction, including   */
+/* without limitation the rights to use, copy, modify, merge, publish,   */
+/* distribute, sublicense, and/or sell copies of the Software, and to    */
+/* permit persons to whom the Software is furnished to do so, subject to */
+/* the following conditions:                                             */
+/*                                                                       */
+/* The above copyright notice and this permission notice shall be        */
+/* included in all copies or substantial portions of the Software.       */
+/*                                                                       */
+/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,       */
+/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF    */
+/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/
+/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY  */
+/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,  */
+/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE     */
+/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.                */
+/*************************************************************************/
+#ifndef CONTROL_H
+#define CONTROL_H
+
+#include "scene/main/node.h"
+#include "scene/resources/theme.h"
+#include "scene/main/timer.h"
+#include "scene/2d/canvas_item.h"
+#include "math_2d.h"
+#include "rid.h"
+
+/**
+	@author Juan Linietsky <reduzio@gmail.com>
+*/
+
+class Viewport;
+class Label;
+class Panel;
+
+class Control : public CanvasItem {
+	
+	OBJ_TYPE( Control, CanvasItem );
+	OBJ_CATEGORY("GUI Nodes");
+
+public:
+	
+	enum AnchorType {		
+		ANCHOR_BEGIN,
+		ANCHOR_END,
+		ANCHOR_RATIO		
+	};
+	
+	enum FocusMode {
+		FOCUS_NONE,
+		FOCUS_CLICK,
+		FOCUS_ALL
+	};
+
+	enum SizeFlags {
+
+		SIZE_EXPAND=1,
+		SIZE_FILL=2,
+		SIZE_EXPAND_FILL=SIZE_EXPAND|SIZE_FILL
+
+	};
+
+	enum CursorShape {
+		CURSOR_ARROW,
+		CURSOR_IBEAM,
+		CURSOR_POINTING_HAND,
+		CURSOR_CROSS,
+		CURSOR_WAIT,
+		CURSOR_BUSY,
+		CURSOR_DRAG,
+		CURSOR_CAN_DROP,
+		CURSOR_FORBIDDEN,
+		CURSOR_VSIZE,
+		CURSOR_HSIZE,
+		CURSOR_BDIAGSIZE,
+		CURSOR_FDIAGSIZE,
+		CURSOR_MOVE,
+		CURSOR_VSPLIT,
+		CURSOR_HSPLIT,
+		CURSOR_HELP,
+		CURSOR_MAX
+	};
+
+private:
+
+	struct CComparator {
+
+		bool operator()(const Control* p_a, const Control* p_b) const { return p_b->is_greater_than(p_a); }
+	};
+
+	struct Data {
+			
+		Point2 pos_cache;
+		Size2 size_cache;
+
+		float margin[4];
+		AnchorType anchor[4];
+		FocusMode focus_mode;		
+
+		bool pending_resize;
+
+		int h_size_flags;
+		int v_size_flags;
+		float expand;
+		bool pending_min_size_update;
+		Point2 custom_minimum_size;
+
+		bool ignore_mouse;
+		bool stop_mouse;
+
+		Control *parent;
+		Control *window;
+		bool modal;
+		bool modal_exclusive;
+		Ref<Theme> theme;
+		Control *theme_owner;		
+		String tooltip;
+		CursorShape default_cursor;
+
+		List<Control*>::Element *MI; //modal item
+		List<Control*>::Element *SI;
+
+		CanvasItem *parent_canvas_item;
+
+		Viewport *viewport;
+
+		ObjectID modal_prev_focus_owner;
+
+		NodePath focus_neighbour[4];
+
+		HashMap<StringName, Ref<Texture>, StringNameHasher > icon_override;
+		HashMap<StringName, Ref<StyleBox>, StringNameHasher > style_override;
+		HashMap<StringName, Ref<Font>, StringNameHasher > font_override;
+		HashMap<StringName, Color, StringNameHasher > color_override;
+		HashMap<StringName, int, StringNameHasher > constant_override;
+	} data;
+	
+	struct Window {
+		// info used when this is a window 	
+
+		bool key_event_accepted;
+		Control *mouse_focus;
+		int mouse_focus_button;
+		Control *key_focus;
+		Control *mouse_over;
+		Control *tooltip;
+		Panel *tooltip_popup;
+		Label *tooltip_label;
+		Point2 tooltip_pos;
+		Point2 last_mouse_pos;
+		Point2 drag_accum;
+		bool drag_attempted;
+		Variant drag_data;
+		Control *drag_preview;
+		Timer *tooltip_timer;
+		List<Control*> modal_stack;
+		unsigned int cancelled_input_ID;
+		Matrix32 focus_inv_xform;
+		bool subwindow_order_dirty;
+		List<Control*> subwindows;
+		bool disable_input;
+
+		Window();
+	};
+
+	Window *window;
+	
+	// used internally
+	Control* _find_next_visible_control_at_pos(Node* p_node,const Point2& p_global,Matrix32& r_xform) const;
+	Control* _find_control_at_pos(CanvasItem* p_node,const Point2& p_pos,const Matrix32& p_xform,Matrix32& r_inv_xform);
+
+
+	void _window_sort_subwindows();
+	void _window_accept_event();
+	void _window_remove_focus();
+	void _window_cancel_input_ID(int p_input);
+	void _window_sort_modal_stack();
+	void _window_find_focus_neighbour(const Vector2& p_dir, Node *p_at, const Point2* p_points ,float p_min,float &r_closest_dist,Control **r_closest);
+	Control *_get_focus_neighbour(Margin p_margin,int p_count=0);
+	void _window_call_input(Control *p_control,const InputEvent& p_input);
+
+	float _get_parent_range(int p_idx) const;
+	float _get_range(int p_idx) const;
+	Point2 _window_get_pos() const;
+	float _s2a(float p_val, AnchorType p_anchor,float p_range) const;
+	float _a2s(float p_val, AnchorType p_anchor,float p_range) const;
+	void _modal_stack_remove();
+	void _propagate_theme_changed(Control *p_owner);
+
+	void _change_notify_margins();
+	void _window_cancel_tooltip();
+	void _window_show_tooltip();
+	void _update_minimum_size();
+
+	void _update_scroll();
+	void _gui_input(const InputEvent& p_event); //used by scene main loop
+	void _input_text(const String& p_text);
+	void _resize(const Size2& p_size);
+
+	void _size_changed();
+	String _get_tooltip() const;
+
+
+protected:	
+	bool window_has_modal_stack() const;
+
+	virtual void _window_input_event(InputEvent p_event);
+
+	bool _set(const StringName& p_name, const Variant& p_value);
+	bool _get(const StringName& p_name,Variant &r_ret) const;
+	void _get_property_list( List<PropertyInfo> *p_list) const;
+
+	void _notification(int p_notification);
+
+	
+	static void _bind_methods();	
+	
+	//bind helpers 
+	
+public:
+
+	enum {
+	
+/*		NOTIFICATION_DRAW=30,
+		NOTIFICATION_VISIBILITY_CHANGED=38*/
+		NOTIFICATION_RESIZED=40,
+		NOTIFICATION_MOUSE_ENTER=41,
+		NOTIFICATION_MOUSE_EXIT=42,
+		NOTIFICATION_FOCUS_ENTER=43,
+		NOTIFICATION_FOCUS_EXIT=44,
+		NOTIFICATION_THEME_CHANGED=45,
+		NOTIFICATION_MODAL_CLOSE=46,
+
+
+	};
+
+	virtual Variant edit_get_state() const;
+	virtual void edit_set_state(const Variant& p_state);
+	virtual void edit_set_rect(const Rect2& p_edit_rect);
+	virtual Size2 edit_get_minimum_size() const;
+
+	void accept_event();
+
+	virtual Size2 get_minimum_size() const;
+	virtual Size2 get_combined_minimum_size() const;
+	virtual bool has_point(const Point2& p_point) const;
+	virtual bool clips_input() const;
+	virtual Variant get_drag_data(const Point2& p_point);
+	virtual bool can_drop_data(const Point2& p_point,const Variant& p_data) const;
+	virtual void drop_data(const Point2& p_point,const Variant& p_data);
+	void set_drag_preview(Control *p_control);
+	void force_drag(const Variant& p_data,Control *p_control);
+
+	void set_custom_minimum_size(const Size2& p_custom);
+	Size2 get_custom_minimum_size() const;
+
+	bool is_window() const;
+	Control *get_window() const;
+	Control *get_parent_control() const;
+
+
+	
+	/* POSITIONING */
+	
+	void set_anchor(Margin p_margin,AnchorType p_anchor);
+	void set_anchor_and_margin(Margin p_margin,AnchorType p_anchor, float p_pos);
+	
+	AnchorType get_anchor(Margin p_margin) const;
+		
+	void set_margin(Margin p_margin,float p_value);
+	
+	void set_begin(const Point2& p_point); // helper
+	void set_end(const Point2& p_point); // helper
+	
+	
+	
+	float get_margin(Margin p_margin) const;
+	Point2 get_begin() const;
+	Point2 get_end() const;
+		
+	void set_pos(const Point2& p_point);
+	void set_size(const Size2& p_size);
+	void set_global_pos(const Point2& p_point);
+	
+	Point2 get_pos() const;
+	Point2 get_global_pos() const;
+	Size2 get_size() const;
+	Rect2 get_rect() const;
+	Rect2 get_global_rect() const;
+	Rect2 get_window_rect() const; ///< use with care, as it blocks waiting for the visual server
+	
+	void set_area_as_parent_rect(int p_margin=0);
+	
+	void show_modal(bool p_exclusive=false);
+
+	void set_theme(const Ref<Theme>& p_theme);
+	Ref<Theme> get_theme() const;
+
+	void set_h_size_flags(int p_flags);
+	int get_h_size_flags() const;
+
+	void set_v_size_flags(int p_flags);
+	int get_v_size_flags() const;
+
+	void set_stretch_ratio(float p_ratio);
+	float get_stretch_ratio() const;
+
+	void minimum_size_changed();
+
+	/* FOCUS */
+	
+	void set_focus_mode(FocusMode p_focus_mode);
+	FocusMode get_focus_mode() const;
+	bool has_focus() const;
+	void grab_focus();
+	void release_focus();
+
+	Control *find_next_valid_focus() const;
+	Control *find_prev_valid_focus() const;
+
+	void set_focus_neighbour(Margin p_margin, const NodePath &p_neighbour);
+	NodePath get_focus_neighbour(Margin p_margin) const;
+
+	Control *get_focus_owner() const;
+
+	void set_ignore_mouse(bool p_ignore);
+	bool is_ignoring_mouse() const;
+
+	void set_stop_mouse(bool p_stop);
+	bool is_stopping_mouse() const;
+
+	/* SKINNING */
+	
+	void add_icon_override(const StringName& p_name, const Ref<Texture>& p_icon);
+	void add_style_override(const StringName& p_name, const Ref<StyleBox>& p_style);
+	void add_font_override(const StringName& p_name, const Ref<Font>& p_font);
+	void add_color_override(const StringName& p_name, const Color& p_color);
+	void add_constant_override(const StringName& p_name, int p_constant);
+
+	Ref<Texture> get_icon(const StringName& p_name,const StringName& p_type=StringName()) const;
+	Ref<StyleBox> get_stylebox(const StringName& p_name,const StringName& p_type=StringName()) const;
+	Ref<Font> get_font(const StringName& p_name,const StringName& p_type=StringName()) const;
+	Color get_color(const StringName& p_name,const StringName& p_type=StringName()) const;
+	int get_constant(const StringName& p_name,const StringName& p_type=StringName()) const;
+
+	bool has_icon(const StringName& p_name,const StringName& p_type=StringName()) const;
+	bool has_stylebox(const StringName& p_name,const StringName& p_type=StringName()) const;
+	bool has_font(const StringName& p_name,const StringName& p_type=StringName()) const;
+	bool has_color(const StringName& p_name,const StringName& p_type=StringName()) const;
+	bool has_constant(const StringName& p_name,const StringName& p_type=StringName()) const;
+
+	/* TOOLTIP */
+
+	void set_tooltip(const String& p_tooltip);
+	virtual String get_tooltip(const Point2& p_pos) const;
+
+	/* CURSOR */
+
+	void set_default_cursor_shape(CursorShape p_shape);
+	CursorShape get_default_cursor_shape() const;
+	virtual CursorShape get_cursor_shape(const Point2& p_pos=Point2i()) const;
+
+	virtual Rect2 get_item_rect() const;
+	virtual Matrix32 get_transform() const;
+
+	bool is_toplevel_control() const;
+
+	Size2 get_parent_area_size() const;
+
+	void grab_click_focus();
+
+
+
+	Control();	
+	~Control();
+
+};
+
+VARIANT_ENUM_CAST(Control::AnchorType);
+VARIANT_ENUM_CAST(Control::FocusMode);
+VARIANT_ENUM_CAST(Control::SizeFlags);
+VARIANT_ENUM_CAST(Control::CursorShape);
+
+#endif