A frame with scrollable content. More...
#include <gui_scroll_frame.hpp>
Public Types | |
| using | base = frame |
| using | child_list = std::list< utils::owner_ptr< frame > > |
| Type of the frame child list (internal). More... | |
| using | child_list_view = utils::view::adaptor< child_list, utils::view::smart_ptr_dereferencer, utils::view::non_null_filter > |
| using | const_child_list_view = utils::view::adaptor< const child_list, utils::view::smart_ptr_dereferencer, utils::view::non_null_filter > |
| using | region_list = std::list< utils::owner_ptr< layered_region > > |
| Type of the region list (internal). More... | |
| using | region_list_view = utils::view::adaptor< region_list, utils::view::smart_ptr_dereferencer, utils::view::non_null_filter > |
| using | const_region_list_view = utils::view::adaptor< const region_list, utils::view::smart_ptr_dereferencer, utils::view::non_null_filter > |
Public Member Functions | |
| scroll_frame (utils::control_block &block, manager &mgr, const frame_core_attributes &attr) | |
| Constructor. More... | |
| ~scroll_frame () override | |
| Destructor. More... | |
| void | copy_from (const region &obj) override |
| Copies a region's parameters into this scroll_frame (inheritance). More... | |
| bool | can_use_script (const std::string &script_name) const override |
| Returns 'true' if this scroll_frame can use a script. More... | |
| void | fire_script (const std::string &script_name, const event_data &data=event_data{}) override |
| Calls a script. More... | |
| void | set_scroll_child (utils::owner_ptr< frame > obj) |
| Sets this scroll_frame's scroll child. More... | |
| const utils::observer_ptr< frame > & | get_scroll_child () |
| Returns this scroll_frame's scroll child. More... | |
| utils::observer_ptr< const frame > | get_scroll_child () const |
| Returns this scroll_frame's scroll child. More... | |
| void | set_horizontal_scroll (float horizontal_scroll) |
| Sets the horizontal offset of the scroll child. More... | |
| float | get_horizontal_scroll () const |
| Returns the horizontal offset of the scroll child. More... | |
| float | get_horizontal_scroll_range () const |
| Returns the maximum horizontal offset of the scroll child. More... | |
| void | set_vertical_scroll (float vertical_scroll) |
| Sets the vertical offset of the scroll child. More... | |
| float | get_vertical_scroll () const |
| Returns the vertical offset of the scroll child. More... | |
| float | get_vertical_scroll_range () const |
| Returns the maximum vertical offset of the scroll child. More... | |
| utils::observer_ptr< const frame > | find_topmost_frame (const std::function< bool(const frame &)> &predicate) const override |
| Find the topmost frame matching the provided predicate. More... | |
| void | notify_strata_needs_redraw (strata strata_id) override |
| Tells this renderer that one of its region requires redraw. More... | |
| vector2f | get_target_dimensions () const override |
| Returns the width and height of of this renderer's main render target (e.g., screen). More... | |
| void | notify_scaling_factor_updated () override |
| Tells this region that the global interface scaling factor has changed. More... | |
| void | render () const override |
| Renders this region on the current render target. More... | |
| void | update (float delta) final |
| Updates this region's logic. More... | |
| std::string | serialize (const std::string &tab) const override |
| Prints all relevant information about this region in a string. More... | |
| void | create_title_region () |
| Creates a new title region for this frame. More... | |
| void | set_draw_layer_enabled (layer layer_id, bool enable) |
| Enables or disables a layer. More... | |
| void | disable_draw_layer (layer layer_id) |
| Disables a layer. More... | |
| void | enable_draw_layer (layer layer_id) |
| Enables a layer. More... | |
| void | set_mouse_enabled (bool is_mouse_enabled) |
| Sets if this frame can receive mouse input (click & move). More... | |
| void | enable_mouse () |
| Marks this frame as able to receive mouse input (click & move). More... | |
| void | disable_mouse () |
| Marks this frame as unable to receive mouse input (click & move). More... | |
| void | set_mouse_click_enabled (bool is_mouse_enabled) |
| Sets if this frame can receive mouse click input. More... | |
| void | enable_mouse_click () |
| Marks this frame as able to receive mouse click input. More... | |
| void | disable_mouse_click () |
| Marks this frame as unable to receive mouse click input. More... | |
| void | set_mouse_move_enabled (bool is_mouse_enabled) |
| Sets if this frame can receive mouse move input. More... | |
| void | enable_mouse_move () |
| Marks this frame as able to receive mouse move input. More... | |
| void | disable_mouse_move () |
| Marks this frame as unable to receive mouse move input. More... | |
| void | set_mouse_wheel_enabled (bool is_mouse_wheel_enabled) |
| Sets if this frame can receive mouse wheel input. More... | |
| void | enable_mouse_wheel () |
| Marks this frame as able to receive mouse wheel input. More... | |
| void | disable_mouse_wheel () |
| Marks this frame as unable to receive mouse wheel input. More... | |
| void | set_keyboard_enabled (bool is_keyboard_enabled) |
| Sets if this frame can receive any keyboard input. More... | |
| void | enable_keyboard () |
| Marks this frame as able to receive any keyboard input. More... | |
| void | disable_keyboard () |
| Marks this frame as unable to receive any keyboard input. More... | |
| void | set_key_capture_enabled (const std::string &key_name, bool enable) |
| Marks this frame as able to receive keyboard input from a specific key. More... | |
| void | set_key_capture_enabled (input::key key_id, bool enable) |
| Marks this frame as able to receive keyboard input from a specific key. More... | |
| void | enable_key_capture (const std::string &key_name) |
| Marks this frame as able to receive keyboard input from a specific key. More... | |
| void | enable_key_capture (input::key key_id) |
| Marks this frame as able to receive keyboard input from a specific key. More... | |
| void | disable_key_capture (const std::string &key_name) |
| Marks this frame as unable to receive keyboard input from a specific key. More... | |
| void | disable_key_capture (input::key key_id) |
| Marks this frame as unable to receive keyboard input from a specific key. More... | |
| void | disable_key_capture () |
| Marks this frame as unable to receive keyboard input from any key. More... | |
| bool | has_script (const std::string &script_name) const |
| Checks if this frame has a script defined. More... | |
| utils::observer_ptr< layered_region > | add_region (utils::owner_ptr< layered_region > reg) |
| Adds a layered_region to this frame's children. More... | |
| template<typename RegionType , typename Enable = typename std::enable_if<std::is_base_of<gui::layered_region, RegionType>::value>::type> | |
| utils::observer_ptr< RegionType > | add_region (utils::owner_ptr< RegionType > reg) |
| Adds a layered_region to this frame's children. More... | |
| utils::owner_ptr< layered_region > | remove_region (const utils::observer_ptr< layered_region > ®) |
| Removes a layered_region from this frame's children. More... | |
| utils::observer_ptr< layered_region > | create_layered_region (layer layer_id, region_core_attributes attr) |
| Creates a new region as child of this frame. More... | |
| template<typename RegionType , typename Enable = typename std::enable_if<std::is_base_of<gui::layered_region, RegionType>::value>::type> | |
| utils::observer_ptr< RegionType > | create_layered_region (layer layer_id, region_core_attributes attr) |
| Creates a new region as child of this frame. More... | |
| template<typename RegionType , typename Enable = typename std::enable_if<std::is_base_of<gui::layered_region, RegionType>::value>::type> | |
| utils::observer_ptr< RegionType > | create_layered_region (layer layer_id, const std::string &name) |
| Creates a new region as child of this frame. More... | |
| utils::observer_ptr< frame > | create_child (frame_core_attributes attr) |
| Creates a new frame as child of this frame. More... | |
| template<typename FrameType , typename Enable = typename std::enable_if<std::is_base_of<gui::frame, FrameType>::value>::type> | |
| utils::observer_ptr< FrameType > | create_child (frame_core_attributes attr) |
| Creates a new frame as child of this frame. More... | |
| template<typename FrameType , typename Enable = typename std::enable_if<std::is_base_of<gui::frame, FrameType>::value>::type> | |
| utils::observer_ptr< FrameType > | create_child (const std::string &name) |
| Creates a new frame as child of this frame. More... | |
| utils::observer_ptr< frame > | add_child (utils::owner_ptr< frame > child) |
| Adds a frame to this frame's children. More... | |
| template<typename FrameType , typename Enable = typename std::enable_if<std::is_base_of<gui::frame, FrameType>::value>::type> | |
| utils::observer_ptr< FrameType > | add_child (utils::owner_ptr< FrameType > child) |
| Adds a frame to this frame's children. More... | |
| utils::owner_ptr< frame > | remove_child (const utils::observer_ptr< frame > &child) |
| Removes a frame from this frame's children. More... | |
| child_list_view | get_children () |
| Returns the child list. More... | |
| const_child_list_view | get_children () const |
| Returns the child list. More... | |
| utils::observer_ptr< const frame > | get_child (const std::string &name) const |
| Returns one of this frame's children. More... | |
| utils::observer_ptr< frame > | get_child (const std::string &name) |
| Returns one of this frame's children. More... | |
| template<typename FrameType , typename Enable = typename std::enable_if<std::is_base_of<gui::frame, FrameType>::value>::type> | |
| utils::observer_ptr< const FrameType > | get_child (const std::string &name) const |
| Returns one of this frame's children. More... | |
| template<typename FrameType , typename Enable = typename std::enable_if<std::is_base_of<gui::frame, FrameType>::value>::type> | |
| utils::observer_ptr< FrameType > | get_child (const std::string &name) |
| Returns one of this frame's children. More... | |
| region_list_view | get_regions () |
| Returns the region list. More... | |
| const_region_list_view | get_regions () const |
| Returns the region list. More... | |
| utils::observer_ptr< const layered_region > | get_region (const std::string &name) const |
| Returns one of this frame's region. More... | |
| utils::observer_ptr< layered_region > | get_region (const std::string &name) |
| Returns one of this frame's region. More... | |
| template<typename RegionType , typename Enable = typename std::enable_if<std::is_base_of<gui::layered_region, RegionType>::value>::type> | |
| utils::observer_ptr< RegionType > | get_region (const std::string &name) |
| Returns one of this frame's region. More... | |
| float | get_effective_scale () const |
| Calculates effective scale. More... | |
| int | get_level () const |
| Returns this frame's level. More... | |
| std::optional< strata > | get_strata () const |
| Returns this frame's strata. More... | |
| strata | get_effective_strata () const |
| Returns this frame's effective strata. More... | |
| utils::observer_ptr< const frame > | get_top_level_parent () const |
| Returns this frame's top-level parent. More... | |
| utils::observer_ptr< frame > | get_top_level_parent () |
| Returns this frame's top-level parent. More... | |
| const backdrop * | get_backdrop () const |
| Returns this frame's backdrop. More... | |
| backdrop * | get_backdrop () |
| Returns this frame's backdrop. More... | |
| backdrop & | get_or_create_backdrop () |
| Returns this frame's backdrop, creating it if needed. More... | |
| const bounds2f & | get_abs_hit_rect_insets () const |
| Returns this frame's absolute hit rect insets. More... | |
| const bounds2f & | get_rel_hit_rect_insets () const |
| Returns this frame's relative hit rect insets. More... | |
| vector2f | get_max_dimensions () const |
| Returns this frame's max dimensions. More... | |
| vector2f | get_min_dimensions () const |
| Returns this frame's min dimensions. More... | |
| std::size_t | get_child_count () const |
| Returns the number of children of this frame. More... | |
| std::size_t | get_child_count_upper_bound () const |
| Returns the approximate number of children of this frame. More... | |
| std::size_t | get_layered_region_count () const |
| Returns the number of layered regions of this frame. More... | |
| std::size_t | get_layered_region_count_upper_bound () const |
| Returns the approximate number of regions of this frame. More... | |
| float | get_scale () const |
| Returns this frame's scale. More... | |
| utils::observer_ptr< const region > | get_title_region () const |
| Returns this frame's title region. More... | |
| utils::observer_ptr< region > | get_title_region () |
| Returns this frame's title region. More... | |
| bool | is_clamped_to_screen () const |
| Checks if this frame is clamped to screen. More... | |
| bool | is_in_region (const vector2f &position) const override |
| Checks if the provided coordinates are inside this frame. More... | |
| utils::observer_ptr< frame > | find_topmost_frame (const std::function< bool(const frame &)> &predicate) |
| Find the topmost frame matching the provided predicate. More... | |
| bool | is_mouse_move_enabled () const |
| Checks if this frame can receive mouse movement input. More... | |
| bool | is_mouse_click_enabled () const |
| Checks if this frame can receive mouse click input. More... | |
| bool | is_mouse_wheel_enabled () const |
| Checks if this frame can receive mouse wheel input. More... | |
| bool | is_drag_enabled (const std::string &button_name) const |
| Checks if this frame is registered for drag events with the provided mouse button. More... | |
| bool | is_key_capture_enabled (const std::string &key_name) const |
| Checks if this frame can receive keyboard input from a specific key. More... | |
| bool | is_keyboard_enabled () const |
| Checks if this frame can receive any keyboard input. More... | |
| bool | is_movable () const |
| Checks if this frame can be moved. More... | |
| bool | is_resizable () const |
| Checks if this frame can be resized. More... | |
| bool | is_top_level () const |
| Checks if this frame is at top level. More... | |
| bool | is_user_placed () const |
| Checks if this frame has been moved by the user. More... | |
| utils::connection | add_script (const std::string &script_name, std::string content, script_info info=script_info{}) |
| Adds an additional handler script to this frame (executed after existing scripts). More... | |
| utils::connection | add_script (const std::string &script_name, sol::protected_function handler, script_info info=script_info{}) |
| Adds an additional handler script to this frame (executed after existing scripts). More... | |
| utils::connection | add_script (const std::string &script_name, script_function handler, script_info info=script_info{}) |
| Adds an additional handler script to this frame (executed after existing scripts). More... | |
| template<typename DerivedType = void, typename Function > | |
| utils::connection | add_script (const std::string &script_name, Function &&handler, script_info info=script_info{}) |
| Adds an additional handler script to this frame (executed after existing scripts). More... | |
| utils::connection | set_script (const std::string &script_name, std::string content, script_info info=script_info{}) |
| Sets a new handler script for this frame (replacing existing scripts). More... | |
| utils::connection | set_script (const std::string &script_name, sol::protected_function handler, script_info info=script_info{}) |
| Sets a new handler script for this frame (replacing existing scripts). More... | |
| utils::connection | set_script (const std::string &script_name, script_function handler, script_info info=script_info{}) |
| Sets a new handler script for this frame (replacing existing scripts). More... | |
| template<typename DerivedType = void, typename Function > | |
| utils::connection | set_script (const std::string &script_name, Function &&handler, script_info info=script_info{}) |
| Sets a new handler script for this frame (replacing existing scripts). More... | |
| script_list_view | get_script (const std::string &script_name) const |
| Return a view into this frame's handler scripts, registered for the given event. More... | |
| void | remove_script (const std::string &script_name) |
| Removes a script from this frame. More... | |
| void | set_update_rate (float rate) |
| Sets a maximum update rate (in updates per seconds). More... | |
| float | get_update_rate () const |
| Gets the maximum update rate (in upates per seconds). More... | |
| void | register_event (const std::string &event_name) |
| Tells this frame to react to a certain event. More... | |
| void | unregister_event (const std::string &event_name) |
| Tells the frame not to react to a certain event. More... | |
| void | set_drag_enabled (const std::string &button_name, bool enable) |
| Tells this frame whether to react to mouse drag or not. More... | |
| void | set_drag_enabled (input::mouse_button button_id, bool enable) |
| Tells this frame whether to react to mouse drag or not. More... | |
| void | enable_drag (const std::string &button_name) |
| Tells this frame to react to mouse drag. More... | |
| void | enable_drag (input::mouse_button button_id) |
| Tells this frame to react to mouse drag. More... | |
| void | disable_drag (const std::string &button_name) |
| Tells this frame to not react to mouse drag. More... | |
| void | disable_drag (input::mouse_button button_id) |
| Tells this frame to not react to mouse drag. More... | |
| void | disable_drag () |
| Tells this frame to not react to mouse drag from any mouse button. More... | |
| void | set_clamped_to_screen (bool is_clamped_to_screen) |
| Sets if this frame is clamped to screen. More... | |
| void | set_strata (std::optional< strata > strata_id) |
| Sets this frame's strata. More... | |
| void | set_backdrop (std::unique_ptr< backdrop > bdrop) |
| Sets this frames' backdrop. More... | |
| void | set_abs_hit_rect_insets (const bounds2f &insets) |
| Sets this frame's absolute hit rect insets. More... | |
| void | set_rel_hit_rect_insets (const bounds2f &insets) |
| Sets this frame's relative hit rect insets. More... | |
| void | set_level (int level_id) |
| Sets this frame's level. More... | |
| void | set_max_dimensions (const vector2f &max) |
| Sets this frame's maximum size. More... | |
| void | set_min_dimensions (const vector2f &min) |
| Sets this frame's minimum size. More... | |
| void | set_max_height (float max_height) |
| Sets this frame's maximum height. More... | |
| void | set_max_width (float max_width) |
| Sets this frame's maximum width. More... | |
| void | set_min_height (float min_height) |
| Sets this frame's minimum height. More... | |
| void | set_min_width (float min_width) |
| Sets this frame's minimum width. More... | |
| void | set_movable (bool is_movable) |
| Sets if this frame can be moved by the user. More... | |
| utils::owner_ptr< region > | release_from_parent () override |
| Removes this region from its parent and return an owning pointer. More... | |
| void | set_resizable (bool is_resizable) |
| Sets if this frame can be resized by the user. More... | |
| void | set_scale (float scale) |
| Sets this frame's scale. More... | |
| void | set_top_level (bool is_top_level) |
| Sets if this frame is at top level. More... | |
| void | raise () |
| Increases this frame's level so it's the highest of the strata. More... | |
| void | set_user_placed (bool is_user_placed) |
| Sets if this frame has been moved by the user. More... | |
| void | start_moving () |
| Starts moving this frame with the mouse. More... | |
| void | stop_moving () |
| ends moving this frame. More... | |
| void | start_sizing (const point &p) |
| Starts resizing this frame with the mouse. More... | |
| void | stop_sizing () |
| ends resizing this frame. More... | |
| void | enable_auto_focus (bool enable) |
| Enables automatic focus when this frame is shown or raised. More... | |
| bool | is_auto_focus_enabled () const |
| Checks if automatic focus is enabled. More... | |
| void | set_focus (bool focus) |
| Asks for focus for this frame. More... | |
| bool | has_focus () const |
| Check if this frame currently has focus. More... | |
| void | set_frame_renderer (utils::observer_ptr< frame_renderer > rdr) |
| Flags this object as rendered by another object. More... | |
| utils::observer_ptr< const frame_renderer > | get_frame_renderer () const |
| Returns the renderer of this object, nullptr if none. More... | |
| const utils::observer_ptr< frame_renderer > & | get_frame_renderer () |
| Returns the renderer of this object, nullptr if none. More... | |
| utils::observer_ptr< const frame_renderer > | get_effective_frame_renderer () const final |
| Returns the renderer of this object or its parents, nullptr if none. More... | |
| utils::observer_ptr< frame_renderer > | get_effective_frame_renderer () |
| Returns the renderer of this object or its parents, nullptr if none. More... | |
| void | notify_renderer_need_redraw () override |
| Notifies the renderer of this region that it needs to be redrawn. More... | |
| void | set_dimensions (const vector2f &dimensions) override |
| Changes this region's absolute dimensions (in pixels). More... | |
| void | set_width (float abs_width) override |
| Changes this region's absolute width (in pixels). More... | |
| void | set_height (float abs_height) override |
| Changes this region's absolute height (in pixels). More... | |
| virtual void | notify_mouse_in_frame (bool mouse_in_frame, const vector2f &mouse_pos) |
| Tells this frame it is being hovered by the mouse. More... | |
| void | notify_visible () override |
| Notifies this region that it is now visible on screen. More... | |
| void | notify_invisible () override |
| Notifies this region that it is no longer visible on screen. More... | |
| virtual void | notify_focus (bool focus) |
| Notifies this frame that it has received or lost focus. More... | |
| void | notify_loaded () override |
| Notifies this region that it has been fully loaded. More... | |
| void | notify_layers_need_update () |
| Tells this frame to rebuild its layer list. More... | |
| void | parse_layout (const layout_node &node) final |
| Parses data from a layout_node. More... | |
| virtual void | notify_borders_need_update () |
| Tells this region that its borders need updating. More... | |
| const std::string & | get_name () const |
| Returns this region's name. More... | |
| const std::string & | get_raw_name () const |
| Returns this region's raw name. More... | |
| utils::observer_ptr< const frame > | get_parent () const |
| Returns this region's parent. More... | |
| const utils::observer_ptr< frame > & | get_parent () |
| Returns this region's parent. More... | |
| void | destroy () |
| Forcefully removes this region from the GUI. More... | |
| void | set_alpha (float alpha) |
| Changes this region's alpha (opacity). More... | |
| float | get_alpha () const |
| Returns this region's alpha (opacity). More... | |
| float | get_effective_alpha () const |
| Returns this region's effective alpha (opacity). More... | |
| void | show () |
| shows this region. More... | |
| void | hide () |
| hides this region. More... | |
| void | set_shown (bool is_shown) |
| shows/hides this region. More... | |
| bool | is_shown () const |
| Checks if this region is shown. More... | |
| bool | is_visible () const |
| Checks if this region can be seen on the screen. More... | |
| bool | is_valid () const |
| Checks if this region has all its borders correctly defined. More... | |
| void | set_relative_dimensions (const vector2f &dimensions) |
| Changes this region's dimensions (relative to its parent). More... | |
| void | set_relative_width (float rel_width) |
| Changes this region's width (relative to its parent). More... | |
| void | set_relative_height (float rel_height) |
| Changes this region's height (relative to its parent). More... | |
| const vector2f & | get_dimensions () const |
| Returns this region's explicitly-defined width and height (in pixels). More... | |
| vector2f | get_apparent_dimensions () const |
| Returns this region's apparent width and height (in pixels). More... | |
| bool | is_apparent_width_defined () const |
| Checks if this region's apparent width is defined. More... | |
| bool | is_apparent_height_defined () const |
| Checks if this region's apparent height is defined. More... | |
| const std::string & | get_region_type () const |
| Returns the type of this region. More... | |
| bool | is_region_type (const std::string &type_name) const |
| Checks if this region is of the provided type. More... | |
| template<typename ObjectType > | |
| bool | is_region_type () const |
| Checks if this region is of the provided type. More... | |
| bool | is_region_type (const region &obj) const |
| Checks if this region is of a type equal or derived from the supplied region. More... | |
| float | get_bottom () const |
| Returns the vertical position of this region's bottom border. More... | |
| vector2f | get_center () const |
| Returns the position of this region's center. More... | |
| float | get_left () const |
| Returns the horizontal position of this region's left border. More... | |
| float | get_right () const |
| Returns the horizontal position of this region's right border. More... | |
| float | get_top () const |
| Returns the vertical position of this region's top border. More... | |
| const bounds2f & | get_borders () const |
| Returns this region's borders. More... | |
| void | clear_all_anchors () |
| Removes all anchors. More... | |
| void | set_all_anchors (const utils::observer_ptr< region > &obj) |
| Adjusts this regions anchors to fit the provided region. More... | |
| void | set_all_anchors (const std::string &obj_name) |
| Adjusts this regions anchors to fit the provided region. More... | |
| void | set_anchor (const anchor_data &a) |
| Adds/replaces an anchor. More... | |
| template<typename... Args> | |
| void | set_anchor (Args &&... args) |
| Adds/replaces an anchor. More... | |
| bool | depends_on (const region &obj) const |
| Checks if this region depends on another. More... | |
| std::size_t | get_anchor_count () const |
| Returns the number of defined anchors. More... | |
| anchor & | modify_anchor (point p) |
| Returns one of this region's anchor to modify it. More... | |
| const anchor & | get_anchor (point p) const |
| Returns one of this region's anchor. More... | |
| const std::array< std::optional< anchor >, 9 > & | get_anchors () const |
| Returns all of this region's anchors. More... | |
| float | round_to_pixel (float value, utils::rounding_method method=utils::rounding_method::nearest) const |
| Round an absolute position on screen to the nearest physical pixel. More... | |
| vector2f | round_to_pixel (const vector2f &position, utils::rounding_method method=utils::rounding_method::nearest) const |
| Round an absolute position on screen to the nearest physical pixel. More... | |
| void | add_anchored_object (region &obj) |
| Notifies this region that another one is anchored to it. More... | |
| void | remove_anchored_object (region &obj) |
| Notifies this region that another one is no longer anchored to it. More... | |
| bool | is_virtual () const |
| Checks if this region is virtual. More... | |
| void | set_manually_inherited (bool manually_inherited) |
| Flags this region as manually inherited or not. More... | |
| bool | is_manually_inherited () const |
| Checks if this object is manually inherited. More... | |
| const std::vector< utils::observer_ptr< region > > & | get_anchored_objects () const |
| Returns the list of all objects that are anchored to this one. More... | |
| bool | is_loaded () const |
| Checks if this region has been fully loaded. More... | |
| void | set_addon (const addon *a) |
| Sets the addon this frame belongs to. More... | |
| const addon * | get_addon () const |
| Returns this frame's addon. More... | |
| std::string | parse_file_name (const std::string &file_name) const |
| Convert an addon-relative file path to a application-relative path. More... | |
| manager & | get_manager () |
| Returns this region's manager. More... | |
| const manager & | get_manager () const |
| Returns this region's manager. More... | |
| registry & | get_registry () |
| Returns the UI object registry, which keeps track of all objects in the UI. More... | |
| const registry & | get_registry () const |
| Returns the UI object registry, which keeps track of all objects in the UI. More... | |
| void | remove_glue () |
| Removes the Lua glue. More... | |
| virtual void | notify_rendered_frame (const utils::observer_ptr< frame > &obj, bool rendered) |
| Tells this renderer that it should (or not) render another frame. More... | |
| virtual void | notify_strata_changed (const utils::observer_ptr< frame > &obj, strata old_strata_id, strata new_strata_id) |
| Tells this renderer that a frame has changed strata. More... | |
| virtual void | notify_level_changed (const utils::observer_ptr< frame > &obj, int old_level, int new_level) |
| Tells this renderer that a frame has changed level. More... | |
| utils::observer_ptr< frame > | find_topmost_frame (const std::function< bool(const frame &)> &predicate) |
| Find the top-most frame matching the provided predicate. More... | |
| int | get_highest_level (strata strata_id) const |
| Returns the highest level on the provided strata. More... | |
Static Public Member Functions | |
| static void | register_on_lua (sol::state &lua) |
| Registers this region class to the provided Lua state. More... | |
| static std::string | get_adjusted_script_name (const std::string &script_name) |
| Returns the "adjusted" script name: "OnEvent" becomes "on_event". More... | |
Static Public Attributes | |
| static constexpr const char * | class_name = "ScrollFrame" |
Protected Types | |
| using | frame_list_type = utils::sorted_vector< frame *, frame_comparator > |
| using | frame_list_iterator = frame_list_type::iterator |
Protected Member Functions | |
| void | parse_all_nodes_before_children_ (const layout_node &node) override |
| virtual void | parse_scroll_child_node_ (const layout_node &node) |
| void | update_ (float delta) override |
| const std::vector< std::string > & | get_type_list_ () const override |
| void | update_scroll_range_ () |
| void | rebuild_scroll_render_target_ () |
| void | render_scroll_strata_list_ () |
| void | parse_attributes_ (const layout_node &node) override |
| virtual void | parse_resize_bounds_node_ (const layout_node &node) |
| virtual void | parse_title_region_node_ (const layout_node &node) |
| virtual void | parse_backdrop_node_ (const layout_node &node) |
| virtual void | parse_hit_rect_insets_node_ (const layout_node &node) |
| virtual void | parse_layers_node_ (const layout_node &node) |
| virtual void | parse_frames_node_ (const layout_node &node) |
| virtual void | parse_scripts_node_ (const layout_node &node) |
| utils::observer_ptr< layered_region > | parse_region_ (const layout_node &node, const std::string &layer_name, const std::string &type) |
| utils::observer_ptr< frame > | parse_child_ (const layout_node &node, const std::string &type) |
| void | check_position_ () |
| void | add_level_ (int amount) |
| utils::observer_ptr< const frame_renderer > | compute_top_level_frame_renderer_ () const |
| utils::observer_ptr< frame_renderer > | compute_top_level_frame_renderer_ () |
| strata | compute_effective_strata_ () const |
| void | notify_strata_changed_ (strata new_strata_id) |
| void | notify_frame_renderer_changed_ (const utils::observer_ptr< frame_renderer > &new_renderer) |
| void | update_borders_ () override |
| void | set_parent_ (utils::observer_ptr< frame > parent) override |
| Changes this region's parent. More... | |
| bool | check_script_ (const std::string &script_name) const |
| utils::connection | define_script_ (const std::string &script_name, const std::string &content, bool append, const script_info &info) |
| utils::connection | define_script_ (const std::string &script_name, sol::protected_function handler, bool append, const script_info &info) |
| utils::connection | define_script_ (const std::string &script_name, script_function handler, bool append, const script_info &info) |
| void | on_event_ (std::string_view event_name, const event_data &event) |
| virtual void | parse_size_node_ (const layout_node &node) |
| virtual void | parse_anchor_node_ (const layout_node &node) |
| color | parse_color_node_ (const layout_node &node) |
| vector2< std::optional< float > > | parse_offset_node_ (const layout_node &node) |
| vector2< float > | parse_offset_node_or_ (const layout_node &node, float fallback) |
| std::pair< anchor_type, vector2< std::optional< float > > > | parse_dimension_node_ (const layout_node &node) |
| void | read_anchors_ (float &left, float &right, float &top, float &bottom, float &x_center, float &y_center) const |
| bool | make_borders_ (float &min, float &max, float center, float size) const |
| sol::state & | get_lua_ () |
| const sol::state & | get_lua_ () const |
| template<typename T > | |
| void | create_glue_ (T &self) |
| void | set_lua_member_ (std::string key, sol::stack_object value) |
| sol::object | get_lua_member_ (const std::string &key) const |
| void | set_virtual_ () |
| Makes this region virtual. More... | |
| void | set_name_ (const std::string &name) |
| Sets this region's name. More... | |
| template<typename T > | |
| void | initialize_ (T &self, const region_core_attributes &attr) |
| Set up function to call in all derived class constructors. More... | |
| void | clear_strata_list_ () |
| bool | has_strata_list_changed_ () const |
| void | reset_strata_list_changed_flag_ () |
| void | render_strata_ (const strata_data &strata_obj) const |
| std::pair< std::size_t, std::size_t > | get_strata_range_ (strata strata_id) const |
Static Protected Member Functions | |
| template<typename T > | |
| static const std::vector< std::string > & | get_type_list_impl_ () |
Static Protected Attributes | |
| static constexpr std::size_t | num_layers = magic_enum::enum_count<layer>() |
| static constexpr std::size_t | num_strata = magic_enum::enum_count<strata>() |
Detailed Description
A frame with scrollable content.
This frame has a special child frame, the "scroll child". The scroll child is rendered on a separate render target, which is then rendered on the screen. This allows clipping the content of the scroll child and only display a portion of it (as if scrolling on a page). The displayed portion is controlled by the scroll value, which can be changed in both the vertical and horizontal directions.
By default, the mouse wheel movement will not trigger any scrolling; this has to be explicitly implemented using the OnMouseWheel callback and the scroll_frame::set_horizontal_scroll function.
Events. Hard-coded events available to all scroll frames, in addition to those from frame:
OnHorizontalScroll: Triggered by scroll_frame::set_horizontal_scroll.OnScrollRangeChanged: Triggered whenever the range of the scroll value changes. This happens either when the size of the scrollable content changes, or when the size of the scroll frame changes.OnVerticalScroll: Triggered by scroll_frame::set_vertical_scroll.
Definition at line 35 of file gui_scroll_frame.hpp.
Member Typedef Documentation
◆ base
| using lxgui::gui::scroll_frame::base = frame |
Definition at line 37 of file gui_scroll_frame.hpp.
◆ child_list
|
inherited |
Type of the frame child list (internal).
- Note
- Constraints on the choice container type:
- must not invalidate iterators on back insertion
- must allow forward iteration
- iterators can be invalidated on removal
- most common use is iteration, not addition or removal
- ordering of elements is irrelevant
Definition at line 268 of file gui_frame.hpp.
◆ child_list_view
|
inherited |
Definition at line 269 of file gui_frame.hpp.
◆ const_child_list_view
|
inherited |
Definition at line 271 of file gui_frame.hpp.
◆ const_region_list_view
|
inherited |
Definition at line 288 of file gui_frame.hpp.
◆ frame_list_iterator
|
protectedinherited |
Definition at line 106 of file gui_frame_renderer.hpp.
◆ frame_list_type
|
protectedinherited |
Definition at line 105 of file gui_frame_renderer.hpp.
◆ region_list
|
inherited |
Type of the region list (internal).
- Note
- Constraints on the choice container type:
- must not invalidate iterators on back insertion
- must allow forward iteration
- iterators can be invalidated on removal
- most common use is iteration, not addition or removal
- ordering of elements is irrelevant
Definition at line 285 of file gui_frame.hpp.
◆ region_list_view
|
inherited |
Definition at line 286 of file gui_frame.hpp.
Constructor & Destructor Documentation
◆ scroll_frame()
|
explicit |
Constructor.
Definition at line 14 of file gui_scroll_frame.cpp.
◆ ~scroll_frame()
|
override |
Destructor.
Definition at line 21 of file gui_scroll_frame.cpp.
Member Function Documentation
◆ add_anchored_object()
|
inherited |
Notifies this region that another one is anchored to it.
- Parameters
-
obj The anchored region
- Note
- Anchored objects get their borders automatically updated whenever this object's borders are updated.
Definition at line 561 of file gui_region.cpp.
◆ add_child() [1/2]
|
inherited |
Adds a frame to this frame's children.
- Parameters
-
child The frame to add
Definition at line 678 of file gui_frame.cpp.
◆ add_child() [2/2]
|
inlineinherited |
Adds a frame to this frame's children.
- Parameters
-
child The frame to add
Definition at line 731 of file gui_frame.hpp.
◆ add_level_()
|
protectedinherited |
Definition at line 1342 of file gui_frame.cpp.
◆ add_region() [1/2]
|
inherited |
Adds a layered_region to this frame's children.
- Parameters
-
reg The layered_region to add
Definition at line 592 of file gui_frame.cpp.
◆ add_region() [2/2]
|
inlineinherited |
Adds a layered_region to this frame's children.
- Parameters
-
reg The layered_region to add
Definition at line 590 of file gui_frame.hpp.
◆ add_script() [1/4]
|
inlineinherited |
Adds an additional handler script to this frame (executed after existing scripts).
- Parameters
-
script_name The name of the script (e.g., "OnEvent") handler The handler of the script, as a C++ function (see below for expected signature) info The location where this script has been defined
- Returns
- A connection object, to disable the script if needed.
- Note
- This defines a C++ function to be called for the event specified in
script_name. This provides the best performance, but lacks direct access to the Lua environment. If this is required, prefer the other overload taking a Lua function instead. -
This overload enables taking handler scripts with a
selfparameter of type other than frame, for example:For maximum safety, by default this is done using autils::connection add_script(const std::string &script_name, std::string content, script_info info=script_info{})Adds an additional handler script to this frame (executed after existing scripts).Definition: gui_frame.hpp:1125dynamic_cast, so that incorrect types will be reported. However this has a cost; if you are sure of the type and want to bypass this cost, just supply theselftype as the first template argument to this function:add_script<button>([](button& self, const event_data& data) { ... });
Definition at line 1197 of file gui_frame.hpp.
◆ add_script() [2/4]
|
inlineinherited |
Adds an additional handler script to this frame (executed after existing scripts).
- Parameters
-
script_name The name of the script (e.g., "OnEvent") handler The handler of the script, as a C++ function of signature script_signature info The location where this script has been defined
- Returns
- A connection object, to disable the script if needed.
- Note
- This defines a C++ function to be called for the event specified in
script_name. This provides the best performance, but lacks direct access to the Lua environment. If this is required, prefer the other overload taking a Lua function instead.
Definition at line 1165 of file gui_frame.hpp.
◆ add_script() [3/4]
|
inlineinherited |
Adds an additional handler script to this frame (executed after existing scripts).
- Parameters
-
script_name The name of the script (e.g., "OnEvent") handler The handler of the script, as a Lua function info The location where this script has been defined
- Returns
- A connection object, to disable the script if needed.
- Note
- This defines a Lua function to be called for the event specified in script_name. This provides more flexibility compared to using C++ function, but also has a larger overhead. If performance is a concern, prefer the other overload taking a C++ function instead.
Definition at line 1144 of file gui_frame.hpp.
◆ add_script() [4/4]
|
inlineinherited |
Adds an additional handler script to this frame (executed after existing scripts).
- Parameters
-
script_name The name of the script (e.g., "OnEvent") content The content of the script, as Lua code info The location where this script has been defined
- Returns
- A connection object, to disable the script if needed.
- Note
- The script_info parameter is used only for displaying error messages. This function is meant to be used by the layout file parser. If you want to manually define your own script handlers, prefer the other overloads.
Definition at line 1125 of file gui_frame.hpp.
◆ can_use_script()
|
overridevirtual |
Returns 'true' if this scroll_frame can use a script.
- Parameters
-
script_name The name of the script
- Note
- This method can be overridden if needed.
Reimplemented from lxgui::gui::frame.
Definition at line 31 of file gui_scroll_frame.cpp.
◆ check_position_()
|
protectedinherited |
Definition at line 359 of file gui_frame.cpp.
◆ check_script_()
|
protectedinherited |
Definition at line 946 of file gui_frame.cpp.
◆ clear_all_anchors()
|
inherited |
Removes all anchors.
- Note
- This region and its children won't be visible until you define at least one anchor.
Definition at line 365 of file gui_region.cpp.
◆ clear_strata_list_()
|
protectedinherited |
Definition at line 183 of file gui_frame_renderer.cpp.
◆ compute_effective_strata_()
|
protectedinherited |
Definition at line 739 of file gui_frame.cpp.
◆ compute_top_level_frame_renderer_() [1/2]
|
inlineprotectedinherited |
Definition at line 1759 of file gui_frame.hpp.
◆ compute_top_level_frame_renderer_() [2/2]
|
protectedinherited |
Definition at line 1414 of file gui_frame.cpp.
◆ copy_from()
|
overridevirtual |
Copies a region's parameters into this scroll_frame (inheritance).
- Parameters
-
obj The region to copy
Reimplemented from lxgui::gui::frame.
Definition at line 54 of file gui_scroll_frame.cpp.
◆ create_child() [1/3]
|
inlineinherited |
Creates a new frame as child of this frame.
- Parameters
-
name The name of the frame
- Returns
- The created frame.
- Note
- You don't have the responsibility to delete this frame. It will be done automatically when its parent is deleted.
- This function takes care of the basic initializing: you can directly use the created frame. However, you still need to call notify_loaded() when you are done with any extra initialization you require on this frame. If you do not, the frame's OnLoad callback will not fire.
Definition at line 709 of file gui_frame.hpp.
◆ create_child() [2/3]
|
inherited |
Creates a new frame as child of this frame.
- Parameters
-
attr The core attributes of the frame (parent will be ignored)
- Returns
- The created frame.
- Note
- You don't have the responsibility to delete this frame. It will be done automatically when its parent is deleted.
- This function takes care of the basic initializing: you can directly use the created frame. However, you still need to call notify_loaded() when you are done with any extra initialization you require on this frame. If you do not, the frame's OnLoad callback will not fire.
Definition at line 666 of file gui_frame.cpp.
◆ create_child() [3/3]
|
inlineinherited |
Creates a new frame as child of this frame.
- Parameters
-
attr The core attributes of the frame (object_type and parent will be ignored)
- Returns
- The created frame.
- Note
- You don't have the responsibility to delete this frame. It will be done automatically when its parent is deleted.
- This function takes care of the basic initializing: you can directly use the created frame. However, you still need to call notify_loaded() when you are done with any extra initialization you require on this frame. If you do not, the frame's OnLoad callback will not fire.
Definition at line 688 of file gui_frame.hpp.
◆ create_glue_()
|
protectedinherited |
Definition at line 136 of file gui_region_tpl.hpp.
◆ create_layered_region() [1/3]
|
inlineinherited |
Creates a new region as child of this frame.
- Parameters
-
layer_id The layer on which to create the region name The name of the region
- Returns
- The created region.
- Note
- You don't have the responsibility to delete this region. It will be done automatically when its parent is deleted.
- This function takes care of the basic initializing: you can directly use the created region.
Definition at line 651 of file gui_frame.hpp.
◆ create_layered_region() [2/3]
|
inherited |
Creates a new region as child of this frame.
- Parameters
-
layer_id The layer on which to create the region attr The core attributes of the region (parent will be ignored)
- Returns
- The created region.
- Note
- You don't have the responsibility to delete this region. It will be done automatically when its parent is deleted.
- This function takes care of the basic initializing: you can directly use the created region.
Definition at line 652 of file gui_frame.cpp.
◆ create_layered_region() [3/3]
|
inlineinherited |
Creates a new region as child of this frame.
- Parameters
-
layer_id The layer on which to create the region attr The core attributes of the region (object_type and parent will be ignored)
- Returns
- The created region.
- Note
- You don't have the responsibility to delete this region. It will be done automatically when its parent is deleted.
- This function takes care of the basic initializing: you can directly use the created region.
Definition at line 630 of file gui_frame.hpp.
◆ create_title_region()
|
inherited |
Creates a new title region for this frame.
- Note
- You can get it by calling get_title_region().
Definition at line 275 of file gui_frame.cpp.
◆ define_script_() [1/3]
|
protectedinherited |
Definition at line 957 of file gui_frame.cpp.
◆ define_script_() [2/3]
|
protectedinherited |
Definition at line 1034 of file gui_frame.cpp.
◆ define_script_() [3/3]
|
protectedinherited |
Definition at line 992 of file gui_frame.cpp.
◆ depends_on()
|
inherited |
Checks if this region depends on another.
- Parameters
-
obj The region to test
- Note
- Useful to detect circular references.
Definition at line 503 of file gui_region.cpp.
◆ destroy()
|
inherited |
Forcefully removes this region from the GUI.
- Warning
- After calling this function, any pointer to the object is invalidated! Only call this function if you need the object to be destroyed early, before its parent (if any) would itself be destroyed.
Definition at line 333 of file gui_region.cpp.
◆ disable_drag() [1/3]
|
inherited |
Tells this frame to not react to mouse drag from any mouse button.
Definition at line 1170 of file gui_frame.cpp.
◆ disable_drag() [2/3]
|
inherited |
Tells this frame to not react to mouse drag.
- Parameters
-
button_name The mouse button to not react to
Definition at line 1162 of file gui_frame.cpp.
◆ disable_drag() [3/3]
|
inherited |
Tells this frame to not react to mouse drag.
- Parameters
-
button_id The mouse button to not react to
Definition at line 1166 of file gui_frame.cpp.
◆ disable_draw_layer()
|
inherited |
Disables a layer.
- Parameters
-
layer_id The id of the layer to disable
Definition at line 421 of file gui_frame.cpp.
◆ disable_key_capture() [1/3]
|
inherited |
Marks this frame as unable to receive keyboard input from any key.
Definition at line 474 of file gui_frame.cpp.
◆ disable_key_capture() [2/3]
|
inherited |
Marks this frame as unable to receive keyboard input from a specific key.
- Parameters
-
key_name The key for which to disable capture
Definition at line 466 of file gui_frame.cpp.
◆ disable_key_capture() [3/3]
|
inherited |
Marks this frame as unable to receive keyboard input from a specific key.
- Parameters
-
key_id The key for which to disable capture
- Note
- See disable_key_capture(const std::string&) for more information. This overload only allows capturing a single key; for key combinations, please use the overload taking a string.
Definition at line 470 of file gui_frame.cpp.
◆ disable_keyboard()
|
inlineinherited |
Marks this frame as unable to receive any keyboard input.
- See also
- set_keyboard_enabled()
Definition at line 475 of file gui_frame.hpp.
◆ disable_mouse()
|
inlineinherited |
Marks this frame as unable to receive mouse input (click & move).
- See also
- set_mouse_enabled()
Definition at line 380 of file gui_frame.hpp.
◆ disable_mouse_click()
|
inlineinherited |
Marks this frame as unable to receive mouse click input.
- See also
- set_mouse_click_enabled()
Definition at line 402 of file gui_frame.hpp.
◆ disable_mouse_move()
|
inlineinherited |
Marks this frame as unable to receive mouse move input.
- See also
- set_mouse_move_enabled()
Definition at line 424 of file gui_frame.hpp.
◆ disable_mouse_wheel()
|
inlineinherited |
Marks this frame as unable to receive mouse wheel input.
- See also
- set_mouse_wheel_enabled()
Definition at line 446 of file gui_frame.hpp.
◆ enable_auto_focus()
|
inherited |
Enables automatic focus when this frame is shown or raised.
- Parameters
-
enable 'true' to enable auto focus
Definition at line 1310 of file gui_frame.cpp.
◆ enable_drag() [1/2]
|
inherited |
Tells this frame to react to mouse drag.
- Parameters
-
button_name The mouse button to react to
Definition at line 1154 of file gui_frame.cpp.
◆ enable_drag() [2/2]
|
inherited |
Tells this frame to react to mouse drag.
- Parameters
-
button_id The mouse button to react to
Definition at line 1158 of file gui_frame.cpp.
◆ enable_draw_layer()
|
inherited |
Enables a layer.
- Parameters
-
layer_id The id of the layer to enable
Definition at line 429 of file gui_frame.cpp.
◆ enable_key_capture() [1/2]
|
inherited |
Marks this frame as able to receive keyboard input from a specific key.
- Parameters
-
key_name The key to capture
- Note
- If the frame captures the key, other frames below it will not be able to receive the input from this key. The format of the input key name is standard English, with modifiers for the "Control" (Ctrl), "Shift", and "Alt" keys. For example, "Ctrl-Shift-C" corresponds to the Ctrl, Shift, and C keys being pressed simultaneously. Keyboard input must be enabled for capture to take place.
Definition at line 458 of file gui_frame.cpp.
◆ enable_key_capture() [2/2]
|
inherited |
Marks this frame as able to receive keyboard input from a specific key.
- Parameters
-
key_id The key to capture
- Note
- See enable_key_capture(const std::string&) for more information. This overload only allows capturing a single key; for key combinations, please use the overload taking a string.
Definition at line 462 of file gui_frame.cpp.
◆ enable_keyboard()
|
inlineinherited |
Marks this frame as able to receive any keyboard input.
- See also
- set_keyboard_enabled()
Definition at line 467 of file gui_frame.hpp.
◆ enable_mouse()
|
inlineinherited |
Marks this frame as able to receive mouse input (click & move).
- See also
- set_mouse_enabled()
Definition at line 372 of file gui_frame.hpp.
◆ enable_mouse_click()
|
inlineinherited |
Marks this frame as able to receive mouse click input.
- See also
- set_mouse_click_enabled()
Definition at line 394 of file gui_frame.hpp.
◆ enable_mouse_move()
|
inlineinherited |
Marks this frame as able to receive mouse move input.
- See also
- set_mouse_move_enabled()
Definition at line 416 of file gui_frame.hpp.
◆ enable_mouse_wheel()
|
inlineinherited |
Marks this frame as able to receive mouse wheel input.
- See also
- set_mouse_wheel_enabled()
Definition at line 438 of file gui_frame.hpp.
◆ find_topmost_frame() [1/3]
|
inlineinherited |
Find the topmost frame matching the provided predicate.
- Parameters
-
predicate A function returning 'true' if the frame can be selected
- Returns
- The topmost frame, if any, and nullptr otherwise.
- Note
- For most frames, this can either return 'this' or 'nullptr'. For frames responsible for rendering other frames (such as scroll_frame), this can return other frames.
Definition at line 1034 of file gui_frame.hpp.
◆ find_topmost_frame() [2/3]
|
inlineinherited |
Find the top-most frame matching the provided predicate.
- Parameters
-
predicate A function returning 'true' if the frame can be selected
- Returns
- The topmost frame, or nullptr if none
Definition at line 82 of file gui_frame_renderer.hpp.
◆ find_topmost_frame() [3/3]
|
overridevirtual |
Find the topmost frame matching the provided predicate.
- Parameters
-
predicate A function returning 'true' if the frame can be selected
- Returns
- The topmost frame, if any, and nullptr otherwise.
- Note
- For most frames, this can either return 'this' or 'nullptr'. For frames responsible for rendering other frames (such as scroll_frame), this can return other frames.
- For scroll children to receive input, the scroll_frame must be keyboard/mouse/wheel enabled.
Reimplemented from lxgui::gui::frame.
Definition at line 271 of file gui_scroll_frame.cpp.
◆ fire_script()
|
overridevirtual |
Calls a script.
- Parameters
-
script_name The name of the script data Stores scripts arguments
- Note
- Triggered callbacks could destroy the frame. If you need to use the frame again after calling this function, use the helper class alive_checker.
Reimplemented from lxgui::gui::frame.
Definition at line 36 of file gui_scroll_frame.cpp.
◆ get_abs_hit_rect_insets()
|
inherited |
Returns this frame's absolute hit rect insets.
- Returns
- This frame's absolute hit rect insets
Definition at line 777 of file gui_frame.cpp.
◆ get_addon()
|
inherited |
Returns this frame's addon.
- Returns
- This frame's addon
- Note
- Returns "nullptr" if the frame has been created by Lua code and wasn't assigned a parent.
Definition at line 843 of file gui_region.cpp.
◆ get_adjusted_script_name()
|
staticinherited |
Returns the "adjusted" script name: "OnEvent" becomes "on_event".
- Parameters
-
script_name The CamelCase name of the script
- Returns
- the snake_case name of the script
Definition at line 879 of file gui_frame.cpp.
◆ get_alpha()
|
inherited |
Returns this region's alpha (opacity).
- Returns
- This region's alpha (opacity).
Definition at line 157 of file gui_region.cpp.
◆ get_anchor()
Returns one of this region's anchor.
- Parameters
-
p The anchor point
- Returns
- A pointer to the anchor, nullptr if none
Definition at line 539 of file gui_region.cpp.
◆ get_anchor_count()
|
inherited |
Returns the number of defined anchors.
- Returns
- The number of defined anchors
Definition at line 519 of file gui_region.cpp.
◆ get_anchored_objects()
|
inherited |
Returns the list of all objects that are anchored to this one.
- Returns
- The list of all objects that are anchored to this one
Definition at line 790 of file gui_region.cpp.
◆ get_anchors()
|
inherited |
Returns all of this region's anchors.
- Returns
- All of this region's anchors
Definition at line 549 of file gui_region.cpp.
◆ get_apparent_dimensions()
|
inherited |
Returns this region's apparent width and height (in pixels).
- Returns
- This region's apparent width and height (in pixels)
- Note
- If you need to get the actual size of a region on the screen, use this function instead of get_dimensions(), as some regions may not have their dimensions explicitly defined, and instead get their extents from anchors.
Definition at line 276 of file gui_region.cpp.
◆ get_backdrop() [1/2]
|
inherited |
Returns this frame's backdrop.
- Returns
- This frame's backdrop
Definition at line 766 of file gui_frame.cpp.
◆ get_backdrop() [2/2]
|
inherited |
Returns this frame's backdrop.
- Returns
- This frame's backdrop
Definition at line 762 of file gui_frame.cpp.
◆ get_borders()
|
inherited |
Returns this region's borders.
- Returns
- This region's borders
Definition at line 361 of file gui_region.cpp.
◆ get_bottom()
|
inherited |
Returns the vertical position of this region's bottom border.
- Returns
- The vertical position of this region's bottom border
Definition at line 357 of file gui_region.cpp.
◆ get_center()
|
inherited |
Returns the position of this region's center.
- Returns
- The position of this region's center
Definition at line 341 of file gui_region.cpp.
◆ get_child() [1/4]
|
inlineinherited |
Returns one of this frame's children.
- Parameters
-
name The name of the child
- Returns
- One of this frame's children
- Note
- The provided name can either be the full name or the relative name (i.e. without the "$parent" in front). This function first looks for matches on the full name, then if no child is found, on the relative name.
Definition at line 775 of file gui_frame.hpp.
◆ get_child() [2/4]
|
inlineinherited |
Returns one of this frame's children.
- Parameters
-
name The name of the child
- Returns
- One of this frame's children
- Note
- The provided name can either be the full name or the relative name (i.e. without the "$parent" in front). This function first looks for matches on the full name, then if no child is found, on the relative name.
Definition at line 809 of file gui_frame.hpp.
◆ get_child() [3/4]
|
inherited |
Returns one of this frame's children.
- Parameters
-
name The name of the child
- Returns
- One of this frame's children
- Note
- The provided name can either be the full name or the relative name (i.e. without the "$parent" in front). This function first looks for matches on the full name, then if no child is found, on the relative name.
Definition at line 305 of file gui_frame.cpp.
◆ get_child() [4/4]
|
inlineinherited |
Returns one of this frame's children.
- Parameters
-
name The name of the child
- Returns
- One of this frame's children
- Note
- The provided name can either be the full name or the relative name (i.e. without the "$parent" in front). This function first looks for matches on the full name, then if no child is found, on the relative name.
Definition at line 792 of file gui_frame.hpp.
◆ get_child_count()
|
inherited |
Returns the number of children of this frame.
- Returns
- The number of children of this frame
- Note
- If only an approximate number is acceptable, use get_child_count_upper_bound(), which is faster.
Definition at line 793 of file gui_frame.cpp.
◆ get_child_count_upper_bound()
|
inherited |
Returns the approximate number of children of this frame.
- Returns
- The approximate number of children of this frame
- Note
- The returned number is an upper bound on the actual number of children. This can be used to reserve enough space for memory allocations. If the exact number of children is required, use get_child_count().
Definition at line 798 of file gui_frame.cpp.
◆ get_children() [1/2]
|
inherited |
◆ get_children() [2/2]
|
inherited |
◆ get_dimensions()
|
inherited |
Returns this region's explicitly-defined width and height (in pixels).
- Returns
- This region's explicitly-defined width and height (in pixels)
- Note
- If you need to get the actual size of a region on the screen, use get_apparent_dimensions(), as some regions may not have their dimensions explicitly defined, and instead get their extents from anchors. If a dimension is not explicitly defined, it will be returned as zero.
Definition at line 272 of file gui_region.cpp.
◆ get_effective_alpha()
|
inherited |
Returns this region's effective alpha (opacity).
- Returns
- This region's effective alpha (opacity).
- Note
- This includes the region's parent alpha.
Definition at line 161 of file gui_region.cpp.
◆ get_effective_frame_renderer() [1/2]
|
inlineinherited |
Returns the renderer of this object or its parents, nullptr if none.
- Returns
- The renderer of this object or its parents, nullptr if none
- Note
- For more information, see set_frame_renderer().
Definition at line 1645 of file gui_frame.hpp.
◆ get_effective_frame_renderer() [2/2]
|
finalvirtualinherited |
Returns the renderer of this object or its parents, nullptr if none.
- Returns
- The renderer of this object or its parents, nullptr if none
- Note
- For more information, see set_frame_renderer().
Reimplemented from lxgui::gui::region.
Definition at line 1410 of file gui_frame.cpp.
◆ get_effective_scale()
|
inherited |
Calculates effective scale.
- Returns
- Effective scale (scale*parent->scale)
Definition at line 720 of file gui_frame.cpp.
◆ get_effective_strata()
|
inherited |
Returns this frame's effective strata.
- Returns
- This frame's strata, or its parent's effective strata if strata::parent.
Definition at line 735 of file gui_frame.cpp.
◆ get_frame_renderer() [1/2]
|
inlineinherited |
Returns the renderer of this object, nullptr if none.
- Returns
- The renderer of this object, nullptr if none
- Note
- For more information, see set_frame_renderer().
Definition at line 1629 of file gui_frame.hpp.
◆ get_frame_renderer() [2/2]
|
inlineinherited |
Returns the renderer of this object, nullptr if none.
- Returns
- The renderer of this object, nullptr if none
- Note
- For more information, see set_frame_renderer().
Definition at line 1620 of file gui_frame.hpp.
◆ get_highest_level()
|
inherited |
Returns the highest level on the provided strata.
- Parameters
-
strata_id The strata to inspect
- Returns
- The highest level on the provided strata
Definition at line 161 of file gui_frame_renderer.cpp.
◆ get_horizontal_scroll()
| float lxgui::gui::scroll_frame::get_horizontal_scroll | ( | ) | const |
Returns the horizontal offset of the scroll child.
- Returns
- The horizontal offset of the scroll child
Definition at line 141 of file gui_scroll_frame.cpp.
◆ get_horizontal_scroll_range()
| float lxgui::gui::scroll_frame::get_horizontal_scroll_range | ( | ) | const |
Returns the maximum horizontal offset of the scroll child.
- Returns
- The maximum horizontal offset of the scroll child
Definition at line 145 of file gui_scroll_frame.cpp.
◆ get_layered_region_count()
|
inherited |
Returns the number of layered regions of this frame.
- Returns
- The number of layered regions of this frame
- Note
- If only an approximate number is acceptable, use get_layered_region_count_upper_bound(), which is faster.
Definition at line 802 of file gui_frame.cpp.
◆ get_layered_region_count_upper_bound()
|
inherited |
Returns the approximate number of regions of this frame.
- Returns
- The approximate number of regions of this frame
- Note
- The returned number is an upper bound on the actual number of regions. This can be used to reserve enough space for memory allocations. If the exact number of regions is required, use get_layered_region_count().
Definition at line 807 of file gui_frame.cpp.
◆ get_left()
|
inherited |
Returns the horizontal position of this region's left border.
- Returns
- The horizontal position of this region's left border
Definition at line 345 of file gui_region.cpp.
◆ get_level()
|
inherited |
◆ get_lua_() [1/2]
|
protectedinherited |
Definition at line 767 of file gui_region.cpp.
◆ get_lua_() [2/2]
|
protectedinherited |
Definition at line 771 of file gui_region.cpp.
◆ get_lua_member_()
|
protectedinherited |
◆ get_manager() [1/2]
|
inlineinherited |
Returns this region's manager.
- Returns
- This region's manager
Definition at line 693 of file gui_region.hpp.
◆ get_manager() [2/2]
|
inlineinherited |
Returns this region's manager.
- Returns
- This region's manager
Definition at line 701 of file gui_region.hpp.
◆ get_max_dimensions()
|
inherited |
Returns this frame's max dimensions.
- Returns
- This frame's max dimensions
Definition at line 785 of file gui_frame.cpp.
◆ get_min_dimensions()
|
inherited |
Returns this frame's min dimensions.
- Returns
- This frame's min dimensions
Definition at line 789 of file gui_frame.cpp.
◆ get_name()
|
inherited |
Returns this region's name.
- Returns
- This region's name
Definition at line 140 of file gui_region.cpp.
◆ get_or_create_backdrop()
|
inherited |
Returns this frame's backdrop, creating it if needed.
- Returns
- This frame's backdrop
Definition at line 770 of file gui_frame.cpp.
◆ get_parent() [1/2]
|
inlineinherited |
Returns this region's parent.
- Returns
- This region's parent
Definition at line 237 of file gui_region.hpp.
◆ get_parent() [2/2]
|
inlineinherited |
Returns this region's parent.
- Returns
- This region's parent
Definition at line 229 of file gui_region.hpp.
◆ get_raw_name()
|
inherited |
Returns this region's raw name.
- Returns
- This region's raw name
- Note
- This is the name of the region before "$parent" has been replaced by its parent's name.
Definition at line 144 of file gui_region.cpp.
◆ get_region() [1/3]
|
inlineinherited |
Returns one of this frame's region.
- Parameters
-
name The name of the region
- Returns
- One of this frame's region
- Note
- The provided name can either be the full name or the relative name (i.e. without the "$parent" in front). This function first looks for matches on the full name, then if no region is found, on the relative name.
Definition at line 845 of file gui_frame.hpp.
◆ get_region() [2/3]
|
inlineinherited |
Returns one of this frame's region.
- Parameters
-
name The name of the region
- Returns
- One of this frame's region
- Note
- The provided name can either be the full name or the relative name (i.e. without the "$parent" in front). This function first looks for matches on the full name, then if no region is found, on the relative name.
Definition at line 863 of file gui_frame.hpp.
◆ get_region() [3/3]
|
inherited |
Returns one of this frame's region.
- Parameters
-
name The name of the region
- Returns
- One of this frame's region
- Note
- The provided name can either be the full name or the relative name (i.e. without the "$parent" in front). This function first looks for matches on the full name, then if no region is found, on the relative name.
Definition at line 329 of file gui_frame.cpp.
◆ get_region_type()
|
inherited |
Returns the type of this region.
- Returns
- The type of this region
Definition at line 148 of file gui_region.cpp.
◆ get_regions() [1/2]
|
inherited |
◆ get_regions() [2/2]
|
inherited |
◆ get_registry() [1/2]
|
inherited |
Returns the UI object registry, which keeps track of all objects in the UI.
- Returns
- The registry object
Definition at line 850 of file gui_region.cpp.
◆ get_registry() [2/2]
|
inherited |
Returns the UI object registry, which keeps track of all objects in the UI.
- Returns
- The registry object
Definition at line 855 of file gui_region.cpp.
◆ get_rel_hit_rect_insets()
|
inherited |
Returns this frame's relative hit rect insets.
- Returns
- This frame's relative hit rect insets
Definition at line 781 of file gui_frame.cpp.
◆ get_right()
|
inherited |
Returns the horizontal position of this region's right border.
- Returns
- The horizontal position of this region's right border
Definition at line 349 of file gui_region.cpp.
◆ get_scale()
|
inherited |
Returns this frame's scale.
- Returns
- This frame's scale
- Note
- If you want it's true scale on the screen, use get_effective_scale().
Definition at line 811 of file gui_frame.cpp.
◆ get_script()
|
inherited |
Return a view into this frame's handler scripts, registered for the given event.
- Parameters
-
script_name The name of the script (e.g., "OnEvent")
- Returns
- An iterable view into the frame's handlers.
Definition at line 1072 of file gui_frame.cpp.
◆ get_scroll_child() [1/2]
|
inline |
Returns this scroll_frame's scroll child.
- Returns
- This scroll_frame's scroll child
Definition at line 81 of file gui_scroll_frame.hpp.
◆ get_scroll_child() [2/2]
|
inline |
Returns this scroll_frame's scroll child.
- Returns
- This scroll_frame's scroll child
Definition at line 89 of file gui_scroll_frame.hpp.
◆ get_strata()
|
inherited |
Returns this frame's strata.
- Returns
- This frame's strata, or nullopt if the strata is inherited from the parent.
- Note
- See get_effective_strata() to obtain the actual strata of this frame.
Definition at line 731 of file gui_frame.cpp.
◆ get_strata_range_()
|
protectedinherited |
Definition at line 125 of file gui_frame_renderer.cpp.
◆ get_target_dimensions()
|
overridevirtual |
Returns the width and height of of this renderer's main render target (e.g., screen).
- Returns
- The render target dimensions
Implements lxgui::gui::frame_renderer.
Definition at line 287 of file gui_scroll_frame.cpp.
◆ get_title_region() [1/2]
|
inlineinherited |
Returns this frame's title region.
Definition at line 997 of file gui_frame.hpp.
◆ get_title_region() [2/2]
|
inlineinherited |
Returns this frame's title region.
Definition at line 992 of file gui_frame.hpp.
◆ get_top()
|
inherited |
Returns the vertical position of this region's top border.
- Returns
- The vertical position of this region's top border
Definition at line 353 of file gui_region.cpp.
◆ get_top_level_parent() [1/2]
|
inlineinherited |
Returns this frame's top-level parent.
- Returns
- This frame's top-level parent
Definition at line 902 of file gui_frame.hpp.
◆ get_top_level_parent() [2/2]
|
inherited |
Returns this frame's top-level parent.
- Returns
- This frame's top-level parent
Definition at line 750 of file gui_frame.cpp.
◆ get_type_list_()
|
overrideprotectedvirtual |
Reimplemented from lxgui::gui::frame.
Definition at line 291 of file gui_scroll_frame.cpp.
◆ get_type_list_impl_()
|
staticprotectedinherited |
Definition at line 147 of file gui_region_tpl.hpp.
◆ get_update_rate()
|
inherited |
Gets the maximum update rate (in upates per seconds).
- Returns
- The maximum update rate (in upates per seconds)
Definition at line 1150 of file gui_frame.cpp.
◆ get_vertical_scroll()
| float lxgui::gui::scroll_frame::get_vertical_scroll | ( | ) | const |
Returns the vertical offset of the scroll child.
- Returns
- The vertical offset of the scroll child
Definition at line 166 of file gui_scroll_frame.cpp.
◆ get_vertical_scroll_range()
| float lxgui::gui::scroll_frame::get_vertical_scroll_range | ( | ) | const |
Returns the maximum vertical offset of the scroll child.
- Returns
- The maximum vertical offset of the scroll child
Definition at line 170 of file gui_scroll_frame.cpp.
◆ has_focus()
|
inherited |
Check if this frame currently has focus.
- Returns
- 'true' if the frame has focus, 'false' otherwise
Definition at line 1326 of file gui_frame.cpp.
◆ has_script()
|
inherited |
Checks if this frame has a script defined.
- Parameters
-
script_name The name of the script to check
- Returns
- 'true' if this script is defined
Definition at line 584 of file gui_frame.cpp.
◆ has_strata_list_changed_()
|
protectedinherited |
Definition at line 188 of file gui_frame_renderer.cpp.
◆ hide()
|
inherited |
hides this region.
- Note
- All its children won't be visible on the screen anymore, even if they are still marked as shown.
Definition at line 186 of file gui_region.cpp.
◆ initialize_()
|
protectedinherited |
Set up function to call in all derived class constructors.
- Parameters
-
self A pointer to the derived thisattr The region attributes provided to the constructor
Definition at line 141 of file gui_region_tpl.hpp.
◆ is_apparent_height_defined()
|
inherited |
Checks if this region's apparent height is defined.
- Returns
- 'true' if defined, 'false' otherwise
- Note
- The apparent height is defined if either the region's absolute or relative height is explicitly specified (from set_height(), set_relative_height(), set_dimensions(), or set_relative_dimensions()), or if its left and right borders are anchored. A region with an undefined apparent height will not be rendered on the screen until its height is defined.
Definition at line 284 of file gui_region.cpp.
◆ is_apparent_width_defined()
|
inherited |
Checks if this region's apparent width is defined.
- Returns
- 'true' if defined, 'false' otherwise
- Note
- The apparent width is defined if either the region's absolute or relative width is explicitly specified (from set_width(), set_relative_width(), set_dimensions(), or set_relative_dimensions()), or if its left and right borders are anchored. A region with an undefined apparent width will not be rendered on the screen until its width is defined.
Definition at line 280 of file gui_region.cpp.
◆ is_auto_focus_enabled()
|
inherited |
Checks if automatic focus is enabled.
- Returns
- 'true' if automatic focus is enabled
Definition at line 1314 of file gui_frame.cpp.
◆ is_clamped_to_screen()
|
inherited |
Checks if this frame is clamped to screen.
- Returns
- 'true' if this frame is clamped to screen
Definition at line 815 of file gui_frame.cpp.
◆ is_drag_enabled()
|
inherited |
Checks if this frame is registered for drag events with the provided mouse button.
- Parameters
-
button_name The name of the mouse button to check
- Returns
- 'true' if this frame is registered for drag events with the provided mouse button
Definition at line 851 of file gui_frame.cpp.
◆ is_in_region()
|
overridevirtualinherited |
Checks if the provided coordinates are inside this frame.
- Parameters
-
position The coordinates to test
- Returns
- 'true' if the provided coordinates are inside this frame or its title region
Reimplemented from lxgui::gui::region.
Reimplemented in lxgui::gui::slider.
Definition at line 819 of file gui_frame.cpp.
◆ is_key_capture_enabled()
|
inherited |
Checks if this frame can receive keyboard input from a specific key.
- Parameters
-
key_name The key to check
- Returns
- 'true' if this frame can receive keyboard input from this key
Definition at line 859 of file gui_frame.cpp.
◆ is_keyboard_enabled()
|
inherited |
Checks if this frame can receive any keyboard input.
- Returns
- 'true' if this frame can receive any keyboard input
Definition at line 855 of file gui_frame.cpp.
◆ is_loaded()
|
inherited |
Checks if this region has been fully loaded.
- Note
- A region that is not fully loaded still has all its core attributes set, hence can be considered as "fully constructed" from a C++ point of view. However, semantically, the object may need further steps to be complete, as designed by the UI designer. Therefore, form the UI's point of view, a region is considered "complete" only if is_loaded() returns 'true' (see notifu_loaded()). Only then can the region, e.g., react to or generate events.
Definition at line 798 of file gui_region.cpp.
◆ is_manually_inherited()
|
inherited |
Checks if this object is manually inherited.
- Returns
- 'true' if this object is manually inherited
- Note
- For more information, see set_manually_inherited().
Definition at line 784 of file gui_region.cpp.
◆ is_mouse_click_enabled()
|
inherited |
Checks if this frame can receive mouse click input.
- Returns
- 'true' if this frame can receive mouse click input
Definition at line 839 of file gui_frame.cpp.
◆ is_mouse_move_enabled()
|
inherited |
Checks if this frame can receive mouse movement input.
- Returns
- 'true' if this frame can receive mouse movement input
Definition at line 843 of file gui_frame.cpp.
◆ is_mouse_wheel_enabled()
|
inherited |
Checks if this frame can receive mouse wheel input.
- Returns
- 'true' if this frame can receive mouse wheel input
Definition at line 847 of file gui_frame.cpp.
◆ is_movable()
|
inherited |
Checks if this frame can be moved.
- Returns
- 'true' if this frame can be moved
Definition at line 863 of file gui_frame.cpp.
◆ is_region_type() [1/3]
|
inlineinherited |
Checks if this region is of the provided type.
- Returns
- 'true' if this region is of the provided type
Definition at line 423 of file gui_region.hpp.
◆ is_region_type() [2/3]
|
inlineinherited |
Checks if this region is of a type equal or derived from the supplied region.
- Returns
- 'true' if this region is of a type equal or derived from the supplied region
Definition at line 431 of file gui_region.hpp.
◆ is_region_type() [3/3]
|
inherited |
Checks if this region is of the provided type.
- Parameters
-
type_name The type to test
- Returns
- 'true' if this region is of the provided type
Definition at line 152 of file gui_region.cpp.
◆ is_resizable()
|
inherited |
Checks if this frame can be resized.
- Returns
- 'true' if this frame can be resized
Definition at line 867 of file gui_frame.cpp.
◆ is_shown()
|
inherited |
Checks if this region is shown.
- Returns
- 'true' if this region is shown
Definition at line 203 of file gui_region.cpp.
◆ is_top_level()
|
inherited |
Checks if this frame is at top level.
- Returns
- 'true' if this frame is at top level
Definition at line 871 of file gui_frame.cpp.
◆ is_user_placed()
|
inherited |
Checks if this frame has been moved by the user.
- Returns
- 'true' if this frame has been moved by the user
Definition at line 875 of file gui_frame.cpp.
◆ is_valid()
|
inherited |
Checks if this region has all its borders correctly defined.
- Returns
- 'true' if this region has all its borders correctly defined
- Note
- To be valid, a region needs to have a defined position and size along both the X and Y dimensions. This means either one anchor and a set size, or two opposite anchors. For example, any anchor plus a call to set_dimensions(). Or a top_left plus a bottom_right anchors. Or a left plus a right anchors plus a call to set_height().
Definition at line 211 of file gui_region.cpp.
◆ is_virtual()
|
inherited |
Checks if this region is virtual.
- Returns
- 'true' if this region is virtual
- Note
- A virtual region will not be displayed on the screen, but can serve as a template to create new GUI elements (it is then "inherited", although note that this has no connection to C++ inheritance).
Definition at line 553 of file gui_region.cpp.
◆ is_visible()
|
inherited |
Checks if this region can be seen on the screen.
- Returns
- 'true' if this region can be seen on the screen
Definition at line 207 of file gui_region.cpp.
◆ make_borders_()
|
protectedinherited |
Definition at line 585 of file gui_region.cpp.
◆ modify_anchor()
Returns one of this region's anchor to modify it.
- Parameters
-
p The anchor point
- Returns
- A reference to the anchor, will throw if this point has no anchor.
- Note
- After you have modified the anchor, you must call notify_borders_need_update() to ensure that the object's borders are properly updated.
Definition at line 529 of file gui_region.cpp.
◆ notify_borders_need_update()
|
virtualinherited |
Tells this region that its borders need updating.
Reimplemented in lxgui::gui::slider.
Definition at line 744 of file gui_region.cpp.
◆ notify_focus()
|
virtualinherited |
Notifies this frame that it has received or lost focus.
- Parameters
-
focus 'true' if focus is received, 'false' if lost
Reimplemented in lxgui::gui::edit_box.
Definition at line 1330 of file gui_frame.cpp.
◆ notify_frame_renderer_changed_()
|
protectedinherited |
Definition at line 1385 of file gui_frame.cpp.
◆ notify_invisible()
|
overridevirtualinherited |
Notifies this region that it is no longer visible on screen.
- Note
- Automatically called by show()/hide().
Reimplemented from lxgui::gui::region.
Definition at line 1457 of file gui_frame.cpp.
◆ notify_layers_need_update()
|
inherited |
Tells this frame to rebuild its layer list.
- Note
- Automatically called by add_region(), remove_region(), and layered_region::set_draw_layer().
Definition at line 489 of file gui_frame.cpp.
◆ notify_level_changed()
|
virtualinherited |
Tells this renderer that a frame has changed level.
- Parameters
-
obj The frame which has changed old_level The old frame level new_level The new frame level
Definition at line 132 of file gui_frame_renderer.cpp.
◆ notify_loaded()
|
overridevirtualinherited |
Notifies this region that it has been fully loaded.
- Note
- Calls the "OnLoad" script.
Reimplemented from lxgui::gui::region.
Definition at line 478 of file gui_frame.cpp.
◆ notify_mouse_in_frame()
|
virtualinherited |
Tells this frame it is being hovered by the mouse.
- Parameters
-
mouse_in_frame 'true' if the mouse is above this frame mouse_pos The mouse coordinates in pixels
- Note
- Always use the mouse position set by this function and not the one returned by the input_manager, because there can be an offset applied (for example with scroll_frame).
Definition at line 1501 of file gui_frame.cpp.
◆ notify_rendered_frame()
|
virtualinherited |
Tells this renderer that it should (or not) render another frame.
- Parameters
-
obj The frame to render rendered 'true' if this renderer needs to render that new object
Definition at line 82 of file gui_frame_renderer.cpp.
◆ notify_renderer_need_redraw()
|
overridevirtualinherited |
Notifies the renderer of this region that it needs to be redrawn.
- Note
- Automatically called by any shape changing function.
Reimplemented from lxgui::gui::region.
Definition at line 1481 of file gui_frame.cpp.
◆ notify_scaling_factor_updated()
|
overridevirtual |
Tells this region that the global interface scaling factor has changed.
Reimplemented from lxgui::gui::frame.
Definition at line 211 of file gui_scroll_frame.cpp.
◆ notify_strata_changed()
|
virtualinherited |
Tells this renderer that a frame has changed strata.
- Parameters
-
obj The frame which has changed old_strata_id The old frame strata new_strata_id The new frame strata
Definition at line 110 of file gui_frame_renderer.cpp.
◆ notify_strata_changed_()
|
protectedinherited |
Definition at line 567 of file gui_frame.cpp.
◆ notify_strata_needs_redraw()
|
overridevirtual |
Tells this renderer that one of its region requires redraw.
Reimplemented from lxgui::gui::frame_renderer.
Definition at line 282 of file gui_scroll_frame.cpp.
◆ notify_visible()
|
overridevirtualinherited |
Notifies this region that it is now visible on screen.
- Note
- Automatically called by show()/hide().
Reimplemented from lxgui::gui::region.
Definition at line 1423 of file gui_frame.cpp.
◆ on_event_()
|
protectedinherited |
Definition at line 1096 of file gui_frame.cpp.
◆ parse_all_nodes_before_children_()
|
overrideprotectedvirtual |
Reimplemented from lxgui::gui::frame.
Definition at line 8 of file gui_scroll_frame_parser.cpp.
◆ parse_anchor_node_()
|
protectedvirtualinherited |
Definition at line 89 of file gui_region_parser.cpp.
◆ parse_attributes_()
|
overrideprotectedvirtualinherited |
Reimplemented from lxgui::gui::region.
Reimplemented in lxgui::gui::status_bar, and lxgui::gui::slider.
Definition at line 33 of file gui_frame_parser.cpp.
◆ parse_backdrop_node_()
|
protectedvirtualinherited |
Definition at line 133 of file gui_frame_parser.cpp.
◆ parse_child_()
|
protectedinherited |
Definition at line 360 of file gui_frame_parser.cpp.
◆ parse_color_node_()
|
protectedinherited |
Definition at line 10 of file gui_region_parser.cpp.
◆ parse_dimension_node_()
|
protectedinherited |
Definition at line 35 of file gui_region_parser.cpp.
◆ parse_file_name()
|
inherited |
Convert an addon-relative file path to a application-relative path.
- Parameters
-
file_name The raw file name
- Returns
- The modified file name
- Note
- All file names must be relative to the current working directory (typically, the application's executable path), but sometimes it is more convenient and maintainable to specify a path that is relative to the addon directory. This can be achieved by simply putting "|" in front of a file name, which will then be interpreted as relative to the addon directory. This function takes care of this transformation.
Definition at line 818 of file gui_region.cpp.
◆ parse_frames_node_()
|
protectedvirtualinherited |
Definition at line 389 of file gui_frame_parser.cpp.
◆ parse_hit_rect_insets_node_()
|
protectedvirtualinherited |
Definition at line 271 of file gui_frame_parser.cpp.
◆ parse_layers_node_()
|
protectedvirtualinherited |
Definition at line 342 of file gui_frame_parser.cpp.
◆ parse_layout()
|
finalvirtualinherited |
Parses data from a layout_node.
- Parameters
-
node The layout node
- Note
- Derived classes must override parse_all_nodes_before_children_() if they need to parse additional blocks, and parse_attributes_() if they need to parse additional attributes.
Reimplemented from lxgui::gui::region.
Definition at line 27 of file gui_frame_parser.cpp.
◆ parse_offset_node_()
|
protectedinherited |
Definition at line 24 of file gui_region_parser.cpp.
◆ parse_offset_node_or_()
|
protectedinherited |
Definition at line 28 of file gui_region_parser.cpp.
◆ parse_region_()
|
protectedinherited |
Definition at line 306 of file gui_frame_parser.cpp.
◆ parse_resize_bounds_node_()
|
protectedvirtualinherited |
Definition at line 82 of file gui_frame_parser.cpp.
◆ parse_scripts_node_()
|
protectedvirtualinherited |
Definition at line 397 of file gui_frame_parser.cpp.
◆ parse_scroll_child_node_()
|
protectedvirtual |
Definition at line 13 of file gui_scroll_frame_parser.cpp.
◆ parse_size_node_()
|
protectedvirtualinherited |
Definition at line 65 of file gui_region_parser.cpp.
◆ parse_title_region_node_()
|
protectedvirtualinherited |
Definition at line 124 of file gui_frame_parser.cpp.
◆ raise()
|
inherited |
Increases this frame's level so it's the highest of the strata.
- Note
- All its children are raised of the same amount.
- Only works for top level frames.
Definition at line 1286 of file gui_frame.cpp.
◆ read_anchors_()
|
protectedinherited |
Definition at line 614 of file gui_region.cpp.
◆ rebuild_scroll_render_target_()
|
protected |
Definition at line 217 of file gui_scroll_frame.cpp.
◆ register_event()
|
inherited |
Tells this frame to react to a certain event.
- Parameters
-
event_name The name of the event
Definition at line 1131 of file gui_frame.cpp.
◆ register_on_lua()
|
static |
Registers this region class to the provided Lua state.
◆ release_from_parent()
|
overridevirtualinherited |
Removes this region from its parent and return an owning pointer.
- Returns
- An owning pointer to this region
Reimplemented from lxgui::gui::region.
Definition at line 1264 of file gui_frame.cpp.
◆ remove_anchored_object()
|
inherited |
Notifies this region that another one is no longer anchored to it.
- Parameters
-
obj The region no longer anchored
- See also
- add_anchored_object()
Definition at line 565 of file gui_region.cpp.
◆ remove_child()
|
inherited |
Removes a frame from this frame's children.
- Parameters
-
child The frame to remove
- Returns
- A unique_ptr to the child, ignore it to destroy the child.
Definition at line 690 of file gui_frame.cpp.
◆ remove_glue()
|
inherited |
Removes the Lua glue.
Definition at line 775 of file gui_region.cpp.
◆ remove_region()
|
inherited |
Removes a layered_region from this frame's children.
- Parameters
-
reg The layered_region to remove
- Returns
- A unique_ptr to the region, ignore it to destroy the region.
Definition at line 617 of file gui_frame.cpp.
◆ remove_script()
|
inherited |
Removes a script from this frame.
- Parameters
-
script_name The name of the script (e.g., "OnEvent")
- Note
- This removes all handler scripts registered to this event, including the ones inherited from templates.
Definition at line 1080 of file gui_frame.cpp.
◆ render()
|
overridevirtualinherited |
Renders this region on the current render target.
Reimplemented from lxgui::gui::region.
Definition at line 62 of file gui_frame.cpp.
◆ render_scroll_strata_list_()
|
protected |
Definition at line 249 of file gui_scroll_frame.cpp.
◆ render_strata_()
|
protectedinherited |
Definition at line 174 of file gui_frame_renderer.cpp.
◆ reset_strata_list_changed_flag_()
|
protectedinherited |
Definition at line 192 of file gui_frame_renderer.cpp.
◆ round_to_pixel() [1/2]
|
inherited |
Round an absolute position on screen to the nearest physical pixel.
- Parameters
-
position The input absolute position (can be fractional) method The rounding method
- Returns
- The position of the nearest physical pixel
Definition at line 578 of file gui_region.cpp.
◆ round_to_pixel() [2/2]
|
inherited |
Round an absolute position on screen to the nearest physical pixel.
- Parameters
-
value The input absolute position (can be fractional) method The rounding method
- Returns
- The position of the nearest physical pixel
Definition at line 573 of file gui_region.cpp.
◆ serialize()
|
overridevirtualinherited |
Prints all relevant information about this region in a string.
- Parameters
-
tab The offset to give to all lines
- Returns
- All relevant information about this region
Reimplemented from lxgui::gui::region.
Reimplemented in lxgui::gui::status_bar, and lxgui::gui::slider.
Definition at line 84 of file gui_frame.cpp.
◆ set_abs_hit_rect_insets()
|
inherited |
Sets this frame's absolute hit rect insets.
- Parameters
-
insets Offsets
- Note
- This is the zone on which you can click.
Definition at line 1193 of file gui_frame.cpp.
◆ set_addon()
|
inherited |
Sets the addon this frame belongs to.
- Parameters
-
a The addon this frame belongs to
Definition at line 833 of file gui_region.cpp.
◆ set_all_anchors() [1/2]
|
inherited |
Adjusts this regions anchors to fit the provided region.
- Parameters
-
obj_name The name of the object to fit to
- Note
- Removes all anchors and defines two new ones.
Definition at line 404 of file gui_region.cpp.
◆ set_all_anchors() [2/2]
|
inherited |
Adjusts this regions anchors to fit the provided region.
- Parameters
-
obj A pointer to the object you want to wrap
- Note
- Removes all anchors and defines two new ones.
Definition at line 437 of file gui_region.cpp.
◆ set_alpha()
|
inherited |
Changes this region's alpha (opacity).
- Parameters
-
alpha The new alpha value
- Note
- Default is 1.0f.
Definition at line 169 of file gui_region.cpp.
◆ set_anchor() [1/2]
|
inlineinherited |
Adds/replaces an anchor.
- Parameters
-
args Argument to construct a new anchor_data
Definition at line 503 of file gui_region.hpp.
◆ set_anchor() [2/2]
|
inherited |
Adds/replaces an anchor.
- Parameters
-
a The anchor to add
Definition at line 473 of file gui_region.cpp.
◆ set_backdrop()
|
inherited |
Sets this frames' backdrop.
- Parameters
-
bdrop The new backdrop
Definition at line 1188 of file gui_frame.cpp.
◆ set_clamped_to_screen()
|
inherited |
Sets if this frame is clamped to screen.
- Parameters
-
is_clamped_to_screen 'true' if this frame is clamped to screen
- Note
- If 'true', the frame can't go out of the screen.
Definition at line 1174 of file gui_frame.cpp.
◆ set_dimensions()
|
overridevirtualinherited |
Changes this region's absolute dimensions (in pixels).
- Parameters
-
dimensions The new dimensions
Reimplemented from lxgui::gui::region.
Definition at line 345 of file gui_frame.cpp.
◆ set_drag_enabled() [1/2]
|
inlineinherited |
Tells this frame whether to react to mouse drag or not.
- Parameters
-
button_name The mouse button to react to enable 'true' to enable, 'false' to disable
Definition at line 1391 of file gui_frame.hpp.
◆ set_drag_enabled() [2/2]
|
inlineinherited |
Tells this frame whether to react to mouse drag or not.
- Parameters
-
button_id The mouse button to react to enable 'true' to enable, 'false' to disable
Definition at line 1404 of file gui_frame.hpp.
◆ set_draw_layer_enabled()
|
inlineinherited |
Enables or disables a layer.
- Parameters
-
layer_id The id of the layer to disable enable 'true' to enable, 'false' to disable
Definition at line 342 of file gui_frame.hpp.
◆ set_focus()
|
inherited |
Asks for focus for this frame.
- Parameters
-
focus 'true' to ask for focus, 'false' to release it
- Note
- Focus can be lost if another frame asks for focus later. The focus will be restored automatically when that other frame releases focus, or it can be requested again by calling set_focus(true).
Definition at line 1318 of file gui_frame.cpp.
◆ set_frame_renderer()
|
inherited |
Flags this object as rendered by another object.
- Parameters
-
rdr The object that will take care of rendering this region
- Note
- By default, objects are rendered by the gui::manager.
- The renderer also takes care of providing inputs.
- If the renderer is set to nullptr, the frame will inherit the renderer of its parent. If the frame has no parent, this will default to the gui::manager.
Definition at line 1398 of file gui_frame.cpp.
◆ set_height()
|
overridevirtualinherited |
Changes this region's absolute height (in pixels).
- Parameters
-
abs_height The new height
Reimplemented from lxgui::gui::region.
Definition at line 355 of file gui_frame.cpp.
◆ set_horizontal_scroll()
| void lxgui::gui::scroll_frame::set_horizontal_scroll | ( | float | horizontal_scroll | ) |
Sets the horizontal offset of the scroll child.
- Parameters
-
horizontal_scroll The horizontal offset
Definition at line 124 of file gui_scroll_frame.cpp.
◆ set_key_capture_enabled() [1/2]
|
inlineinherited |
Marks this frame as able to receive keyboard input from a specific key.
- Parameters
-
key_name The key to capture enable 'true' to enable, 'false' to disable
Definition at line 486 of file gui_frame.hpp.
◆ set_key_capture_enabled() [2/2]
|
inlineinherited |
Marks this frame as able to receive keyboard input from a specific key.
- Parameters
-
key_id The key to capture enable 'true' to enable, 'false' to disable
Definition at line 501 of file gui_frame.hpp.
◆ set_keyboard_enabled()
|
inherited |
Sets if this frame can receive any keyboard input.
- Parameters
-
is_keyboard_enabled 'true' to enable
- Note
- If enabled, specific keys must be enabled for capture to actually receive keybaord events.
- See also
- is_keyboard_enabled()
- enable_key_capture()
- is_key_capture_enabled()
- enable_keyboard()
- disable_keyboard()
Definition at line 454 of file gui_frame.cpp.
◆ set_level()
|
inherited |
Sets this frame's level.
- Parameters
-
level_id The new level
Definition at line 1201 of file gui_frame.cpp.
◆ set_lua_member_()
|
protectedinherited |
◆ set_manually_inherited()
|
inherited |
Flags this region as manually inherited or not.
- Note
- By default, all regions are automatically inherited. This is generally the desired behavior for regions defined by the user, but it is less desirable for "special" or "internal" regions necessary for the proper operation of some region types (e.g., the texture used by a button), which need special treatment or registration.
Definition at line 780 of file gui_region.cpp.
◆ set_max_dimensions()
|
inherited |
Sets this frame's maximum size.
- Parameters
-
max The maximum dimensions of this frame
Definition at line 1212 of file gui_frame.cpp.
◆ set_max_height()
|
inherited |
Sets this frame's maximum height.
- Parameters
-
max_height The maximum height this frame can have
Definition at line 1222 of file gui_frame.cpp.
◆ set_max_width()
|
inherited |
Sets this frame's maximum width.
- Parameters
-
max_width The maximum width this frame can have
Definition at line 1233 of file gui_frame.cpp.
◆ set_min_dimensions()
|
inherited |
Sets this frame's minimum size.
- Parameters
-
min Minimum dimensions of this frame
Definition at line 1217 of file gui_frame.cpp.
◆ set_min_height()
|
inherited |
Sets this frame's minimum height.
- Parameters
-
min_height The minimum height this frame can have
Definition at line 1244 of file gui_frame.cpp.
◆ set_min_width()
|
inherited |
Sets this frame's minimum width.
- Parameters
-
min_width The minimum width this frame can have
Definition at line 1252 of file gui_frame.cpp.
◆ set_mouse_click_enabled()
|
inherited |
Sets if this frame can receive mouse click input.
- Parameters
-
is_mouse_enabled 'true' to enable
Definition at line 442 of file gui_frame.cpp.
◆ set_mouse_enabled()
|
inherited |
Sets if this frame can receive mouse input (click & move).
- Parameters
-
is_mouse_enabled 'true' to enable
Definition at line 437 of file gui_frame.cpp.
◆ set_mouse_move_enabled()
|
inherited |
Sets if this frame can receive mouse move input.
- Parameters
-
is_mouse_enabled 'true' to enable
Definition at line 446 of file gui_frame.cpp.
◆ set_mouse_wheel_enabled()
|
inherited |
Sets if this frame can receive mouse wheel input.
- Parameters
-
is_mouse_wheel_enabled 'true' to enable
Definition at line 450 of file gui_frame.cpp.
◆ set_movable()
|
inherited |
Sets if this frame can be moved by the user.
- Parameters
-
is_movable 'true' to allow the user to move this frame
Definition at line 1260 of file gui_frame.cpp.
◆ set_name_()
|
protectedinherited |
Sets this region's name.
- Parameters
-
name This region's name
- Note
- Can only be called once. If you need to set both the name and the parent at the same time (typically, at creation), use set_name_and_parent_().
Definition at line 294 of file gui_region.cpp.
◆ set_parent_()
|
overrideprotectedvirtualinherited |
Changes this region's parent.
- Parameters
-
parent The new parent
- Note
- Default is nullptr.
Reimplemented from lxgui::gui::region.
Definition at line 513 of file gui_frame.cpp.
◆ set_rel_hit_rect_insets()
|
inherited |
Sets this frame's relative hit rect insets.
- Parameters
-
insets Offsets
- Note
- This is the zone on which you can click.
Definition at line 1197 of file gui_frame.cpp.
◆ set_relative_dimensions()
|
inherited |
Changes this region's dimensions (relative to its parent).
- Parameters
-
dimensions The new dimensions (relative)
Definition at line 251 of file gui_region.cpp.
◆ set_relative_height()
|
inherited |
Changes this region's height (relative to its parent).
- Parameters
-
rel_height The new height
Definition at line 265 of file gui_region.cpp.
◆ set_relative_width()
|
inherited |
Changes this region's width (relative to its parent).
- Parameters
-
rel_width The new width
Definition at line 258 of file gui_region.cpp.
◆ set_resizable()
|
inherited |
Sets if this frame can be resized by the user.
- Parameters
-
is_resizable 'true' to allow the user to resize this frame
Definition at line 1272 of file gui_frame.cpp.
◆ set_scale()
|
inherited |
Sets this frame's scale.
- Parameters
-
scale The new scale
Definition at line 1276 of file gui_frame.cpp.
◆ set_script() [1/4]
|
inlineinherited |
Sets a new handler script for this frame (replacing existing scripts).
- Parameters
-
script_name The name of the script (e.g., "OnEvent") handler The handler of the script, as a C++ function of signature script_signature info The location where this script has been defined
- Returns
- A connection object, to disable the script if needed.
- Note
- This defines a C++ function to be called for the event specified in script_name. This provides the best performance, but lacks direct access to the Lua environment. If this is required, prefer the other overload taking a Lua function instead.
-
This overload enables taking handler scripts with a
selfparameter of type other than frame, for example:For maximum safety, by default this is done using adynamic_cast, so that incorrect types will be reported. However this has a cost; if you are sure of the type and want to bypass this cost, just supply theselftype as the first template argument to this function:add_script<button>([](button& self, const event_data& data) { ... });
Definition at line 1305 of file gui_frame.hpp.
◆ set_script() [2/4]
|
inlineinherited |
Sets a new handler script for this frame (replacing existing scripts).
- Parameters
-
script_name The name of the script (e.g., "OnEvent") handler The handler of the script, as a C++ function of signature script_signature info The location where this script has been defined
- Returns
- A connection object, to disable the script if needed.
- Note
- This defines a C++ function to be called for the event specified in script_name. This provides the best performance, but lacks direct access to the Lua environment. If this is required, prefer the other overload taking a Lua function instead.
Definition at line 1273 of file gui_frame.hpp.
◆ set_script() [3/4]
|
inlineinherited |
Sets a new handler script for this frame (replacing existing scripts).
- Parameters
-
script_name The name of the script (e.g., "OnEvent") handler The handler of the script, as a Lua function info The location where this script has been defined
- Returns
- A connection object, to disable the script if needed.
- Note
- This defines a Lua function to be called for the event specified in script_name. This provides more flexibility compared to using C++ function, but also has a larger overhead. If performance is a concern, prefer the other overload taking a C++ function instead.
Definition at line 1252 of file gui_frame.hpp.
◆ set_script() [4/4]
|
inlineinherited |
Sets a new handler script for this frame (replacing existing scripts).
- Parameters
-
script_name The name of the script (e.g., "OnEvent") content The content of the script, as Lua code info The location where this script has been defined
- Returns
- A connection object, to disable the script if needed.
- Note
- The script_info parameter is used only for displaying error messages. This function is meant to be used by the layout file parser. If you want to manually define your own script handlers, prefer the other overloads.
Definition at line 1233 of file gui_frame.hpp.
◆ set_scroll_child()
| void lxgui::gui::scroll_frame::set_scroll_child | ( | utils::owner_ptr< frame > | obj | ) |
Sets this scroll_frame's scroll child.
- Parameters
-
obj The scroll child
- Note
- Creates the render target.
Definition at line 80 of file gui_scroll_frame.cpp.
◆ set_shown()
|
inherited |
shows/hides this region.
- Parameters
-
is_shown 'true' if you want to show this region
Definition at line 196 of file gui_region.cpp.
◆ set_strata()
|
inherited |
Sets this frame's strata.
- Parameters
-
strata_id The new strata, or nullopt to inherit strata from parent
Definition at line 1178 of file gui_frame.cpp.
◆ set_top_level()
|
inherited |
Sets if this frame is at top level.
- Parameters
-
is_top_level 'true' to put the frame at top level
- Note
- A top-level frame will be raised to the foreground if it or any of its children are clicked. This should typically be set to 'true' for any "dialog" or "window" frame, which can be moved around, and not for "element" frames (buttons, etc.).
Definition at line 1282 of file gui_frame.cpp.
◆ set_update_rate()
|
inherited |
Sets a maximum update rate (in updates per seconds).
- Parameters
-
rate The new rate, or 0 to update as often as possible
- Note
- The default is 0, which means the frame will be updated on each frame. If set to a value of 10, then the frame will be updated a maximum of 10 times per second. This can be useful to avoid wasting time updating a frame constantly, when less frequent updates would be sufficient.
- Warning
- Because update is triggered from parent to child, a frame's update rate will never be greater than that of its parent, even if this function is used to set the rate to a larger value.
Definition at line 1146 of file gui_frame.cpp.
◆ set_user_placed()
|
inherited |
Sets if this frame has been moved by the user.
- Parameters
-
is_user_placed 'true' if this frame has been moved by the user
Definition at line 1355 of file gui_frame.cpp.
◆ set_vertical_scroll()
| void lxgui::gui::scroll_frame::set_vertical_scroll | ( | float | vertical_scroll | ) |
Sets the vertical offset of the scroll child.
- Parameters
-
vertical_scroll The vertical offset
Definition at line 149 of file gui_scroll_frame.cpp.
◆ set_virtual_()
|
protectedinherited |
◆ set_width()
|
overridevirtualinherited |
Changes this region's absolute width (in pixels).
- Parameters
-
abs_width The new width
Reimplemented from lxgui::gui::region.
Definition at line 351 of file gui_frame.cpp.
◆ show()
|
inherited |
shows this region.
- Note
- Its parent must be shown for it to appear on the screen.
Definition at line 176 of file gui_region.cpp.
◆ start_moving()
|
inherited |
Starts moving this frame with the mouse.
Definition at line 1359 of file gui_frame.cpp.
◆ start_sizing()
|
inherited |
Starts resizing this frame with the mouse.
- Parameters
-
p The corner to move
Definition at line 1372 of file gui_frame.cpp.
◆ stop_moving()
|
inherited |
ends moving this frame.
Definition at line 1367 of file gui_frame.cpp.
◆ stop_sizing()
|
inherited |
ends resizing this frame.
Definition at line 1380 of file gui_frame.cpp.
◆ unregister_event()
|
inherited |
Tells the frame not to react to a certain event.
- Parameters
-
event_name The name of the event
Definition at line 1139 of file gui_frame.cpp.
◆ update()
|
finalvirtualinherited |
Updates this region's logic.
- Parameters
-
delta Time spent since last update
- Note
- Triggered callbacks could destroy the frame. If you need to use the frame again after calling this function, use the helper class alive_checker.
Reimplemented from lxgui::gui::region.
Definition at line 1543 of file gui_frame.cpp.
◆ update_()
|
overrideprotectedvirtual |
Reimplemented from lxgui::gui::frame.
Definition at line 174 of file gui_scroll_frame.cpp.
◆ update_borders_()
|
overrideprotectedvirtualinherited |
Reimplemented from lxgui::gui::region.
Definition at line 1519 of file gui_frame.cpp.
◆ update_scroll_range_()
|
protected |
Definition at line 188 of file gui_scroll_frame.cpp.
Member Data Documentation
◆ abs_hit_rect_inset_list_
|
protectedinherited |
Definition at line 1833 of file gui_frame.hpp.
◆ addon_
|
protectedinherited |
Definition at line 802 of file gui_region.hpp.
◆ alpha_
|
protectedinherited |
Definition at line 818 of file gui_region.hpp.
◆ anchor_list_
|
protectedinherited |
Definition at line 814 of file gui_region.hpp.
◆ anchored_object_list_
|
protectedinherited |
Definition at line 824 of file gui_region.hpp.
◆ backdrop_
|
protectedinherited |
Definition at line 1822 of file gui_frame.hpp.
◆ borders_
|
protectedinherited |
Definition at line 816 of file gui_region.hpp.
◆ child_list_
|
protectedinherited |
Definition at line 1801 of file gui_frame.hpp.
◆ class_name
|
staticconstexpr |
Definition at line 157 of file gui_scroll_frame.hpp.
◆ defined_borders_
|
protectedinherited |
Definition at line 815 of file gui_region.hpp.
◆ dimensions_
|
protectedinherited |
Definition at line 822 of file gui_region.hpp.
◆ effective_frame_renderer_
|
protectedinherited |
Definition at line 1820 of file gui_frame.hpp.
◆ effective_strata_
|
protectedinherited |
Definition at line 1816 of file gui_frame.hpp.
◆ event_receiver_
|
protectedinherited |
Definition at line 1809 of file gui_frame.hpp.
◆ frame_list_updated_
|
protectedinherited |
Definition at line 114 of file gui_frame_renderer.hpp.
◆ frame_renderer_
|
protectedinherited |
Definition at line 1819 of file gui_frame.hpp.
◆ is_auto_focus_
|
protectedinherited |
Definition at line 1851 of file gui_frame.hpp.
◆ is_clamped_to_screen_
|
protectedinherited |
Definition at line 1829 of file gui_frame.hpp.
◆ is_focused_
|
protectedinherited |
Definition at line 1850 of file gui_frame.hpp.
◆ is_keyboard_enabled_
|
protectedinherited |
Definition at line 1827 of file gui_frame.hpp.
◆ is_loaded_
|
protectedinherited |
Definition at line 811 of file gui_region.hpp.
◆ is_manually_inherited_
|
protectedinherited |
Definition at line 809 of file gui_region.hpp.
◆ is_mouse_click_enabled_
|
protectedinherited |
Definition at line 1824 of file gui_frame.hpp.
◆ is_mouse_in_frame_
|
protectedinherited |
Definition at line 1846 of file gui_frame.hpp.
◆ is_mouse_move_enabled_
|
protectedinherited |
Definition at line 1825 of file gui_frame.hpp.
◆ is_mouse_wheel_enabled_
|
protectedinherited |
Definition at line 1826 of file gui_frame.hpp.
◆ is_movable_
|
protectedinherited |
Definition at line 1828 of file gui_frame.hpp.
◆ is_resizable_
|
protectedinherited |
Definition at line 1830 of file gui_frame.hpp.
◆ is_shown_
|
protectedinherited |
Definition at line 819 of file gui_region.hpp.
◆ is_top_level_
|
protectedinherited |
Definition at line 1817 of file gui_frame.hpp.
◆ is_user_placed_
|
protectedinherited |
Definition at line 1831 of file gui_frame.hpp.
◆ is_valid_
|
protectedinherited |
Definition at line 812 of file gui_region.hpp.
◆ is_virtual_
|
protectedinherited |
Definition at line 810 of file gui_region.hpp.
◆ is_visible_
|
protectedinherited |
Definition at line 820 of file gui_region.hpp.
◆ layer_list_
|
protectedinherited |
Definition at line 1806 of file gui_frame.hpp.
◆ level_
|
protectedinherited |
Definition at line 1814 of file gui_frame.hpp.
◆ manager_
|
protectedinherited |
Definition at line 800 of file gui_region.hpp.
◆ max_height_
|
protectedinherited |
Definition at line 1839 of file gui_frame.hpp.
◆ max_width_
|
protectedinherited |
Definition at line 1837 of file gui_frame.hpp.
◆ min_height_
|
protectedinherited |
Definition at line 1838 of file gui_frame.hpp.
◆ min_width_
|
protectedinherited |
Definition at line 1836 of file gui_frame.hpp.
◆ name_
|
protectedinherited |
Definition at line 804 of file gui_region.hpp.
◆ num_layers
|
staticconstexprprotectedinherited |
Definition at line 1804 of file gui_frame.hpp.
◆ num_strata
|
staticconstexprprotectedinherited |
Definition at line 110 of file gui_frame_renderer.hpp.
◆ parent_
|
protectedinherited |
Definition at line 807 of file gui_region.hpp.
◆ raw_name_
|
protectedinherited |
Definition at line 805 of file gui_region.hpp.
◆ redraw_scroll_render_target_flag_
|
protected |
Definition at line 177 of file gui_scroll_frame.hpp.
◆ reg_drag_list_
|
protectedinherited |
Definition at line 1811 of file gui_frame.hpp.
◆ reg_key_list_
|
protectedinherited |
Definition at line 1812 of file gui_frame.hpp.
◆ region_list_
|
protectedinherited |
Definition at line 1802 of file gui_frame.hpp.
◆ rel_hit_rect_inset_list_
|
protectedinherited |
Definition at line 1834 of file gui_frame.hpp.
◆ scale_
|
protectedinherited |
Definition at line 1841 of file gui_frame.hpp.
◆ scroll_
|
protected |
Definition at line 171 of file gui_scroll_frame.hpp.
◆ scroll_child_
|
protected |
Definition at line 174 of file gui_scroll_frame.hpp.
◆ scroll_child_on_resize_connection_
|
protected |
Definition at line 175 of file gui_scroll_frame.hpp.
◆ scroll_range_
|
protected |
Definition at line 172 of file gui_scroll_frame.hpp.
◆ scroll_render_target_
|
protected |
Definition at line 178 of file gui_scroll_frame.hpp.
◆ scroll_texture_
|
protected |
Definition at line 180 of file gui_scroll_frame.hpp.
◆ signal_list_
|
protectedinherited |
Definition at line 1808 of file gui_frame.hpp.
◆ sorted_frame_list_
|
protectedinherited |
Definition at line 113 of file gui_frame_renderer.hpp.
◆ strata_
|
protectedinherited |
Definition at line 1815 of file gui_frame.hpp.
◆ strata_list_
|
protectedinherited |
Definition at line 112 of file gui_frame_renderer.hpp.
◆ time_since_last_update_
|
protectedinherited |
Definition at line 1844 of file gui_frame.hpp.
◆ title_region_
|
protectedinherited |
Definition at line 1848 of file gui_frame.hpp.
◆ update_rate_
|
protectedinherited |
Definition at line 1843 of file gui_frame.hpp.
The documentation for this class was generated from the following files:
- /home/runner/work/lxgui/lxgui/include/lxgui/gui_scroll_frame.hpp
- /home/runner/work/lxgui/lxgui/src/gui_scroll_frame.cpp
- /home/runner/work/lxgui/lxgui/src/gui_scroll_frame_parser.cpp
