summaryrefslogtreecommitdiff
path: root/scene/gui/control.h
diff options
context:
space:
mode:
Diffstat (limited to 'scene/gui/control.h')
-rw-r--r--scene/gui/control.h204
1 files changed, 94 insertions, 110 deletions
diff --git a/scene/gui/control.h b/scene/gui/control.h
index 68795b054c..a18567123b 100644
--- a/scene/gui/control.h
+++ b/scene/gui/control.h
@@ -29,13 +29,13 @@
#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"
+#include "scene/2d/canvas_item.h"
#include "scene/gui/input_action.h"
+#include "scene/main/node.h"
+#include "scene/main/timer.h"
+#include "scene/resources/theme.h"
/**
@author Juan Linietsky <reduzio@gmail.com>
*/
@@ -46,11 +46,10 @@ class Panel;
class Control : public CanvasItem {
- GDCLASS( Control, CanvasItem );
+ GDCLASS(Control, CanvasItem);
OBJ_CATEGORY("GUI Nodes");
public:
-
enum AnchorType {
ANCHOR_BEGIN,
ANCHOR_END,
@@ -65,9 +64,9 @@ public:
enum SizeFlags {
- SIZE_FILL=1,
- SIZE_EXPAND=2,
- SIZE_EXPAND_FILL=SIZE_EXPAND|SIZE_FILL
+ SIZE_FILL = 1,
+ SIZE_EXPAND = 2,
+ SIZE_EXPAND_FILL = SIZE_EXPAND | SIZE_FILL
};
@@ -99,11 +98,10 @@ public:
};
private:
-
struct CComparator {
- bool operator()(const Control* p_a, const Control* p_b) const {
- if (p_a->get_canvas_layer()==p_b->get_canvas_layer())
+ bool operator()(const Control *p_a, const Control *p_b) const {
+ if (p_a->get_canvas_layer() == p_b->get_canvas_layer())
return p_b->is_greater_than(p_a);
else
return p_a->get_canvas_layer() < p_b->get_canvas_layer();
@@ -147,9 +145,9 @@ private:
String tooltip;
CursorShape default_cursor;
- List<Control*>::Element *MI; //modal item
- List<Control*>::Element *SI;
- List<Control*>::Element *RI;
+ List<Control *>::Element *MI; //modal item
+ List<Control *>::Element *SI;
+ List<Control *>::Element *RI;
CanvasItem *parent_canvas_item;
@@ -157,39 +155,36 @@ private:
NodePath focus_neighbour[4];
- HashMap<StringName, Ref<Texture>, StringNameHasher > icon_override;
- HashMap<StringName, Ref<Shader>, StringNameHasher > shader_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;
- Map< Ref<Font>, int> font_refcount;
+ HashMap<StringName, Ref<Texture>, StringNameHasher> icon_override;
+ HashMap<StringName, Ref<Shader>, StringNameHasher> shader_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;
+ Map<Ref<Font>, int> font_refcount;
} data;
// used internally
- Control* _find_control_at_pos(CanvasItem* p_node,const Point2& p_pos,const Transform2D& p_xform,Transform2D& r_inv_xform);
-
-
- 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);
+ Control *_find_control_at_pos(CanvasItem *p_node, const Point2 &p_pos, const Transform2D &p_xform, Transform2D &r_inv_xform);
+ 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 _set_anchor(Margin p_margin,AnchorType p_anchor);
+ void _set_anchor(Margin p_margin, AnchorType p_anchor);
float _get_parent_range(int p_idx) const;
float _get_range(int p_idx) 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 _propagate_theme_changed(CanvasItem *p_at, Control *p_owner, bool p_assign=true);
+ 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 _propagate_theme_changed(CanvasItem *p_at, Control *p_owner, bool p_assign = true);
void _theme_changed();
-
void _change_notify_margins();
void _update_minimum_size();
void _update_scroll();
- void _resize(const Size2& p_size);
+ void _resize(const Size2 &p_size);
void _size_changed();
String _get_tooltip() const;
@@ -199,70 +194,65 @@ private:
float _get_rotation_deg() const;
void _ref_font(Ref<Font> p_sc);
- void _unref_font( Ref<Font> p_sc);
+ void _unref_font(Ref<Font> p_sc);
void _font_changed();
void _update_canvas_item_transform();
-
-friend class Viewport;
+ friend class Viewport;
void _modal_stack_remove();
void _modal_set_prev_focus_owner(ObjectID p_prev);
protected:
-
virtual void add_child_notify(Node *p_child);
virtual void remove_child_notify(Node *p_child);
//virtual void _window_gui_input(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;
+ 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_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,
-
+ 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 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 has_point(const Point2 &p_point) const;
virtual bool clips_input() const;
- virtual void set_drag_forwarding(Control* p_target);
- 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);
+ virtual void set_drag_forwarding(Control *p_target);
+ 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 force_drag(const Variant &p_data, Control *p_control);
- void set_custom_minimum_size(const Size2& p_custom);
+ void set_custom_minimum_size(const Size2 &p_custom);
Size2 get_custom_minimum_size() const;
bool is_window_modal_on_top() const;
@@ -270,29 +260,25 @@ public:
Control *get_parent_control() const;
-
-
/* POSITIONING */
- void set_anchor(Margin p_margin,AnchorType p_anchor, bool p_keep_margin=false);
- void set_anchor_and_margin(Margin p_margin,AnchorType p_anchor, float p_pos);
+ void set_anchor(Margin p_margin, AnchorType p_anchor, bool p_keep_margin = false);
+ 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
-
+ 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);
+ 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;
@@ -306,15 +292,14 @@ public:
float get_rotation() const;
float get_rotation_deg() const;
- void set_scale(const Vector2& p_scale);
+ void set_scale(const Vector2 &p_scale);
Vector2 get_scale() const;
+ void set_area_as_parent_rect(int p_margin = 0);
- void set_area_as_parent_rect(int p_margin=0);
-
- void show_modal(bool p_exclusive=false);
+ void show_modal(bool p_exclusive = false);
- void set_theme(const Ref<Theme>& p_theme);
+ void set_theme(const Ref<Theme> &p_theme);
Ref<Theme> get_theme() const;
void set_h_size_flags(int p_flags);
@@ -349,44 +334,44 @@ public:
/* SKINNING */
- void add_icon_override(const StringName& p_name, const Ref<Texture>& p_icon);
- void add_shader_override(const StringName& p_name, const Ref<Shader>& p_shader);
- 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<Shader> get_shader(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_override(const StringName& p_name) const;
- bool has_shader_override(const StringName& p_name) const;
- bool has_stylebox_override(const StringName& p_name) const;
- bool has_font_override(const StringName& p_name) const;
- bool has_color_override(const StringName& p_name) const;
- bool has_constant_override(const StringName& p_name) const;
-
- bool has_icon(const StringName& p_name,const StringName& p_type=StringName()) const;
- bool has_shader(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;
+ void add_icon_override(const StringName &p_name, const Ref<Texture> &p_icon);
+ void add_shader_override(const StringName &p_name, const Ref<Shader> &p_shader);
+ 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<Shader> get_shader(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_override(const StringName &p_name) const;
+ bool has_shader_override(const StringName &p_name) const;
+ bool has_stylebox_override(const StringName &p_name) const;
+ bool has_font_override(const StringName &p_name) const;
+ bool has_color_override(const StringName &p_name) const;
+ bool has_constant_override(const StringName &p_name) const;
+
+ bool has_icon(const StringName &p_name, const StringName &p_type = StringName()) const;
+ bool has_shader(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;
+ 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 CursorShape get_cursor_shape(const Point2 &p_pos = Point2i()) const;
virtual Rect2 get_item_rect() const;
virtual Transform2D get_transform() const;
@@ -397,7 +382,7 @@ public:
void grab_click_focus();
- void warp_mouse(const Point2& p_to_pos);
+ void warp_mouse(const Point2 &p_to_pos);
virtual bool is_text_field() const;
@@ -412,11 +397,10 @@ public:
void set_disable_visibility_clip(bool p_ignore);
bool is_visibility_clip_disabled() const;
- virtual void get_argument_options(const StringName& p_function,int p_idx,List<String>*r_options) const;
+ virtual void get_argument_options(const StringName &p_function, int p_idx, List<String> *r_options) const;
Control();
~Control();
-
};
VARIANT_ENUM_CAST(Control::AnchorType);
generated by cgit v1.2.3 (git 2.25.1) at 2025-06-03 15:47:17 +0000