godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
godot/scene/gui/control.h

508 lines
17 KiB
C++
Raw Normal View History

GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
/*************************************************************************/
/* control.h */
/*************************************************************************/
/* This file is part of: */
/* GODOT ENGINE */
Use HTTPS URL for Godot's website in the headers
2017-08-27 12:16:55 +00:00
/* https://godotengine.org */
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
/*************************************************************************/
Update copyright statements to 2020 Happy new year to the wonderful Godot community! We're starting a new decade with a well-established, non-profit, free and open source game engine, and tons of further improvements in the pipeline from hundreds of contributors. Godot will keep getting better, and we're looking forward to all the games that the community will keep developing and releasing with it.
2020-01-01 10:16:22 +00:00
/* Copyright (c) 2007-2020 Juan Linietsky, Ariel Manzur. */
/* Copyright (c) 2014-2020 Godot Engine contributors (cf. AUTHORS.md). */
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
/* */
/* 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. */
/*************************************************************************/
Add missing copyright headers and fix formatting Using `misc/scripts/fix_headers.py` on all Godot files. Some missing header guards were added, and the header inclusion order was fixed in the Bullet module.
2018-01-04 23:50:27 +00:00
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
#ifndef CONTROL_H
#define CONTROL_H
Make core/ includes absolute, remove subfolders from include path This allows more consistency in the manner we include core headers, where previously there would be a mix of absolute, relative and include path-dependent includes.
2018-09-11 16:13:45 +00:00
#include "core/math/transform_2d.h"
#include "core/rid.h"
Dead code tells no tales
2017-08-27 19:07:15 +00:00
#include "scene/gui/shortcut.h"
Rename more 2D and 3D nodes to follow convention Rename editor plugins to match the new node names.
2020-03-27 07:44:44 +00:00
#include "scene/main/canvas_item.h"
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
#include "scene/main/node.h"
#include "scene/main/timer.h"
#include "scene/resources/theme.h"
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
class Viewport;
class Label;
class Panel;
class Control : public CanvasItem {
remove trailing whitespace
2016-03-08 23:00:52 +00:00
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
GDCLASS(Control, CanvasItem);
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
OBJ_CATEGORY("GUI Nodes");
public:
Changed anchor constants to enum, removed ANCHOR_CENTER, fixes #9889
2017-08-15 22:48:38 +00:00
enum Anchor {
ANCHOR_BEGIN = 0,
ANCHOR_END = 1
};
remove trailing whitespace
2016-03-08 23:00:52 +00:00
-Ability for controls to grow the left/top when anchored. This makes anchoring controls to the right/bottom easier when they are resized.
2017-07-06 16:26:39 +00:00
enum GrowDirection {
GROW_DIRECTION_BEGIN,
Implements #16546 by adding GROW_DIRECTION_BOTH which allows a control to grow from its center.
2018-02-12 03:58:39 +00:00
GROW_DIRECTION_END,
GROW_DIRECTION_BOTH
-Ability for controls to grow the left/top when anchored. This makes anchoring controls to the right/bottom easier when they are resized.
2017-07-06 16:26:39 +00:00
};
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
enum FocusMode {
FOCUS_NONE,
FOCUS_CLICK,
FOCUS_ALL
};
enum SizeFlags {
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
SIZE_FILL = 1,
SIZE_EXPAND = 2,
More fill modes for containers, closes #9504
2017-07-06 22:06:55 +00:00
SIZE_EXPAND_FILL = SIZE_EXPAND | SIZE_FILL,
SIZE_SHRINK_CENTER = 4, //ignored by expand or fill
Add expand/collapse all buttons for the "Errors" tab
2018-09-13 02:53:10 +00:00
SIZE_SHRINK_END = 8, //ignored by expand or fill
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
};
-removed stop mouse and ignore mouse from control, which were confusing, replaced by mouse filter
2017-01-08 22:54:19 +00:00
enum MouseFilter {
MOUSE_FILTER_STOP,
MOUSE_FILTER_PASS,
MOUSE_FILTER_IGNORE
};
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
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
};
Adds a function to set Anchors with a layout preset
2017-08-11 16:16:28 +00:00
enum LayoutPreset {
PRESET_TOP_LEFT,
PRESET_TOP_RIGHT,
PRESET_BOTTOM_LEFT,
PRESET_BOTTOM_RIGHT,
PRESET_CENTER_LEFT,
PRESET_CENTER_TOP,
PRESET_CENTER_RIGHT,
PRESET_CENTER_BOTTOM,
PRESET_CENTER,
PRESET_LEFT_WIDE,
PRESET_TOP_WIDE,
PRESET_RIGHT_WIDE,
PRESET_BOTTOM_WIDE,
PRESET_VCENTER_WIDE,
PRESET_HCENTER_WIDE,
PRESET_WIDE
};
Implements set_margins_preset(...)
2017-09-19 20:39:19 +00:00
enum LayoutPresetMode {
PRESET_MODE_MINSIZE,
PRESET_MODE_KEEP_WIDTH,
PRESET_MODE_KEEP_HEIGHT,
PRESET_MODE_KEEP_SIZE
};
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
private:
struct CComparator {
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
bool operator()(const Control *p_a, const Control *p_b) const {
if (p_a->get_canvas_layer() == p_b->get_canvas_layer())
-Take in consideration canvas layers for GUI input
2016-01-24 13:57:42 +00:00
return p_b->is_greater_than(p_a);
Some code changed with Clang-Tidy
2019-06-26 13:08:25 +00:00
return p_a->get_canvas_layer() < p_b->get_canvas_layer();
-Take in consideration canvas layers for GUI input
2016-01-24 13:57:42 +00:00
}
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
};
struct Data {
remove trailing whitespace
2016-03-08 23:00:52 +00:00
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Point2 pos_cache;
Size2 size_cache;
-New inspector. -Changed UI resizing code, gained huge amount of speed. -Reorganized timer sync to clean up behavior (sorry forgot commit this before) -
2018-05-15 20:12:35 +00:00
Size2 minimum_size_cache;
bool minimum_size_valid;
Size2 last_minimum_size;
bool updating_last_minimum_size;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
float margin[4];
Replace GUI anchor type by a float between 0 and 1
2017-07-06 07:16:27 +00:00
float anchor[4];
added rotation and scale support to gui controls
2015-12-12 16:54:26 +00:00
FocusMode focus_mode;
-Ability for controls to grow the left/top when anchored. This makes anchoring controls to the right/bottom easier when they are resized.
2017-07-06 16:26:39 +00:00
GrowDirection h_grow;
GrowDirection v_grow;
added rotation and scale support to gui controls
2015-12-12 16:54:26 +00:00
float rotation;
Vector2 scale;
Ability to set rotation and scaling pivot for controls.
2017-07-06 20:42:44 +00:00
Vector2 pivot_offset;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
bool pending_resize;
int h_size_flags;
int v_size_flags;
float expand;
Point2 custom_minimum_size;
-removed stop mouse and ignore mouse from control, which were confusing, replaced by mouse filter
2017-01-08 22:54:19 +00:00
MouseFilter mouse_filter;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
-All types have editable script now in properties -Changed clip to a property in Control which can be set by the user
2017-01-09 18:50:08 +00:00
bool clip_contents;
More visual script work -Block switches to 2d/3d editor if editing visual script -Added cast node in flow control -Added ability to do RPC in visual script -Comment nodes -Fix bug with inverted cable in connecting backwards -Copy and paste nodes, including from different scripts
2016-08-25 20:45:20 +00:00
bool block_minimum_size_adjust;
More visual script improvements -Added anti-aliasing on lines -Improved draw performance enormously -Removed sequence ports for most nodes, current visual scripts will likely be broken now. Sorry!
2016-08-31 02:44:14 +00:00
bool disable_visibility_clip;
More visual script work -Block switches to 2d/3d editor if editing visual script -Added cast node in flow control -Added ability to do RPC in visual script -Comment nodes -Fix bug with inverted cable in connecting backwards -Copy and paste nodes, including from different scripts
2016-08-25 20:45:20 +00:00
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Control *parent;
Add ability to send drag events to another object will be documented/tested later
2016-05-03 14:10:28 +00:00
ObjectID drag_owner;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Ref<Theme> theme;
remove trailing whitespace
2016-03-08 23:00:52 +00:00
Control *theme_owner;
Working multiple window support, including editor
2020-03-06 17:00:16 +00:00
Window *theme_owner_window;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
String tooltip;
CursorShape default_cursor;
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
List<Control *>::Element *RI;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
CanvasItem *parent_canvas_item;
NodePath focus_neighbour[4];
Add manual overrides for focus_next and focus_previous on controls similar to what can already be done with focus neighbours.
2017-11-16 09:45:52 +00:00
NodePath focus_next;
NodePath focus_prev;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Style: Set clang-format Standard to Cpp11 For us, it practically only changes the fact that `A<A<int>>` is now used instead of the C++03 compatible `A<A<int> >`. Note: clang-format 10+ changed the `Standard` arguments to fully specified `c++11`, `c++14`, etc. versions, but we can't use `c++17` now if we want to preserve compatibility with clang-format 8 and 9. `Cpp11` is still supported as deprecated alias for `Latest`.
2020-03-17 06:33:00 +00:00
HashMap<StringName, Ref<Texture2D>> icon_override;
HashMap<StringName, Ref<Shader>> shader_override;
HashMap<StringName, Ref<StyleBox>> style_override;
HashMap<StringName, Ref<Font>> font_override;
-Fixes to how hashing happened, now StringName and NodePath use default hasher, this was leading to some severe slowdown in scenarios -Fixes to some duplication scenarios for instanced scenes
2018-07-02 18:08:35 +00:00
HashMap<StringName, Color> color_override;
HashMap<StringName, int> constant_override;
Keep track of when fonts change, so theme or controls that use fonts as overrides get properly updated. closes #4622 , probably closes many other issues too
2016-06-17 19:00:27 +00:00
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
} data;
remove trailing whitespace
2016-03-08 23:00:52 +00:00
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
// used internally
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
Control *_find_control_at_pos(CanvasItem *p_node, const Point2 &p_pos, const Transform2D &p_xform, Transform2D &r_inv_xform);
-Moved all the "root" input handling for GUI from individual Controls to Viewport. -Should fix several reported bugs when controls don't have a common parent This may have added new bugs, so please report if so!
2016-01-17 01:41:10 +00:00
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
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);
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Replace GUI anchor type by a float between 0 and 1
2017-07-06 07:16:27 +00:00
void _set_anchor(Margin p_margin, float p_anchor);
Improve the anchors and margin workflow
2019-03-31 16:53:24 +00:00
void _set_position(const Point2 &p_point);
void _set_global_position(const Point2 &p_point);
void _set_size(const Size2 &p_size);
Add option to keep margins when changing anchors, closes #3979 Amend: Fixed an issue for non-tool builds Amend2: Same, just fixed doing nothing at some times
2016-03-09 16:59:35 +00:00
properly fixed notificaitons for theme changed, closes #5774
2016-07-18 19:41:28 +00:00
void _theme_changed();
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
void _change_notify_margins();
void _update_minimum_size();
void _update_scroll();
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
void _resize(const Size2 &p_size);
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Fixes the bad calculation of margin & anchors when child of Node2D
2018-05-05 14:59:00 +00:00
void _compute_margins(Rect2 p_rect, const float p_anchors[4], float (&r_margins)[4]);
Improve the anchors and margin workflow
2019-03-31 16:53:24 +00:00
void _compute_anchors(Rect2 p_rect, const float p_margins[4], float (&r_anchors)[4]);
Fixes the bad calculation of margin & anchors when child of Node2D
2018-05-05 14:59:00 +00:00
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
void _size_changed();
String _get_tooltip() const;
Update controls when a stylebox or icon override changes; change to CONNECT_REFERENCE_COUNTED Also, cleanup unnessesary calls to update() and NOTIFICATION_THEME_CHANGED. Fixes #25904.
2019-02-25 15:13:25 +00:00
void _override_changed();
Keep track of when fonts change, so theme or controls that use fonts as overrides get properly updated. closes #4622 , probably closes many other issues too
2016-06-17 19:00:27 +00:00
More visual script improvements -Added anti-aliasing on lines -Improved draw performance enormously -Removed sequence ports for most nodes, current visual scripts will likely be broken now. Sorry!
2016-08-31 02:44:14 +00:00
void _update_canvas_item_transform();
Keep track of when fonts change, so theme or controls that use fonts as overrides get properly updated. closes #4622 , probably closes many other issues too
2016-06-17 19:00:27 +00:00
Ability to set rotation and scaling pivot for controls.
2017-07-06 20:42:44 +00:00
Transform2D _get_internal_transform() const;
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
friend class Viewport;
-Moved all the "root" input handling for GUI from individual Controls to Viewport. -Should fix several reported bugs when controls don't have a common parent This may have added new bugs, so please report if so!
2016-01-17 01:41:10 +00:00
-New inspector. -Changed UI resizing code, gained huge amount of speed. -Reorganized timer sync to clean up behavior (sorry forgot commit this before) -
2018-05-15 20:12:35 +00:00
void _update_minimum_size_cache();
Working multiple window support, including editor
2020-03-06 17:00:16 +00:00
friend class Window;
static void _propagate_theme_changed(Node *p_at, Control *p_owner, Window *p_owner_window, bool p_assign = true);
template <class T>
Popups are now windows also (broken!)
2020-03-12 12:37:40 +00:00
_FORCE_INLINE_ static bool _find_theme_item(Control *p_theme_owner, Window *p_theme_owner_window, T &, T (Theme::*get_func)(const StringName &, const StringName &) const, bool (Theme::*has_func)(const StringName &, const StringName &) const, const StringName &p_name, const StringName &p_type);
Working multiple window support, including editor
2020-03-06 17:00:16 +00:00
Popups are now windows also (broken!)
2020-03-12 12:37:40 +00:00
_FORCE_INLINE_ static bool _has_theme_item(Control *p_theme_owner, Window *p_theme_owner_window, bool (Theme::*has_func)(const StringName &, const StringName &) const, const StringName &p_name, const StringName &p_type);
static Ref<Texture2D> get_icons(Control *p_theme_owner, Window *p_theme_owner_window, const StringName &p_name, const StringName &p_type = StringName());
static Ref<Shader> get_shaders(Control *p_theme_owner, Window *p_theme_owner_window, const StringName &p_name, const StringName &p_type = StringName());
static Ref<StyleBox> get_styleboxs(Control *p_theme_owner, Window *p_theme_owner_window, const StringName &p_name, const StringName &p_type = StringName());
static Ref<Font> get_fonts(Control *p_theme_owner, Window *p_theme_owner_window, const StringName &p_name, const StringName &p_type = StringName());
static Color get_colors(Control *p_theme_owner, Window *p_theme_owner_window, const StringName &p_name, const StringName &p_type = StringName());
static int get_constants(Control *p_theme_owner, Window *p_theme_owner_window, const StringName &p_name, const StringName &p_type = StringName());
static bool has_icons(Control *p_theme_owner, Window *p_theme_owner_window, const StringName &p_name, const StringName &p_type = StringName());
static bool has_shaders(Control *p_theme_owner, Window *p_theme_owner_window, const StringName &p_name, const StringName &p_type = StringName());
static bool has_styleboxs(Control *p_theme_owner, Window *p_theme_owner_window, const StringName &p_name, const StringName &p_type = StringName());
static bool has_fonts(Control *p_theme_owner, Window *p_theme_owner_window, const StringName &p_name, const StringName &p_type = StringName());
static bool has_colors(Control *p_theme_owner, Window *p_theme_owner_window, const StringName &p_name, const StringName &p_type = StringName());
static bool has_constants(Control *p_theme_owner, Window *p_theme_owner_window, const StringName &p_name, const StringName &p_type = StringName());
-New inspector. -Changed UI resizing code, gained huge amount of speed. -Reorganized timer sync to clean up behavior (sorry forgot commit this before) -
2018-05-15 20:12:35 +00:00
remove trailing whitespace
2016-03-08 23:00:52 +00:00
protected:
VisualScript can now execute visual scripts, but there is no debugger or profiler yet.
2016-08-06 01:46:45 +00:00
virtual void add_child_notify(Node *p_child);
virtual void remove_child_notify(Node *p_child);
renamed _input_event for GUI events to _gui_input, so it's more differentiated than generalized _input
2017-01-08 19:28:12 +00:00
//virtual void _window_gui_input(InputEvent p_event);
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
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;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
void _notification(int p_notification);
remove trailing whitespace
2016-03-08 23:00:52 +00:00
static void _bind_methods();
//bind helpers
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
public:
enum {
remove trailing whitespace
2016-03-08 23:00:52 +00:00
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
/* NOTIFICATION_DRAW=30,
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
NOTIFICATION_VISIBILITY_CHANGED=38*/
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
NOTIFICATION_RESIZED = 40,
NOTIFICATION_MOUSE_ENTER = 41,
NOTIFICATION_MOUSE_EXIT = 42,
NOTIFICATION_FOCUS_ENTER = 43,
NOTIFICATION_FOCUS_EXIT = 44,
NOTIFICATION_THEME_CHANGED = 45,
Make BaseButton not emit press when container is scrolled This fixes the problem described in #13996 in a proper way. This also adds "deadzone" property to ScrollContainer. It can be used on mobile, where taps are not as precise as mouse clicks. Player could slightly move their finger when tapping, in which case we still want the button to be pressed rather than the container to be scrolled.
2018-02-27 15:37:20 +00:00
NOTIFICATION_SCROLL_BEGIN = 47,
NOTIFICATION_SCROLL_END = 48,
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
};
Fixes the bad calculation of margin & anchors when child of Node2D
2018-05-05 14:59:00 +00:00
/* EDITOR */
Don't compile editor-only function when tools=no
2019-10-21 21:37:07 +00:00
#ifdef TOOLS_ENABLED
Rework the canvas_item API for further improves to the canvas item editor
2017-11-15 22:03:25 +00:00
virtual Dictionary _edit_get_state() const;
virtual void _edit_set_state(const Dictionary &p_state);
virtual void _edit_set_position(const Point2 &p_position);
virtual Point2 _edit_get_position() const;
Remove the selection rect for nodes that do not require it
2018-03-08 20:35:41 +00:00
virtual void _edit_set_scale(const Size2 &p_scale);
virtual Size2 _edit_get_scale() const;
Rework the canvas_item API for further improves to the canvas item editor
2017-11-15 22:03:25 +00:00
virtual void _edit_set_rect(const Rect2 &p_edit_rect);
virtual Rect2 _edit_get_rect() const;
virtual bool _edit_use_rect() const;
virtual void _edit_set_rotation(float p_rotation);
virtual float _edit_get_rotation() const;
virtual bool _edit_use_rotation() const;
virtual void _edit_set_pivot(const Point2 &p_pivot);
virtual Point2 _edit_get_pivot() const;
virtual bool _edit_use_pivot() const;
virtual Size2 _edit_get_minimum_size() const;
Don't compile editor-only function when tools=no
2019-10-21 21:37:07 +00:00
#endif
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
void accept_event();
virtual Size2 get_minimum_size() const;
virtual Size2 get_combined_minimum_size() const;
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
virtual bool has_point(const Point2 &p_point) const;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
virtual bool clips_input() const;
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
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);
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
void set_drag_preview(Control *p_control);
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
void force_drag(const Variant &p_data, Control *p_control);
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
void set_custom_minimum_size(const Size2 &p_custom);
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Size2 get_custom_minimum_size() const;
FileDialog: keyboard shortcut to toggle "show hidden files"
2015-12-28 23:36:48 +00:00
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Control *get_parent_control() const;
/* POSITIONING */
remove trailing whitespace
2016-03-08 23:00:52 +00:00
Improve the anchors and margin workflow
2019-03-31 16:53:24 +00:00
void set_anchors_preset(LayoutPreset p_preset, bool p_keep_margins = true);
Implements set_margins_preset(...)
2017-09-19 20:39:19 +00:00
void set_margins_preset(LayoutPreset p_preset, LayoutPresetMode p_resize_mode = PRESET_MODE_MINSIZE, int p_margin = 0);
void set_anchors_and_margins_preset(LayoutPreset p_preset, LayoutPresetMode p_resize_mode = PRESET_MODE_MINSIZE, int p_margin = 0);
remove trailing whitespace
2016-03-08 23:00:52 +00:00
Changes the keep_margin parameter to true by default, so that people are not suprised that set_anchor changes the margins values
2018-01-14 13:13:11 +00:00
void set_anchor(Margin p_margin, float p_anchor, bool p_keep_margin = true, bool p_push_opposite_anchor = true);
Replace GUI anchor type by a float between 0 and 1
2017-07-06 07:16:27 +00:00
float get_anchor(Margin p_margin) const;
remove trailing whitespace
2016-03-08 23:00:52 +00:00
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
void set_margin(Margin p_margin, float p_value);
Implements set_margins_preset(...)
2017-09-19 20:39:19 +00:00
float get_margin(Margin p_margin) const;
void set_anchor_and_margin(Margin p_margin, float p_anchor, float p_pos, bool p_push_opposite_anchor = true);
remove trailing whitespace
2016-03-08 23:00:52 +00:00
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
void set_begin(const Point2 &p_point); // helper
void set_end(const Point2 &p_point); // helper
remove trailing whitespace
2016-03-08 23:00:52 +00:00
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Point2 get_begin() const;
Point2 get_end() const;
remove trailing whitespace
2016-03-08 23:00:52 +00:00
Improve the anchors and margin workflow
2019-03-31 16:53:24 +00:00
void set_position(const Point2 &p_point, bool p_keep_margins = false);
void set_global_position(const Point2 &p_point, bool p_keep_margins = false);
Rename [gs]et_pos to [gs]et_position for Controls Control set_pos -> set_position Control set_global_pos -> set_global_position [gs]et_mouse_pos -> [gs]et_mouse_position [gs]et_global_mouse_pos -> [gs]et_global_mouse_position fixes #8005
2017-03-29 15:29:38 +00:00
Point2 get_position() const;
Point2 get_global_position() const;
Popups are now windows also (broken!)
2020-03-12 12:37:40 +00:00
Point2 get_screen_position() const;
Implements set_margins_preset(...)
2017-09-19 20:39:19 +00:00
Improve the anchors and margin workflow
2019-03-31 16:53:24 +00:00
void set_size(const Size2 &p_size, bool p_keep_margins = false);
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Size2 get_size() const;
Implements set_margins_preset(...)
2017-09-19 20:39:19 +00:00
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Rect2 get_rect() const;
Rect2 get_global_rect() const;
Popups are now windows also (broken!)
2020-03-12 12:37:40 +00:00
Rect2 get_screen_rect() const;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Rect2 get_window_rect() const; ///< use with care, as it blocks waiting for the visual server
Fixes the bad calculation of margin & anchors when child of Node2D
2018-05-05 14:59:00 +00:00
Rect2 get_anchorable_rect() const;
added rotation and scale support to gui controls
2015-12-12 16:54:26 +00:00
Rotation APIs: Better exposure for degrees methods Made public the various set/getters for rotations in degrees. For consistency, renamed the exposed method names to remove the leading underscore, and kept the old names with a deprecation warning. Fixes #4511.
2016-05-06 21:38:08 +00:00
void set_rotation(float p_radians);
Unify degree members and properties
2017-11-10 10:07:52 +00:00
void set_rotation_degrees(float p_degrees);
added rotation and scale support to gui controls
2015-12-12 16:54:26 +00:00
float get_rotation() const;
Unify degree members and properties
2017-11-10 10:07:52 +00:00
float get_rotation_degrees() const;
added rotation and scale support to gui controls
2015-12-12 16:54:26 +00:00
Implements set_margins_preset(...)
2017-09-19 20:39:19 +00:00
void set_h_grow_direction(GrowDirection p_direction);
GrowDirection get_h_grow_direction() const;
void set_v_grow_direction(GrowDirection p_direction);
GrowDirection get_v_grow_direction() const;
Ability to set rotation and scaling pivot for controls.
2017-07-06 20:42:44 +00:00
void set_pivot_offset(const Vector2 &p_pivot);
Vector2 get_pivot_offset() const;
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
void set_scale(const Vector2 &p_scale);
added rotation and scale support to gui controls
2015-12-12 16:54:26 +00:00
Vector2 get_scale() const;
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
void set_theme(const Ref<Theme> &p_theme);
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
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 */
remove trailing whitespace
2016-03-08 23:00:52 +00:00
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
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;
Add manual overrides for focus_next and focus_previous on controls similar to what can already be done with focus neighbours.
2017-11-16 09:45:52 +00:00
void set_focus_next(const NodePath &p_next);
NodePath get_focus_next() const;
void set_focus_previous(const NodePath &p_prev);
NodePath get_focus_previous() const;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Control *get_focus_owner() const;
-removed stop mouse and ignore mouse from control, which were confusing, replaced by mouse filter
2017-01-08 22:54:19 +00:00
void set_mouse_filter(MouseFilter p_filter);
MouseFilter get_mouse_filter() const;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
/* SKINNING */
remove trailing whitespace
2016-03-08 23:00:52 +00:00
Popups are now windows also (broken!)
2020-03-12 12:37:40 +00:00
void add_theme_icon_override(const StringName &p_name, const Ref<Texture2D> &p_icon);
void add_theme_shader_override(const StringName &p_name, const Ref<Shader> &p_shader);
void add_theme_style_override(const StringName &p_name, const Ref<StyleBox> &p_style);
void add_theme_font_override(const StringName &p_name, const Ref<Font> &p_font);
void add_theme_color_override(const StringName &p_name, const Color &p_color);
void add_theme_constant_override(const StringName &p_name, int p_constant);
Ref<Texture2D> get_theme_icon(const StringName &p_name, const StringName &p_type = StringName()) const;
Ref<Shader> get_theme_shader(const StringName &p_name, const StringName &p_type = StringName()) const;
Ref<StyleBox> get_theme_stylebox(const StringName &p_name, const StringName &p_type = StringName()) const;
Ref<Font> get_theme_font(const StringName &p_name, const StringName &p_type = StringName()) const;
Color get_theme_color(const StringName &p_name, const StringName &p_type = StringName()) const;
int get_theme_constant(const StringName &p_name, const StringName &p_type = StringName()) const;
bool has_theme_icon_override(const StringName &p_name) const;
bool has_theme_shader_override(const StringName &p_name) const;
bool has_theme_stylebox_override(const StringName &p_name) const;
bool has_theme_font_override(const StringName &p_name) const;
bool has_theme_color_override(const StringName &p_name) const;
bool has_theme_constant_override(const StringName &p_name) const;
bool has_theme_icon(const StringName &p_name, const StringName &p_type = StringName()) const;
bool has_theme_shader(const StringName &p_name, const StringName &p_type = StringName()) const;
bool has_theme_stylebox(const StringName &p_name, const StringName &p_type = StringName()) const;
bool has_theme_font(const StringName &p_name, const StringName &p_type = StringName()) const;
bool has_theme_color(const StringName &p_name, const StringName &p_type = StringName()) const;
bool has_theme_constant(const StringName &p_name, const StringName &p_type = StringName()) const;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
/* TOOLTIP */
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
void set_tooltip(const String &p_tooltip);
virtual String get_tooltip(const Point2 &p_pos) const;
-Fix tooltips in inspector, now they show as rich text.
2018-07-20 21:14:33 +00:00
virtual Control *make_custom_tooltip(const String &p_text) const;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
/* CURSOR */
void set_default_cursor_shape(CursorShape p_shape);
CursorShape get_default_cursor_shape() const;
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
virtual CursorShape get_cursor_shape(const Point2 &p_pos = Point2i()) const;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Type renames: Matrix32 -> Transform2D Matrix3 -> Basis AABB -> Rect3 RawArray -> PoolByteArray IntArray -> PoolIntArray FloatArray -> PoolFloatArray Vector2Array -> PoolVector2Array Vector3Array -> PoolVector3Array ColorArray -> PoolColorArray
2017-01-11 03:52:51 +00:00
virtual Transform2D get_transform() const;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
bool is_toplevel_control() const;
Size2 get_parent_area_size() const;
Fixes the bad calculation of margin & anchors when child of Node2D
2018-05-05 14:59:00 +00:00
Rect2 get_parent_anchorable_rect() const;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
void grab_click_focus();
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
void warp_mouse(const Point2 &p_to_pos);
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
added rotation and scale support to gui controls
2015-12-12 16:54:26 +00:00
virtual bool is_text_field() const;
misc cleanup
2015-10-17 13:29:54 +00:00
-Some fixes to drag and drop and canvas offset for GUI that were introduced after rewrite
2016-01-19 23:27:27 +00:00
Control *get_root_parent_control() const;
-All types have editable script now in properties -Changed clip to a property in Control which can be set by the user
2017-01-09 18:50:08 +00:00
void set_clip_contents(bool p_clip);
bool is_clipping_contents();
More visual script work -Block switches to 2d/3d editor if editing visual script -Added cast node in flow control -Added ability to do RPC in visual script -Comment nodes -Fix bug with inverted cable in connecting backwards -Copy and paste nodes, including from different scripts
2016-08-25 20:45:20 +00:00
void set_block_minimum_size_adjust(bool p_block);
bool is_minimum_size_adjust_blocked() const;
More visual script improvements -Added anti-aliasing on lines -Improved draw performance enormously -Removed sequence ports for most nodes, current visual scripts will likely be broken now. Sorry!
2016-08-31 02:44:14 +00:00
void set_disable_visibility_clip(bool p_ignore);
bool is_visibility_clip_disabled() const;
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
virtual void get_argument_options(const StringName &p_function, int p_idx, List<String> *r_options) const;
Add a configuration warning when using Ignore mouse filter with tooltip This closes #30144.
2019-06-28 16:38:57 +00:00
virtual String get_configuration_warning() const;
Add argument options for the theme override functions in Control
2016-09-11 14:48:31 +00:00
remove trailing whitespace
2016-03-08 23:00:52 +00:00
Control();
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
~Control();
};
VARIANT_ENUM_CAST(Control::FocusMode);
VARIANT_ENUM_CAST(Control::SizeFlags);
VARIANT_ENUM_CAST(Control::CursorShape);
Adds a function to set Anchors with a layout preset
2017-08-11 16:16:28 +00:00
VARIANT_ENUM_CAST(Control::LayoutPreset);
Implements set_margins_preset(...)
2017-09-19 20:39:19 +00:00
VARIANT_ENUM_CAST(Control::LayoutPresetMode);
-removed stop mouse and ignore mouse from control, which were confusing, replaced by mouse filter
2017-01-08 22:54:19 +00:00
VARIANT_ENUM_CAST(Control::MouseFilter);
-Ability for controls to grow the left/top when anchored. This makes anchoring controls to the right/bottom easier when they are resized.
2017-07-06 16:26:39 +00:00
VARIANT_ENUM_CAST(Control::GrowDirection);
Changed anchor constants to enum, removed ANCHOR_CENTER, fixes #9889
2017-08-15 22:48:38 +00:00
VARIANT_ENUM_CAST(Control::Anchor);
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
#endif