Classes

class  clan::AcceleratorKey
 GUI Accelerator Table Entry. More...
 
class  clan::AcceleratorTable
 GUI Accelerator Table. More...
 
class  clan::GUIComponent
 GUI base component class. More...
 
class  clan::GUILayout
 Layout management base class. More...
 
class  clan::GUILayoutCorners
 GUI base component class. More...
 
class  clan::GUILayoutProvider
 Layout management interface. More...
 
class  clan::GUIManager
 GUI manager. More...
 
class  clan::GUIMessage
 GUI message. More...
 
class  clan::GUIMessage_ActivationChange
 GUI activation change notification message. More...
 
class  clan::GUIMessage_Close
 GUI window close message. More...
 
class  clan::GUIMessage_FocusChange
 GUI focus change notification message. More...
 
class  clan::GUIMessage_Input
 GUI input message. More...
 
class  clan::GUIMessage_Pointer
 GUI mouse pointer change notification message. More...
 
class  clan::GUIMessage_Resize
 GUI resize message. More...
 
class  clan::GUIThemePart
 A GUI theme part represents a pseudo element in CSS. More...
 
class  clan::GUIWindowManager
 GUI window manager interface. More...
 
class  clan::GUIWindowManagerDirect
 Direct window manager. More...
 
class  clan::GUIWindowManagerProvider
 GUI window manager interface. More...
 
class  clan::GUIWindowManagerSite
 GUI window manager site. More...
 
class  clan::GUIWindowManagerSystem
 System (OS) window manager. More...
 
class  clan::GUIWindowManagerTexture
 Texture window manager. More...
 
class  clan::GUIWindowManagerTextureWindow
 Texture window manager window. More...
 
class  clan::SetupGUI
 ClanGUI initialization functions. More...
 
struct  clan::VerticalTextPosition
 

Typedefs

typedef DisplayWindowDescription clan::GUITopLevelDescription
 

Enumerations

enum  clan::ComponentAnchorPoint {
  clan::anchor_top_left, clan::anchor_top_right, clan::anchor_bottom_left, clan::anchor_bottom_right,
  clan::anchor_relative
}
 Component Anchor Point. More...
 

Variables

float clan::VerticalTextPosition::baseline
 
float clan::VerticalTextPosition::bottom
 
float clan::VerticalTextPosition::top
 

Construction

 clan::AcceleratorKey::AcceleratorKey ()
 Constructs a null instance. More...
 
 clan::AcceleratorKey::AcceleratorKey (int id, int mod1=-1, int mod2=-1, int mod3=-1)
 Constructs a AcceleratorKey. More...
 
 clan::AcceleratorKey::~AcceleratorKey ()
 

Attributes

Callback_v2< std::shared_ptr
< GUIMessage >
&, AcceleratorKey > & 
clan::AcceleratorKey::func_pressed ()
 
bool clan::AcceleratorKey::get_shift () const
 Get Shift. More...
 
bool clan::AcceleratorKey::get_alt () const
 Get Alt. More...
 
bool clan::AcceleratorKey::get_ctrl () const
 Get Ctrl. More...
 
int clan::AcceleratorKey::get_id () const
 Get Id. More...
 
bool clan::AcceleratorKey::is_null () const
 Returns true if this object is invalid. More...
 
void clan::AcceleratorKey::throw_if_null () const
 Throw an exception if this object is invalid. More...
 

Operations

void clan::AcceleratorKey::set_shift (bool)
 Set Shift. More...
 
void clan::AcceleratorKey::set_alt (bool)
 Set Alt. More...
 
void clan::AcceleratorKey::set_ctrl (bool)
 Set Ctrl. More...
 
void clan::AcceleratorKey::set_id (int)
 Set Id. More...
 

Construction

 clan::AcceleratorTable::AcceleratorTable ()
 
 clan::AcceleratorTable::~AcceleratorTable ()
 

Attributes

AcceleratorKey clan::AcceleratorTable::get_accelerator (int id, bool shift=false, bool alt=false, bool ctrl=false)
 Returns a vector containing the accelerator keys defined for this table. More...
 
std::vector< AcceleratorKey > clan::AcceleratorTable::get_accelerators ()
 Returns a vector containing the accelerator keys defined for this table. More...
 

Operations

void clan::AcceleratorTable::add_accelerator (const AcceleratorKey &accel)
 Add an accelerator table entry to the accelerator table. More...
 
void clan::AcceleratorTable::process_message (std::shared_ptr< GUIMessage > &msg)
 Check if the message is an accelerator key and invoke relevant accelerator callback. More...
 

Construction

 clan::GUIComponent::GUIComponent (GUIComponent *parent, const std::string &tag_name="component")
 Creates a GUI component. More...
 
 clan::GUIComponent::GUIComponent (GUIManager *manager, const GUITopLevelDescription &description, const std::string &tag_name="window")
 Constructs a GUIComponent. More...
 
 clan::GUIComponent::GUIComponent (GUIComponent *owner, const GUITopLevelDescription &description, const std::string &tag_name="window")
 Constructs a GUIComponent. More...
 
virtual clan::GUIComponent::~GUIComponent ()
 

Attributes

enum  clan::GUIComponent::FocusPolicy { clan::GUIComponent::focus_refuse, clan::GUIComponent::focus_local, clan::GUIComponent::focus_group, clan::GUIComponent::focus_parent }
 Focus policies. More...
 
Rect clan::GUIComponent::get_geometry () const
 Returns the position and size of the drawable area of the component relative to its parent component. More...
 
Rect clan::GUIComponent::get_viewport () const
 Returns the position and size of the viewport of the component window in screen coordinates. More...
 
Rect clan::GUIComponent::get_content_box () const
 Returns the content box area relative to the component geometry. More...
 
int clan::GUIComponent::get_width () const
 Returns the width of the drawable area of the component. More...
 
int clan::GUIComponent::get_height () const
 Returns the height of the drawable area of the component. More...
 
Size clan::GUIComponent::get_size () const
 Returns the size of the drawable area of the component. More...
 
Rect clan::GUIComponent::get_window_geometry () const
 Returns the position and size of the component window (window frame, borders etc). More...
 
std::string clan::GUIComponent::get_tag_name () const
 Returns the CSS tag name. More...
 
std::string clan::GUIComponent::get_id () const
 Returns the CSS id attribute. More...
 
bool clan::GUIComponent::get_class (const std::string &name) const
 Returns whether a CSS class is present or not. More...
 
bool clan::GUIComponent::get_pseudo_class (const std::string &name) const
 Returns whether a CSS pseudo class is present or not. More...
 
std::vector< std::string > clan::GUIComponent::get_classes () const
 Returns all classes currently present. More...
 
std::vector< std::string > clan::GUIComponent::get_pseudo_classes () const
 Returns all pseudo classes currently present. More...
 
const CSSComputedValues & clan::GUIComponent::get_css_values () const
 Returns the standard W3C CSS properties active for this component. More...
 
bool clan::GUIComponent::has_focus () const
 Returns true if the component has the focus. More...
 
bool clan::GUIComponent::get_allow_resize () const
 Returns true if the components size can be changed. More...
 
bool clan::GUIComponent::get_clip_children () const
 Returns true if the components children are clipped to the parent component when drawn. More...
 
FocusPolicy clan::GUIComponent::get_focus_policy () const
 Returns the focus policy of the component. More...
 
std::string clan::GUIComponent::get_component_group_name () const
 Returns the name of the component group, or an empty string if no group name has been set. More...
 
bool clan::GUIComponent::is_selected_in_group () const
 Returns true if the component is the selected item in a group of components where FocusPolicy is focus_group. More...
 
bool clan::GUIComponent::get_blocks_default_action () const
 Returns true if this component, when focused, blocks the default action of its parent dialog. More...
 
ResourceManager clan::GUIComponent::get_resources () const
 Returns the resource manager for the GUI resources. More...
 
GUIManager clan::GUIComponent::get_gui_manager () const
 Returns the GUI manager owning this component. More...
 
const GUIComponent * clan::GUIComponent::get_parent_component () const
 Returns the parent component. More...
 
GUIComponent * clan::GUIComponent::get_parent_component ()
 Get Parent component. More...
 
const GUIComponent * clan::GUIComponent::get_owner_component () const
 Return the component owning this component. More...
 
GUIComponent * clan::GUIComponent::get_owner_component ()
 Get Owner component. More...
 
std::vector< GUIComponent * > clan::GUIComponent::get_child_components () const
 Returns a list of the child components. More...
 
const GUIComponent * clan::GUIComponent::get_first_child () const
 Returns the first child component. More...
 
GUIComponent * clan::GUIComponent::get_first_child ()
 Get First child. More...
 
const GUIComponent * clan::GUIComponent::get_last_child () const
 Returns the last child component. More...
 
GUIComponent * clan::GUIComponent::get_next_component_in_tree ()
 Returns the next component in the component tree, or 'this', if none found. More...
 
GUIComponent * clan::GUIComponent::get_previous_component_in_tree ()
 Returns the previous component in the component tree, or 'this', if none found. More...
 
GUIComponent * clan::GUIComponent::get_last_child ()
 Get Last child. More...
 
std::vector< GUIComponent * > clan::GUIComponent::get_child_component_group (const std::string &group_name) const
 Returns a list of child components belonging to the specified group. More...
 
GUIComponent * clan::GUIComponent::get_group_selected_component ()
 Returns the selected item in a component group of which this component is a member. More...
 
GUIComponent * clan::GUIComponent::get_named_item (const std::string &id)
 Find child component with the specified component ID name. More...
 
bool clan::GUIComponent::has_child_components () const
 Returns true if the component has any child components. More...
 
const GUIComponent * clan::GUIComponent::get_previous_sibling () const
 Returns the previous sibling component. More...
 
GUIComponent * clan::GUIComponent::get_previous_sibling ()
 Get Previous sibling. More...
 
const GUIComponent * clan::GUIComponent::get_next_sibling () const
 Returns the next sibling component. More...
 
GUIComponent * clan::GUIComponent::get_next_sibling ()
 Get Next sibling. More...
 
bool clan::GUIComponent::is_descendant_of (GUIComponent *component)
 Checks if this component is a descendant of target component. More...
 
bool clan::GUIComponent::is_ancestor_of (GUIComponent *component)
 Checks if this component is the ancestor of target component. More...
 
const GUIComponent * clan::GUIComponent::get_top_level_component () const
 Returns the top level component this GUIComponent is a child of. More...
 
GUITopLevelWindow * clan::GUIComponent::get_top_level_window () const
 Returns the top level window this GUIComponent belongs to. More...
 
GUIComponent * clan::GUIComponent::get_top_level_component ()
 Get Top level component. More...
 
Canvas clan::GUIComponent::get_canvas () const
 Return the graphic context for the component. More...
 
InputContext clan::GUIComponent::get_ic ()
 Return the input context for the component. More...
 
bool clan::GUIComponent::is_enabled () const
 Return true if the component, and all its parents are enabled. More...
 
bool clan::GUIComponent::is_visible () const
 Return true if the component, and all its parents are visible. More...
 
bool clan::GUIComponent::is_active () const
 Returns true if the component is active. More...
 
GUIComponent * clan::GUIComponent::get_component_at (const Point &point)
 Return the component under 'point', in local viewport coordinates. More...
 
virtual float clan::GUIComponent::get_preferred_content_width ()
 Returns the preferred content width. More...
 
virtual float clan::GUIComponent::get_preferred_content_height (float width)
 Returns the preferred content height for the specified content width. More...
 
Point clan::GUIComponent::window_to_component_coords (const Point &window_point) const
 Convert the top-level window client coordinates to component coordinates. More...
 
Rect clan::GUIComponent::window_to_component_coords (const Rect &window_rect) const
 Convert the top-level window client coordinates to component coordinates. More...
 
Point clan::GUIComponent::component_to_window_coords (const Point &component_point) const
 Convert the component coordinates to top-level window client coordinates. More...
 
Rect clan::GUIComponent::component_to_window_coords (const Rect &component_rect) const
 Convert the component coordinates to top-level window client coordinates. More...
 
Point clan::GUIComponent::screen_to_component_coords (const Point &screen_point) const
 Convert the screen coordinates to component coordinates. More...
 
Point clan::GUIComponent::component_to_screen_coords (const Point &component_point) const
 Convert the component coordinates to screen coordinates. More...
 
GUILayout clan::GUIComponent::get_layout () const
 Returns the layout manager set for this component. Check GUILayout.is_null() if none set. More...
 
DisplayWindow clan::GUIComponent::get_display_window () const
 Returns the display window in which this component is hosted. More...
 
bool clan::GUIComponent::is_default ()
 Returns true if this component will receive unhandled enter/return keypress messages. More...
 
bool clan::GUIComponent::is_cancel ()
 Returns true if this component will receive unhandled escape keypress messages. More...
 
bool clan::GUIComponent::is_double_click_enabled () const
 Returns true if this component will generate double click messages. More...
 
bool clan::GUIComponent::get_constant_repaint () const
 Enabled whether the GUI will constantly repaint this component when there are no other messages to process. More...
 
Font clan::GUIComponent::get_font () const
 Gets the font. More...
 
Rect clan::GUIComponent::get_render_text_box (Canvas &canvas, const std::string &str) const
 Calculates the text box using the font defined for the current state for use with render_text(). More...
 
Size clan::GUIComponent::get_render_text_size (Canvas &canvas, const std::string &str) const
 Calculates the text size using the font defined for the current state for use with render_text(). More...
 
Rect clan::GUIComponent::get_render_text_span_box (Canvas &canvas, const std::string &str, const Rect &content_rect) const
 Calculates the text size using the font defined for the current state for use with render_text_span(). More...
 
Rect clan::GUIComponent::get_content_shrink_box () const
 Returns the content shrink box of the theme part. More...
 
std::string clan::GUIComponent::get_property (const std::string &property, const std::string &default_value) const
 Returns the value of a property. More...
 
int clan::GUIComponent::get_property_int (const std::string &property, const std::string &default_value) const
 Returns the value of a property as an integer. More...
 

Events

Callback_v2< Canvas &, const
Rect & > & 
clan::GUIComponent::func_render ()
 void func_render(Canvas &canvas, const Rect &clip_rect) More...
 
Callback_v1< std::shared_ptr
< GUIMessage > & > & 
clan::GUIComponent::func_process_message ()
 void func_process_message(std::shared_ptr<GUIMessage> &message) More...
 
Callback_0< bool > & clan::GUIComponent::func_close ()
 bool func_close() More...
 
Callback_0< bool > & clan::GUIComponent::func_activated ()
 bool func_activated() More...
 
Callback_0< bool > & clan::GUIComponent::func_deactivated ()
 bool func_deactivated() More...
 
Callback_0< bool > & clan::GUIComponent::func_focus_lost ()
 bool func_focus_lost() More...
 
Callback_0< bool > & clan::GUIComponent::func_focus_gained ()
 bool func_focus_gained() More...
 
Callback_0< bool > & clan::GUIComponent::func_pointer_enter ()
 bool func_pointer_enter() More...
 
Callback_0< bool > & clan::GUIComponent::func_pointer_exit ()
 bool func_pointer_exit() More...
 
Callback_v1< std::shared_ptr
< GUIMessage > & > & 
clan::GUIComponent::func_filter_message ()
 Lets a component filter the messages intended for another component. Consumed messages will not reach the original target component. More...
 
Callback_1< bool, const
InputEvent & > & 
clan::GUIComponent::func_input ()
 bool func_input(const InputEvent &input_event) More...
 
Callback_1< bool, const
InputEvent & > & 
clan::GUIComponent::func_input_pressed ()
 bool func_input_pressed(const InputEvent &input_event) More...
 
Callback_1< bool, const
InputEvent & > & 
clan::GUIComponent::func_input_released ()
 bool func_input_released(const InputEvent &input_event) More...
 
Callback_1< bool, const
InputEvent & > & 
clan::GUIComponent::func_input_doubleclick ()
 bool func_input_doubleclick(const InputEvent &input_event) More...
 
Callback_1< bool, const
InputEvent & > & 
clan::GUIComponent::func_input_pointer_moved ()
 bool func_input_pointer_moved(const InputEvent &input_event) More...
 
Callback_v1< bool > & clan::GUIComponent::func_visibility_change ()
 bool func_visibility_change() More...
 
Signal_v0 & clan::GUIComponent::sig_style_changed ()
 void sig_style_changed() More...
 
Callback_v0 & clan::GUIComponent::func_enablemode_changed ()
 void func_enablemode_changed() More...
 
Callback_v0 & clan::GUIComponent::func_resized ()
 Callback invoked when the component is resized, i.e. when set_geometry is called. More...
 
Callback_v1< Rect & > & clan::GUIComponent::func_constrain_resize ()
 void func_constrain_resize(Rect &geometry) More...
 
virtual Callback_2
< GUIComponent *, GUIComponent
*, std::string > & 
clan::GUIComponent::func_create_custom_component ()
 Callback invoked when loading a custom component from XML. More...
 

Operations

void clan::GUIComponent::render (Canvas &canvas, const Rect &clip_rect, bool include_children=true)
 Renders the component and its children. More...
 
void clan::GUIComponent::paint ()
 Paints the component. More...
 
void clan::GUIComponent::paint (const Rect &clip_rect)
 Paint. More...
 
int clan::GUIComponent::exec ()
 Run component in modal mode. More...
 
void clan::GUIComponent::exit_with_code (int exit_code)
 Break message pump. More...
 
void clan::GUIComponent::set_geometry (Rect geometry)
 Set manual component position and size. More...
 
void clan::GUIComponent::reset_geometry ()
 Reset back to automatic layout. More...
 
void clan::GUIComponent::set_window_geometry (Rect geometry, bool client_area=false)
 Set component window position and size. More...
 
void clan::GUIComponent::set_tag_name (const std::string &name)
 Sets the CSS tag name. More...
 
bool clan::GUIComponent::set_class (const std::string &name, bool enable)
 Controls the presence of a CSS class. More...
 
void clan::GUIComponent::set_id (const std::string &name)
 Sets the CSS id. More...
 
void clan::GUIComponent::set_style (const std::string &name)
 Sets additional CSS style properties that should be applied to this element. More...
 
void clan::GUIComponent::set_style (const CSSPropertyValue &value, bool enable)
 Sets additional CSS style properties that should be applied to this element. More...
 
bool clan::GUIComponent::set_pseudo_class (const std::string &name, bool enable)
 Controls the presence of a CSS pseudo class. More...
 
void clan::GUIComponent::update_layout ()
 Re-evaluates the geometry of the component. More...
 
void clan::GUIComponent::set_enabled (bool enable=true)
 Sets the component as enabled or disabled. More...
 
void clan::GUIComponent::set_clip_children (bool clip=true, const Rect &clip_rect=Rect(0, 0, 0, 0))
 Sets the components children to be clipped to the parent component when drawn. More...
 
void clan::GUIComponent::set_visible (bool visible=true, bool activate_root_win=true)
 Sets the component as visible or hidden. More...
 
void clan::GUIComponent::set_focus (bool enable=true)
 Set this component focus. More...
 
void clan::GUIComponent::capture_mouse (bool capture)
 Make all mouse messages be redirected to this component. More...
 
void clan::GUIComponent::capture_proximity (bool capture)
 Make tablet proximity messages be redirected to this component. More...
 
void clan::GUIComponent::set_focus_policy (FocusPolicy policy)
 Sets the focus policy of the component. More...
 
void clan::GUIComponent::set_double_click_enabled (bool enable)
 Modifies whether this component will generate double click messages or not. More...
 
void clan::GUIComponent::set_component_group_name (const std::string &str)
 Set group name. More...
 
void clan::GUIComponent::set_selected_in_component_group (bool selected)
 Set to true if this component is the selected item in a group of components where FocusPolicy is focus_group. More...
 
void clan::GUIComponent::create_components (const DomDocument &gui_xml)
 Create child components from a GUI definition file. More...
 
void clan::GUIComponent::create_components (const std::string &fullname)
 Create components. More...
 
void clan::GUIComponent::create_components (IODevice &file)
 Create components. More...
 
void clan::GUIComponent::create_components (const std::string &filename, const FileSystem &fs)
 Create components. More...
 
void clan::GUIComponent::request_repaint ()
 
void clan::GUIComponent::request_repaint (Rect rect)
 Request repaint. More...
 
void clan::GUIComponent::set_cliprect (Canvas &canvas, const Rect &rect)
 Set a clipping rectangle. More...
 
void clan::GUIComponent::reset_cliprect (Canvas &canvas)
 Reset the clipping rectangle. More...
 
void clan::GUIComponent::push_cliprect (Canvas &canvas, const Rect &rect)
 Push a clipping rectangle. More...
 
void clan::GUIComponent::pop_cliprect (Canvas &canvas)
 Pop a clipping rectangle. More...
 
void clan::GUIComponent::delete_child_components ()
 Deletes all child components. More...
 
void clan::GUIComponent::set_parent_component (GUIComponent *new_parent)
 Makes this component a child of the given component, removing it from the previous parent. More...
 
void clan::GUIComponent::set_layout (GUILayout &layout)
 Set a layout on the component. More...
 
void clan::GUIComponent::set_cursor (const Cursor &cursor)
 Sets the current cursor icon. More...
 
void clan::GUIComponent::set_cursor (enum StandardCursor type)
 Set cursor. More...
 
void clan::GUIComponent::focus_next ()
 Set focus to the next component in tab order. More...
 
void clan::GUIComponent::focus_previous ()
 Set focus to the previous component in tab order. More...
 
void clan::GUIComponent::set_default (bool value)
 When set to true, this component will receive unhandled enter/return keypress messages. More...
 
void clan::GUIComponent::set_cancel (bool value)
 When set to true, this component will receive unhandled escape keypress messages. More...
 
void clan::GUIComponent::set_blocks_default_action (bool block)
 Set to true if this component, when focused, blocks the default action of the parent dialog. More...
 
void clan::GUIComponent::set_constant_repaint (bool enable)
 Enabled whether the GUI will constantly repaint this component when there are no other messages to process. More...
 
Rect clan::GUIComponent::render_text_span (Canvas &canvas, const std::string &text, const Rect &content_rect)
 
Rect clan::GUIComponent::render_text (Canvas &canvas, const std::string &text)
 
Rect clan::GUIComponent::render_text (Canvas &canvas, const std::string &text, int xpos, int baseline)
 
VerticalTextPosition clan::GUIComponent::get_vertical_text_align (Canvas &canvas)
 Calculates the vertical text position for the current font using the component content box. More...
 
VerticalTextPosition clan::GUIComponent::get_vertical_text_align (Canvas &canvas, const Rect &rect)
 Calculates the vertical text position for the current font. More...
 

Implementation

std::unique_ptr
< GUIComponent_Impl > 
clan::GUIComponent::impl
 

Construction

 clan::GUILayout::GUILayout ()
 Constructs a null layout. More...
 
 clan::GUILayout::GUILayout (GUILayoutProvider *provider)
 Constructs a layout. More...
 
 clan::GUILayout::~GUILayout ()
 

Attributes

bool clan::GUILayout::is_null () const
 Is Null. More...
 
GUILayoutProvider * clan::GUILayout::get_provider () const
 Retrieves the provider. More...
 
Size clan::GUILayout::get_css_size () const
 Returns the size of the dialog, as set in the editor. More...
 

Operations

void clan::GUILayout::set_geometry (const Rect &pos)
 Set geometry. More...
 
void clan::GUILayout::set_preferred_size (const Size &size)
 Set preferred size. More...
 

Construction

 clan::GUILayoutCorners::GUILayoutCorners ()
 
virtual clan::GUILayoutCorners::~GUILayoutCorners ()
 

Attributes

GUILayoutProvider_Corners * clan::GUILayoutCorners::get_provider () const
 Retrieves the provider. More...
 

Operations

void clan::GUILayoutCorners::add_component (GUIComponent *component, ComponentAnchorPoint ap_tl, int dist_tl_x, int dist_tl_y, ComponentAnchorPoint ap_br, int dist_br_x, int dist_br_y)
 
void clan::GUILayoutCorners::remove_component (GUIComponent *component)
 Remove component. More...
 

Construction

 clan::GUIManager::GUIManager ()
 Constructs a gui manager with a system window manager. More...
 
 clan::GUIManager::GUIManager (const DisplayWindow &display_window)
 Constructs a gui manager with a texture window manager. More...
 
 clan::GUIManager::GUIManager (const std::string &path_to_css_and_resources)
 Fully constructs a gui manager with a system window manager, a css theme and resources. More...
 
 clan::GUIManager::GUIManager (const DisplayWindow &display_window, const std::string &path_to_css_and_resources)
 Fully constructs a gui manager with a texture window manager, a css theme and resources. More...
 
 clan::GUIManager::GUIManager (GUIWindowManager &window_manager, const std::string &path_to_css_and_resources)
 Fully constructs a gui manager with a custom window manager, a css theme and resources. More...
 
 clan::GUIManager::GUIManager (std::shared_ptr< GUIManager_Impl > impl)
 Constructs a GUIManager. More...
 
virtual clan::GUIManager::~GUIManager ()
 

Attributes

ResourceManager clan::GUIManager::get_resource_manager () const
 Returns the resource manager. More...
 
CSSDocument clan::GUIManager::get_css_document () const
 Returns the CSS document being used. More...
 
GUIWindowManager clan::GUIManager::get_window_manager () const
 Returns the windows manager being used. More...
 
GUIComponent * clan::GUIManager::get_capture_component () const
 Returns the mouse capture component. More...
 
GUIComponent * clan::GUIManager::get_focused_component ()
 Returns the currently focused component. More...
 
bool clan::GUIManager::get_exit_flag () const
 Returns if a dialog message pump loop should exit. More...
 
int clan::GUIManager::get_exit_code () const
 Returns the dialog exit code. More...
 
std::string clan::GUIManager::get_clipboard_text () const
 Get Clipboard text. More...
 

Events

Signal_v1< std::shared_ptr
< GUIMessage > & > & 
clan::GUIManager::sig_filter_message ()
 bool func_filter_message(std::shared_ptr<GUIMessage> &message) More...
 
Callback_0< int > & clan::GUIManager::func_exec_handler ()
 int func_exec_handler() More...
 

Operations

void clan::GUIManager::set_resource_manager (ResourceManager &resource_manager)
 Set the resource manager (other than the default one) More...
 
void clan::GUIManager::add_theme (const std::string &fullname)
 Adds a GUI theme. More...
 
void clan::GUIManager::add_theme (const std::string &fullname, const FileSystem &fs)
 Adds a GUI theme. More...
 
void clan::GUIManager::set_theme (CSSDocument css)
 Sets the GUI theme. More...
 
void clan::GUIManager::set_theme (const std::string &fullname)
 Sets the GUI theme. More...
 
void clan::GUIManager::set_theme (const std::string &filename, const FileSystem &fs)
 Set the GUI theme. More...
 
void clan::GUIManager::add_resources (const XMLResourceDocument &resources)
 Adds resources to the GUI resource manager. More...
 
void clan::GUIManager::add_resources (const std::string &filename)
 Adds additional resources to the GUI resource manager, by creating a XMLResourceDocument from file automatically. More...
 
void clan::GUIManager::add_resources (const std::string &filename, const FileSystem &fs)
 Adds additional resources to the GUI resource manager. More...
 
void clan::GUIManager::set_window_manager (GUIWindowManager &window_manager)
 Sets the windows manager. More...
 
int clan::GUIManager::exec ()
 Processes messages until exit_with_code is called. More...
 
void clan::GUIManager::process_messages (int timeout)
 Processes all messages available. More...
 
void clan::GUIManager::dispatch_message (std::shared_ptr< GUIMessage > message)
 Sends a GUI message to the message handler target for the message. More...
 
void clan::GUIManager::exit_with_code (int exit_code)
 Breaks the message loop. More...
 
void clan::GUIManager::clear_exit_flag ()
 Clears the flag indicating exec() should exit its message pump loop. More...
 
void clan::GUIManager::set_capture_component (GUIComponent *component, bool state)
 Set the mouse capture component. More...
 
void clan::GUIManager::request_repaint (const Rect &rect, GUIComponent *root_component)
 Mark the specified area to be redrawn. More...
 
void clan::GUIManager::render_windows ()
 Render windows. More...
 
void clan::GUIManager::set_clipboard_text (const std::string &str)
 Set clipboard text. More...
 
void clan::GUIManager::set_tablet_proximity_component (GUIComponent *, bool state)
 Redirect proximity events from tablet to the specified component. More...
 
void clan::GUIManager::set_accelerator_table (const AcceleratorTable &table)
 Set the accelerator table. More...
 

Implementation

class clan::GUIManager::GUIComponent_Impl
 

Construction

 clan::GUIMessage::GUIMessage ()
 Constructs a GUI message. More...
 
virtual clan::GUIMessage::~GUIMessage ()
 

Attributes

GUIComponent * clan::GUIMessage::target
 The target destination of the message. More...
 
bool clan::GUIMessage::consumed
 Indicates whether the message has been consumed yet. More...
 

Construction

enum  clan::GUIMessage_ActivationChange::ActivationType { clan::GUIMessage_ActivationChange::activation_lost, clan::GUIMessage_ActivationChange::activation_gained }
 
 clan::GUIMessage_ActivationChange::GUIMessage_ActivationChange ()
 Constructs an input GUI message. More...
 
 clan::GUIMessage_ActivationChange::GUIMessage_ActivationChange (ActivationType type)
 

Attributes

ActivationType clan::GUIMessage_ActivationChange::activation_type
 Retrieves the focus type of this message. More...
 

Construction

 clan::GUIMessage_Close::GUIMessage_Close ()
 Constructs a window close GUI message. More...
 

Construction

enum  clan::GUIMessage_FocusChange::FocusType { clan::GUIMessage_FocusChange::losing_focus, clan::GUIMessage_FocusChange::gained_focus }
 
 clan::GUIMessage_FocusChange::GUIMessage_FocusChange ()
 Constructs an focus change GUI message. More...
 
 clan::GUIMessage_FocusChange::GUIMessage_FocusChange (FocusType type)
 

Attributes

FocusType clan::GUIMessage_FocusChange::focus_type
 The focus type of this message. More...
 

Construction

 clan::GUIMessage_Input::GUIMessage_Input ()
 Constructs an input GUI message. More...
 
 clan::GUIMessage_Input::GUIMessage_Input (InputEvent &e)
 

Attributes

InputEvent clan::GUIMessage_Input::input_event
 Input event for this message. More...
 

Construction

enum  clan::GUIMessage_Pointer::PointerType { clan::GUIMessage_Pointer::pointer_enter, clan::GUIMessage_Pointer::pointer_leave }
 
 clan::GUIMessage_Pointer::GUIMessage_Pointer ()
 Constructs an input GUI message. More...
 
 clan::GUIMessage_Pointer::GUIMessage_Pointer (PointerType type)
 

Attributes

PointerType clan::GUIMessage_Pointer::pointer_type
 Retrieves the pointer type of this message. More...
 

Construction

 clan::GUIMessage_Resize::GUIMessage_Resize ()
 Constructs an input GUI message. More...
 
 clan::GUIMessage_Resize::GUIMessage_Resize (const Rect &box)
 

Attributes

Rect clan::GUIMessage_Resize::geometry
 The geometry contained in this message. More...
 

Construction

 clan::GUIThemePart::GUIThemePart ()
 Constructs a null instance. More...
 
 clan::GUIThemePart::GUIThemePart (GUIComponent *parent, const std::string &tag_name)
 Creates a GUI component. More...
 

Attributes

bool clan::GUIThemePart::is_null () const
 Returns true if this object is invalid. More...
 
void clan::GUIThemePart::throw_if_null () const
 Throw an exception if this object is invalid. More...
 
const CSSComputedValues & clan::GUIThemePart::get_css_values () const
 Returns the standard W3C CSS properties active for this component. More...
 
Font clan::GUIThemePart::get_font () const
 Gets the font. More...
 
std::string clan::GUIThemePart::get_tag_name () const
 Returns the CSS tag name. More...
 
std::string clan::GUIThemePart::get_id () const
 Returns the CSS id attribute. More...
 
bool clan::GUIThemePart::get_class (const std::string &name) const
 Returns whether a CSS class is present or not. More...
 
std::vector< std::string > clan::GUIThemePart::get_classes () const
 Returns all classes currently present. More...
 
bool clan::GUIThemePart::get_pseudo_class (const std::string &name) const
 Returns whether a CSS pseudo class is present or not. More...
 
std::vector< std::string > clan::GUIThemePart::get_pseudo_classes () const
 Returns all pseudo classes currently present. More...
 
Size clan::GUIThemePart::get_css_size () const
 Returns the css size of a render box. More...
 
int clan::GUIThemePart::get_css_width () const
 Returns the css width of a render box. More...
 
int clan::GUIThemePart::get_css_height () const
 Returns the css height of a render box. More...
 
Rect clan::GUIThemePart::get_render_text_span_box (Canvas &canvas, const std::string &str, const Rect &content_rect) const
 Calculates the text size using the font defined for the current state for use with render_text_span() More...
 
Rect clan::GUIThemePart::get_render_text_box (Canvas &canvas, const std::string &str, const Rect &content_rect) const
 Calculates the text box using the font defined for the current state for use with render_text() More...
 
Size clan::GUIThemePart::get_render_text_size (Canvas &canvas, const std::string &str) const
 Calculates the text size using the font defined for the current state for use with render_text() More...
 
Rect clan::GUIThemePart::get_content_box (const Rect &render_box_rect) const
 Returns the position of the content box for a given render box. More...
 
Rect clan::GUIThemePart::get_content_shrink_box () const
 Returns the content shrink box of the theme part. More...
 
Rect clan::GUIThemePart::get_border_box (const Rect &content_box_rect) const
 Returns the position and size of a border box for a given content box. More...
 
std::string clan::GUIThemePart::get_property (const std::string &property, const std::string &default_value) const
 Returns the value of a property. More...
 
int clan::GUIThemePart::get_property_int (const std::string &property, const std::string &default_value) const
 Returns the value of a property as an integer. More...
 

Operations

void clan::GUIThemePart::render_box (Canvas &canvas, const Rect &border_box)
 Renders the component and its children. More...
 
void clan::GUIThemePart::set_tag_name (const std::string &name)
 Sets the CSS tag name. More...
 
bool clan::GUIThemePart::set_class (const std::string &name, bool enable)
 Controls the presence of a CSS class. More...
 
void clan::GUIThemePart::set_id (const std::string &name)
 Sets the CSS id. More...
 
void clan::GUIThemePart::set_style (const std::string &name)
 Sets additional CSS style properties that should be applied to this element. More...
 
void clan::GUIThemePart::set_style (const CSSPropertyValue &value, bool enable)
 Sets additional CSS style properties that should be applied to this element. More...
 
bool clan::GUIThemePart::set_pseudo_class (const std::string &name, bool enable)
 Controls the presence of a CSS pseudo class. More...
 
Rect clan::GUIThemePart::render_text_span (Canvas &canvas, const std::string &text, const Rect &content_rect)
 
Rect clan::GUIThemePart::render_text (Canvas &canvas, const std::string &text, const Rect &content_box)
 
Rect clan::GUIThemePart::render_text (Canvas &canvas, const std::string &text, const Rect &content_box, int baseline)
 
VerticalTextPosition clan::GUIThemePart::get_vertical_text_align (Canvas &canvas, const Rect &content_rect)
 Calculates the vertical text position for the current font. More...
 

Implementation

std::shared_ptr
< GUIThemePart_Impl > 
clan::GUIThemePart::impl
 

Attributes

Callback_v1< GUITopLevelWindow * > * clan::GUIWindowManagerSite::func_focus_lost
 Pointer to focus lost notification callback function. More...
 
Callback_v1< GUITopLevelWindow * > * clan::GUIWindowManagerSite::func_focus_gained
 Pointer to focus gained notification callback function. More...
 
Callback_v2< GUITopLevelWindow
*, const Size & > * 
clan::GUIWindowManagerSite::func_resize
 Pointer to focus gained notification callback function. More...
 
Callback_v2< GUITopLevelWindow
*, const Rect & > * 
clan::GUIWindowManagerSite::func_paint
 Pointer to paint notification callback function. More...
 
Callback_v1< GUITopLevelWindow * > * clan::GUIWindowManagerSite::func_close
 Pointer to close notification callback function. More...
 
Callback_v1< GUITopLevelWindow * > * clan::GUIWindowManagerSite::func_destroy
 Pointer to destroy notification callback function. More...
 
Callback_v2< GUITopLevelWindow
*, const InputEvent & > * 
clan::GUIWindowManagerSite::func_input_received
 Pointer to close notification callback function. More...
 

Enumerations

enum  clan::GUIWindowManager::WindowManagerType { clan::GUIWindowManager::cl_wm_type_system, clan::GUIWindowManager::cl_wm_type_texture }
 

Construction

 clan::GUIWindowManager::GUIWindowManager ()
 Constructs a null instance. More...
 
 clan::GUIWindowManager::GUIWindowManager (GUIWindowManagerProvider *provider)
 Constructs a window manager. More...
 
 clan::GUIWindowManager::GUIWindowManager (const GUIWindowManager &src)
 Duplicates the reference to a window manager. More...
 
 clan::GUIWindowManager::~GUIWindowManager ()
 

Attributes

bool clan::GUIWindowManager::is_null () const
 Is Null. More...
 
GUIWindowManagerProvider * clan::GUIWindowManager::get_provider () const
 Retrieves the provider. More...
 
WindowManagerType clan::GUIWindowManager::get_window_manager_type () const
 Get Window manager type. More...
 

Operations

void clan::GUIWindowManager::set_site (GUIWindowManagerSite *site)
 Set site. More...
 
void clan::GUIWindowManager::create_window (GUITopLevelWindow *handle, GUITopLevelWindow *owner, GUIComponent *component, GUITopLevelDescription description)
 
void clan::GUIWindowManager::destroy_window (GUITopLevelWindow *handle)
 Destroy window. More...
 
void clan::GUIWindowManager::enable_window (GUITopLevelWindow *handle, bool enable)
 Enable window. More...
 
bool clan::GUIWindowManager::has_focus (GUITopLevelWindow *handle) const
 Has focus. More...
 
void clan::GUIWindowManager::set_visible (GUITopLevelWindow *handle, bool visible, bool activate_root_win)
 Set visible. More...
 
void clan::GUIWindowManager::set_geometry (GUITopLevelWindow *handle, const Rect &geometry, bool client_area)
 Set geometry. More...
 
Rect clan::GUIWindowManager::get_geometry (GUITopLevelWindow *handle, bool client_area) const
 Get geometry. More...
 
Point clan::GUIWindowManager::screen_to_window (GUITopLevelWindow *handle, const Point &screen_point, bool client_area) const
 Screen to window. More...
 
Point clan::GUIWindowManager::window_to_screen (GUITopLevelWindow *handle, const Point &window_point, bool client_area) const
 Window to screen. More...
 
Canvas & clan::GUIWindowManager::get_canvas (GUITopLevelWindow *handle) const
 Get canvas. More...
 
InputContext clan::GUIWindowManager::get_ic (GUITopLevelWindow *handle) const
 Get ic. More...
 
Canvas clan::GUIWindowManager::begin_paint (GUITopLevelWindow *handle, const Rect &update_region)
 Begin paint. More...
 
void clan::GUIWindowManager::set_cliprect (GUITopLevelWindow *handle, Canvas &canvas, const Rect &rect)
 Set cliprect. More...
 
void clan::GUIWindowManager::reset_cliprect (GUITopLevelWindow *handle, Canvas &canvas)
 Reset cliprect. More...
 
void clan::GUIWindowManager::push_cliprect (GUITopLevelWindow *handle, Canvas &canvas, const Rect &rect)
 Push cliprect. More...
 
void clan::GUIWindowManager::pop_cliprect (GUITopLevelWindow *handle, Canvas &canvas)
 Pop cliprect. More...
 
void clan::GUIWindowManager::end_paint (Canvas &canvas, GUITopLevelWindow *handle, const Rect &update_region)
 End paint. More...
 
void clan::GUIWindowManager::request_repaint (GUITopLevelWindow *handle, const Rect &update_region)
 Request repaint. More...
 
void clan::GUIWindowManager::bring_to_front (GUITopLevelWindow *handle)
 Bring to front. More...
 
bool clan::GUIWindowManager::is_minimized (GUITopLevelWindow *handle) const
 Is minimized. More...
 
bool clan::GUIWindowManager::is_maximized (GUITopLevelWindow *handle) const
 Is maximized. More...
 
void clan::GUIWindowManager::process_message ()
 Process message. More...
 
void clan::GUIWindowManager::capture_mouse (GUITopLevelWindow *handle, bool state)
 Capture mouse. More...
 
DisplayWindow clan::GUIWindowManager::get_display_window (GUITopLevelWindow *handle) const
 Get display window. More...
 
void clan::GUIWindowManager::set_cursor (GUITopLevelWindow *handle, const Cursor &cursor)
 Set cursor. More...
 
void clan::GUIWindowManager::set_cursor (GUITopLevelWindow *handle, enum StandardCursor type)
 Set cursor. More...
 
void clan::GUIWindowManager::update ()
 Perform any updates. More...
 

Construction

 clan::GUIWindowManagerDirect::GUIWindowManagerDirect ()
 Constructs a null instance. More...
 
 clan::GUIWindowManagerDirect::GUIWindowManagerDirect (DisplayWindow &display_window, Canvas &canvas)
 Constructs a GUIWindowManagerDirect. More...
 
 clan::GUIWindowManagerDirect::GUIWindowManagerDirect (const GUIWindowManager &wm)
 
 clan::GUIWindowManagerDirect::~GUIWindowManagerDirect ()
 

Attributes

GUIWindowManagerProvider_Direct * clan::GUIWindowManagerDirect::get_provider () const
 Retrieves the provider. More...
 

Events

Callback_v1< InputEvent & > & clan::GUIWindowManagerDirect::func_input_intercept ()
 void func_input_intercept(InputEvent &input_event) More...
 

Construction

 clan::GUIWindowManagerSystem::GUIWindowManagerSystem ()
 
 clan::GUIWindowManagerSystem::~GUIWindowManagerSystem ()
 

Attributes

GUIWindowManagerProvider_System * clan::GUIWindowManagerSystem::get_provider () const
 Retrieves the provider. More...
 

Events

Signal_v1< DisplayWindow > & clan::GUIWindowManagerSystem::sig_toplevel_window_created ()
 
Signal_v1< DisplayWindow > & clan::GUIWindowManagerSystem::sig_toplevel_window_destroyed ()
 

Construction

 clan::GUIWindowManagerTexture::GUIWindowManagerTexture ()
 Constructs a null instance. More...
 
 clan::GUIWindowManagerTexture::GUIWindowManagerTexture (DisplayWindow display_window)
 Constructs a GUIWindowManagerTexture. More...
 
 clan::GUIWindowManagerTexture::GUIWindowManagerTexture (const GUIWindowManager &wm)
 
 clan::GUIWindowManagerTexture::~GUIWindowManagerTexture ()
 

Attributes

GUIWindowManagerProvider_Texture * clan::GUIWindowManagerTexture::get_provider () const
 Retrieves the provider. More...
 
std::vector
< GUIWindowManagerTextureWindow > 
clan::GUIWindowManagerTexture::get_windows (bool only_visible=true) const
 Get the window textures. More...
 

Events

Callback_v0 & clan::GUIWindowManagerTexture::func_repaint ()
 void func_repaint() More...
 
Callback_v1< FrameBuffer & > & clan::GUIWindowManagerTexture::func_setup_framebuffer ()
 void func_setup_framebuffer(FrameBuffer &fb) More...
 
Callback_v1< InputEvent & > & clan::GUIWindowManagerTexture::func_input_intercept ()
 void func_input_intercept(InputEvent &input_event) More...
 

Operations

void clan::GUIWindowManagerTexture::set_texture_group (TextureGroup &new_texture_group)
 Set texture group. More...
 
void clan::GUIWindowManagerTexture::draw_windows (Canvas &canvas)
 Draw the windows. More...
 
void clan::GUIWindowManagerTexture::process ()
 Process the windows. More...
 

Construction

 clan::GUIWindowManagerTextureWindow::GUIWindowManagerTextureWindow ()
 
 clan::GUIWindowManagerTextureWindow::GUIWindowManagerTextureWindow (GUITopLevelWindow *window, const Subtexture &sub_texture, const Rect &geometry)
 Constructs a GUIWindowManagerTextureWindow. More...
 
 clan::GUIWindowManagerTextureWindow::~GUIWindowManagerTextureWindow ()
 

Attributes

Subtexture clan::GUIWindowManagerTextureWindow::get_texture () const
 Get Texture. More...
 
Rect clan::GUIWindowManagerTextureWindow::get_geometry () const
 Get Geometry. More...
 
GUITopLevelWindow * clan::GUIWindowManagerTextureWindow::get_window () const
 Get Window. More...
 
GUIComponent * clan::GUIWindowManagerTextureWindow::get_toplevel_component () const
 Get Toplevel component. More...
 

Construction

virtual clan::GUILayoutProvider::~GUILayoutProvider ()
 

Attributes

virtual Size clan::GUILayoutProvider::get_css_size () const =0
 Returns the size of the dialog, as set in the editor. More...
 

Operations

virtual void clan::GUILayoutProvider::set_geometry (const Rect &pos)=0
 Set geometry. More...
 
virtual void clan::GUILayoutProvider::set_preferred_size (const Size &size)=0
 Set preferred size. More...
 

Construction

virtual clan::GUIWindowManagerProvider::~GUIWindowManagerProvider ()
 

Attributes

virtual
GUIWindowManager::WindowManagerType 
clan::GUIWindowManagerProvider::get_window_manager_type () const =0
 

Operations

virtual void clan::GUIWindowManagerProvider::set_site (GUIWindowManagerSite *site)=0
 Set site. More...
 
virtual void clan::GUIWindowManagerProvider::create_window (GUITopLevelWindow *handle, GUITopLevelWindow *owner, GUIComponent *component, GUITopLevelDescription description)=0
 
virtual void clan::GUIWindowManagerProvider::destroy_window (GUITopLevelWindow *handle)=0
 Destroy window. More...
 
virtual void clan::GUIWindowManagerProvider::enable_window (GUITopLevelWindow *handle, bool enable)=0
 Enable window. More...
 
virtual bool clan::GUIWindowManagerProvider::has_focus (GUITopLevelWindow *handle) const =0
 Has focus. More...
 
virtual void clan::GUIWindowManagerProvider::set_visible (GUITopLevelWindow *handle, bool visible, bool activate_root_win)=0
 Set visible. More...
 
virtual void clan::GUIWindowManagerProvider::set_geometry (GUITopLevelWindow *handle, const Rect &geometry, bool client_area)=0
 Set geometry. More...
 
virtual Rect clan::GUIWindowManagerProvider::get_geometry (GUITopLevelWindow *handle, bool client_area) const =0
 Get geometry. More...
 
virtual Point clan::GUIWindowManagerProvider::screen_to_window (GUITopLevelWindow *handle, const Point &screen_point, bool client_area) const =0
 Screen to window. More...
 
virtual Point clan::GUIWindowManagerProvider::window_to_screen (GUITopLevelWindow *handle, const Point &window_point, bool client_area) const =0
 Window to screen. More...
 
virtual Canvas & clan::GUIWindowManagerProvider::get_canvas (GUITopLevelWindow *handle)=0
 Get canvas. More...
 
virtual InputContext clan::GUIWindowManagerProvider::get_ic (GUITopLevelWindow *handle) const =0
 Get ic. More...
 
virtual Canvas clan::GUIWindowManagerProvider::begin_paint (GUITopLevelWindow *handle, const Rect &update_region)=0
 Begin paint. More...
 
virtual void clan::GUIWindowManagerProvider::set_cliprect (GUITopLevelWindow *handle, Canvas &canvas, const Rect &rect)=0
 Set cliprect. More...
 
virtual void clan::GUIWindowManagerProvider::reset_cliprect (GUITopLevelWindow *handle, Canvas &canvas)=0
 Reset cliprect. More...
 
virtual void clan::GUIWindowManagerProvider::push_cliprect (GUITopLevelWindow *handle, Canvas &canvas, const Rect &rect)=0
 Push cliprect. More...
 
virtual void clan::GUIWindowManagerProvider::pop_cliprect (GUITopLevelWindow *handle, Canvas &canvas)=0
 Push cliprect. More...
 
virtual void clan::GUIWindowManagerProvider::end_paint (Canvas &canvas, GUITopLevelWindow *handle, const Rect &update_region)=0
 End paint. More...
 
virtual void clan::GUIWindowManagerProvider::request_repaint (GUITopLevelWindow *handle, const Rect &update_region)=0
 Request repaint. More...
 
virtual void clan::GUIWindowManagerProvider::bring_to_front (GUITopLevelWindow *handle)=0
 Bring to front. More...
 
virtual bool clan::GUIWindowManagerProvider::is_minimized (GUITopLevelWindow *handle) const =0
 Is minimized. More...
 
virtual bool clan::GUIWindowManagerProvider::is_maximized (GUITopLevelWindow *handle) const =0
 Is maximized. More...
 
virtual void clan::GUIWindowManagerProvider::capture_mouse (GUITopLevelWindow *handle, bool state)=0
 Capture mouse. More...
 
virtual DisplayWindow clan::GUIWindowManagerProvider::get_display_window (GUITopLevelWindow *handle) const =0
 Get display window. More...
 
virtual void clan::GUIWindowManagerProvider::set_cursor (GUITopLevelWindow *handle, const Cursor &cursor)=0
 Set cursor. More...
 
virtual void clan::GUIWindowManagerProvider::set_cursor (GUITopLevelWindow *handle, enum StandardCursor type)=0
 Set cursor. More...
 
virtual void clan::GUIWindowManagerProvider::update ()=0
 Perform any updates. More...
 

Construction

 clan::SetupGUI::SetupGUI ()
 Initializes clanGUI. More...
 
 clan::SetupGUI::~SetupGUI ()
 

Detailed Description

Typedef Documentation

typedef DisplayWindowDescription clan::GUITopLevelDescription

Enumeration Type Documentation

Enumerator
activation_lost 
activation_gained 

Component Anchor Point.

Enumerator
anchor_top_left 
anchor_top_right 
anchor_bottom_left 
anchor_bottom_right 
anchor_relative 

Focus policies.

Enumerator
focus_refuse 
focus_local 
focus_group 
focus_parent 
Enumerator
losing_focus 
gained_focus 
Enumerator
pointer_enter 
pointer_leave 
Enumerator
cl_wm_type_system 
cl_wm_type_texture 

Function Documentation

clan::AcceleratorKey::AcceleratorKey ( )

Constructs a null instance.

clan::AcceleratorKey::AcceleratorKey ( int  id,
int  mod1 = -1,
int  mod2 = -1,
int  mod3 = -1 
)

Constructs a AcceleratorKey.

Parameters
id= value
mod1= value
mod2= value
mod3= value
clan::AcceleratorTable::AcceleratorTable ( )
clan::GUIComponent::GUIComponent ( GUIComponent parent,
const std::string &  tag_name = "component" 
)

Creates a GUI component.

Referenced by clan::RolloutList::add_rollout().

clan::GUIComponent::GUIComponent ( GUIManager manager,
const GUITopLevelDescription description,
const std::string &  tag_name = "window" 
)

Constructs a GUIComponent.

Parameters
manager= GUIManager
description= GUITop Level Description
clan::GUIComponent::GUIComponent ( GUIComponent owner,
const GUITopLevelDescription description,
const std::string &  tag_name = "window" 
)

Constructs a GUIComponent.

Parameters
owner= GUIComponent
description= GUITop Level Description
clan::GUILayout::GUILayout ( )

Constructs a null layout.

clan::GUILayout::GUILayout ( GUILayoutProvider provider)

Constructs a layout.

Parameters
provider= The layout provider
clan::GUILayoutCorners::GUILayoutCorners ( )
clan::GUIManager::GUIManager ( )

Constructs a gui manager with a system window manager.

Remember to add a theme using set_theme() or add_theme().

clan::GUIManager::GUIManager ( const DisplayWindow display_window)

Constructs a gui manager with a texture window manager.

Remember to add a theme using set_theme() or add_theme().

Parameters
display_window= display window to attach gui to.
clan::GUIManager::GUIManager ( const std::string &  path_to_css_and_resources)

Fully constructs a gui manager with a system window manager, a css theme and resources.

Parameters
path_to_css_and_resources= Path to directory. It has to contain resources.xml and theme.css.
clan::GUIManager::GUIManager ( const DisplayWindow display_window,
const std::string &  path_to_css_and_resources 
)

Fully constructs a gui manager with a texture window manager, a css theme and resources.

Parameters
display_window= display window to attach gui to.
path_to_css_and_resources= Path to directory. It has to contain resources.xml and theme.css.
clan::GUIManager::GUIManager ( GUIWindowManager window_manager,
const std::string &  path_to_css_and_resources 
)

Fully constructs a gui manager with a custom window manager, a css theme and resources.

Parameters
window_manager= Window manager
path_to_css_and_resources= Path to directory. It has to contain resources.xml and theme.css.
clan::GUIManager::GUIManager ( std::shared_ptr< GUIManager_Impl >  impl)

Constructs a GUIManager.

Parameters
impl= Shared Ptr
clan::GUIMessage::GUIMessage ( )
inline

Constructs a GUI message.

clan::GUIMessage_ActivationChange::GUIMessage_ActivationChange ( )
inline

Constructs an input GUI message.

clan::GUIMessage_ActivationChange::GUIMessage_ActivationChange ( ActivationType  type)
inline
clan::GUIMessage_Close::GUIMessage_Close ( )
inline

Constructs a window close GUI message.

clan::GUIMessage_FocusChange::GUIMessage_FocusChange ( )
inline

Constructs an focus change GUI message.

clan::GUIMessage_FocusChange::GUIMessage_FocusChange ( FocusType  type)
inline
clan::GUIMessage_Input::GUIMessage_Input ( )
inline

Constructs an input GUI message.

clan::GUIMessage_Input::GUIMessage_Input ( InputEvent e)
inline
clan::GUIMessage_Pointer::GUIMessage_Pointer ( )
inline

Constructs an input GUI message.

clan::GUIMessage_Pointer::GUIMessage_Pointer ( PointerType  type)
inline
clan::GUIMessage_Resize::GUIMessage_Resize ( )
inline

Constructs an input GUI message.

clan::GUIMessage_Resize::GUIMessage_Resize ( const Rect box)
inline
clan::GUIThemePart::GUIThemePart ( )

Constructs a null instance.

clan::GUIThemePart::GUIThemePart ( GUIComponent parent,
const std::string &  tag_name 
)

Creates a GUI component.

clan::GUIWindowManager::GUIWindowManager ( )

Constructs a null instance.

clan::GUIWindowManager::GUIWindowManager ( GUIWindowManagerProvider provider)

Constructs a window manager.

Parameters
provider= The theme provider
clan::GUIWindowManager::GUIWindowManager ( const GUIWindowManager src)

Duplicates the reference to a window manager.

clan::GUIWindowManagerDirect::GUIWindowManagerDirect ( )

Constructs a null instance.

clan::GUIWindowManagerDirect::GUIWindowManagerDirect ( DisplayWindow display_window,
Canvas canvas 
)

Constructs a GUIWindowManagerDirect.

Parameters
display_window= display window
canvas= canvas
clan::GUIWindowManagerDirect::GUIWindowManagerDirect ( const GUIWindowManager wm)
clan::GUIWindowManagerSystem::GUIWindowManagerSystem ( )
clan::GUIWindowManagerTexture::GUIWindowManagerTexture ( )

Constructs a null instance.

clan::GUIWindowManagerTexture::GUIWindowManagerTexture ( DisplayWindow  display_window)

Constructs a GUIWindowManagerTexture.

Parameters
display_window= Display Window
clan::GUIWindowManagerTexture::GUIWindowManagerTexture ( const GUIWindowManager wm)
clan::GUIWindowManagerTextureWindow::GUIWindowManagerTextureWindow ( )
clan::GUIWindowManagerTextureWindow::GUIWindowManagerTextureWindow ( GUITopLevelWindow *  window,
const Subtexture sub_texture,
const Rect geometry 
)

Constructs a GUIWindowManagerTextureWindow.

Parameters
window= GUITop Level Window
sub_texture= Subtexture
geometry= Rect
clan::SetupGUI::SetupGUI ( )

Initializes clanGUI.

clan::AcceleratorKey::~AcceleratorKey ( )
clan::AcceleratorTable::~AcceleratorTable ( )
virtual clan::GUIComponent::~GUIComponent ( )
virtual
clan::GUILayout::~GUILayout ( )
virtual clan::GUILayoutCorners::~GUILayoutCorners ( )
virtual
virtual clan::GUILayoutProvider::~GUILayoutProvider ( )
inlinevirtual
virtual clan::GUIManager::~GUIManager ( )
virtual
virtual clan::GUIMessage::~GUIMessage ( )
inlinevirtual
clan::GUIWindowManager::~GUIWindowManager ( )
clan::GUIWindowManagerDirect::~GUIWindowManagerDirect ( )
virtual clan::GUIWindowManagerProvider::~GUIWindowManagerProvider ( )
inlinevirtual
clan::GUIWindowManagerSystem::~GUIWindowManagerSystem ( )
clan::GUIWindowManagerTexture::~GUIWindowManagerTexture ( )
clan::GUIWindowManagerTextureWindow::~GUIWindowManagerTextureWindow ( )
clan::SetupGUI::~SetupGUI ( )
void clan::AcceleratorTable::add_accelerator ( const AcceleratorKey accel)

Add an accelerator table entry to the accelerator table.

void clan::GUILayoutCorners::add_component ( GUIComponent component,
ComponentAnchorPoint  ap_tl,
int  dist_tl_x,
int  dist_tl_y,
ComponentAnchorPoint  ap_br,
int  dist_br_x,
int  dist_br_y 
)
void clan::GUIManager::add_resources ( const XMLResourceDocument resources)

Adds resources to the GUI resource manager.

void clan::GUIManager::add_resources ( const std::string &  filename)

Adds additional resources to the GUI resource manager, by creating a XMLResourceDocument from file automatically.

void clan::GUIManager::add_resources ( const std::string &  filename,
const FileSystem fs 
)

Adds additional resources to the GUI resource manager.

void clan::GUIManager::add_theme ( const std::string &  fullname)

Adds a GUI theme.

Parameters
fullname= Filename of the theme.
void clan::GUIManager::add_theme ( const std::string &  fullname,
const FileSystem fs 
)

Adds a GUI theme.

Parameters
fullname= Filename of the theme.
virtual Canvas clan::GUIWindowManagerProvider::begin_paint ( GUITopLevelWindow *  handle,
const Rect update_region 
)
pure virtual

Begin paint.

Parameters
handle= GUITop Level Window
update_region= Rect
Returns
Canvas
Canvas clan::GUIWindowManager::begin_paint ( GUITopLevelWindow *  handle,
const Rect update_region 
)

Begin paint.

Parameters
handle= GUITop Level Window
update_region= Rect
Returns
Canvas
virtual void clan::GUIWindowManagerProvider::bring_to_front ( GUITopLevelWindow *  handle)
pure virtual

Bring to front.

Parameters
handle= GUITop Level Window
void clan::GUIWindowManager::bring_to_front ( GUITopLevelWindow *  handle)

Bring to front.

Parameters
handle= GUITop Level Window
virtual void clan::GUIWindowManagerProvider::capture_mouse ( GUITopLevelWindow *  handle,
bool  state 
)
pure virtual

Capture mouse.

Parameters
handle= GUITop Level Window
state= bool
void clan::GUIWindowManager::capture_mouse ( GUITopLevelWindow *  handle,
bool  state 
)

Capture mouse.

Parameters
handle= GUITop Level Window
state= bool
void clan::GUIComponent::capture_mouse ( bool  capture)

Make all mouse messages be redirected to this component.

void clan::GUIComponent::capture_proximity ( bool  capture)

Make tablet proximity messages be redirected to this component.

void clan::GUIManager::clear_exit_flag ( )

Clears the flag indicating exec() should exit its message pump loop.

Point clan::GUIComponent::component_to_screen_coords ( const Point component_point) const

Convert the component coordinates to screen coordinates.

Point clan::GUIComponent::component_to_window_coords ( const Point component_point) const

Convert the component coordinates to top-level window client coordinates.

Rect clan::GUIComponent::component_to_window_coords ( const Rect component_rect) const

Convert the component coordinates to top-level window client coordinates.

void clan::GUIComponent::create_components ( const DomDocument gui_xml)

Create child components from a GUI definition file.

void clan::GUIComponent::create_components ( const std::string &  fullname)

Create components.

Parameters
fullname= String Ref
void clan::GUIComponent::create_components ( IODevice file)

Create components.

Parameters
file= IODevice
void clan::GUIComponent::create_components ( const std::string &  filename,
const FileSystem fs 
)

Create components.

Parameters
filename= String Ref
dir= Virtual Directory
virtual void clan::GUIWindowManagerProvider::create_window ( GUITopLevelWindow *  handle,
GUITopLevelWindow *  owner,
GUIComponent component,
GUITopLevelDescription  description 
)
pure virtual
void clan::GUIWindowManager::create_window ( GUITopLevelWindow *  handle,
GUITopLevelWindow *  owner,
GUIComponent component,
GUITopLevelDescription  description 
)
void clan::GUIComponent::delete_child_components ( )

Deletes all child components.

virtual void clan::GUIWindowManagerProvider::destroy_window ( GUITopLevelWindow *  handle)
pure virtual

Destroy window.

Parameters
handle= GUITop Level Window
void clan::GUIWindowManager::destroy_window ( GUITopLevelWindow *  handle)

Destroy window.

Parameters
handle= GUITop Level Window
void clan::GUIManager::dispatch_message ( std::shared_ptr< GUIMessage message)

Sends a GUI message to the message handler target for the message.

void clan::GUIWindowManagerTexture::draw_windows ( Canvas canvas)

Draw the windows.

This is a convenience function than can be used when func_repaint() is overridden

Parameters
canvas= Canvas
virtual void clan::GUIWindowManagerProvider::enable_window ( GUITopLevelWindow *  handle,
bool  enable 
)
pure virtual

Enable window.

Parameters
handle= GUITop Level Window
enable= bool
void clan::GUIWindowManager::enable_window ( GUITopLevelWindow *  handle,
bool  enable 
)

Enable window.

Parameters
handle= GUITop Level Window
enable= bool
virtual void clan::GUIWindowManagerProvider::end_paint ( Canvas canvas,
GUITopLevelWindow *  handle,
const Rect update_region 
)
pure virtual

End paint.

Parameters
handle= GUITop Level Window
update_region= Rect
void clan::GUIWindowManager::end_paint ( Canvas canvas,
GUITopLevelWindow *  handle,
const Rect update_region 
)

End paint.

Parameters
handle= GUITop Level Window
update_region= Rect
int clan::GUIManager::exec ( )

Processes messages until exit_with_code is called.

int clan::GUIComponent::exec ( )

Run component in modal mode.

void clan::GUIManager::exit_with_code ( int  exit_code)

Breaks the message loop.

void clan::GUIComponent::exit_with_code ( int  exit_code)

Break message pump.

This function causes GUIComponent::exec or GUIManager::exec to exit with the given exit code.

void clan::GUIComponent::focus_next ( )

Set focus to the next component in tab order.

void clan::GUIComponent::focus_previous ( )

Set focus to the previous component in tab order.

Callback_0<bool>& clan::GUIComponent::func_activated ( )
Callback_0<bool>& clan::GUIComponent::func_close ( )
Callback_v1<Rect &>& clan::GUIComponent::func_constrain_resize ( )

void func_constrain_resize(Rect &geometry)

virtual Callback_2<GUIComponent*, GUIComponent*, std::string>& clan::GUIComponent::func_create_custom_component ( )
virtual

Callback invoked when loading a custom component from XML.

The type of the component to create is passed as a parameter to the function. The callback function should create the desired component and return it, or return 0, if no component is created. Example definition: GUIComponent *Foo::on_create_custom_component(GUIComponent *parent, std::string type);

Callback_0<bool>& clan::GUIComponent::func_deactivated ( )
Callback_v0& clan::GUIComponent::func_enablemode_changed ( )
Callback_0<int>& clan::GUIManager::func_exec_handler ( )
Callback_v1<std::shared_ptr<GUIMessage> &>& clan::GUIComponent::func_filter_message ( )

Lets a component filter the messages intended for another component. Consumed messages will not reach the original target component.

Callback_0<bool>& clan::GUIComponent::func_focus_gained ( )
Callback_0<bool>& clan::GUIComponent::func_focus_lost ( )
Callback_1<bool, const InputEvent &>& clan::GUIComponent::func_input ( )

bool func_input(const InputEvent &input_event)

Callback_1<bool, const InputEvent &>& clan::GUIComponent::func_input_doubleclick ( )

bool func_input_doubleclick(const InputEvent &input_event)

Callback_v1<InputEvent &>& clan::GUIWindowManagerDirect::func_input_intercept ( )

void func_input_intercept(InputEvent &input_event)

Callback_v1<InputEvent &>& clan::GUIWindowManagerTexture::func_input_intercept ( )

void func_input_intercept(InputEvent &input_event)

Callback_1<bool, const InputEvent &>& clan::GUIComponent::func_input_pointer_moved ( )

bool func_input_pointer_moved(const InputEvent &input_event)

Callback_1<bool, const InputEvent &>& clan::GUIComponent::func_input_pressed ( )

bool func_input_pressed(const InputEvent &input_event)

Callback_1<bool, const InputEvent &>& clan::GUIComponent::func_input_released ( )

bool func_input_released(const InputEvent &input_event)

Callback_0<bool>& clan::GUIComponent::func_pointer_enter ( )
Callback_0<bool>& clan::GUIComponent::func_pointer_exit ( )
Callback_v2<std::shared_ptr<GUIMessage> &, AcceleratorKey>& clan::AcceleratorKey::func_pressed ( )
Callback_v1<std::shared_ptr<GUIMessage> &>& clan::GUIComponent::func_process_message ( )

void func_process_message(std::shared_ptr<GUIMessage> &message)

Callback_v2<Canvas &, const Rect &>& clan::GUIComponent::func_render ( )

void func_render(Canvas &canvas, const Rect &clip_rect)

Callback_v0& clan::GUIWindowManagerTexture::func_repaint ( )
Callback_v0& clan::GUIComponent::func_resized ( )

Callback invoked when the component is resized, i.e. when set_geometry is called.

Callback_v1<FrameBuffer &>& clan::GUIWindowManagerTexture::func_setup_framebuffer ( )

void func_setup_framebuffer(FrameBuffer &fb)

Callback_v1<bool>& clan::GUIComponent::func_visibility_change ( )
AcceleratorKey clan::AcceleratorTable::get_accelerator ( int  id,
bool  shift = false,
bool  alt = false,
bool  ctrl = false 
)

Returns a vector containing the accelerator keys defined for this table.

std::vector<AcceleratorKey> clan::AcceleratorTable::get_accelerators ( )

Returns a vector containing the accelerator keys defined for this table.

bool clan::GUIComponent::get_allow_resize ( ) const

Returns true if the components size can be changed.

bool clan::AcceleratorKey::get_alt ( ) const

Get Alt.

Returns
alt
bool clan::GUIComponent::get_blocks_default_action ( ) const

Returns true if this component, when focused, blocks the default action of its parent dialog.

Rect clan::GUIThemePart::get_border_box ( const Rect content_box_rect) const

Returns the position and size of a border box for a given content box.

virtual Canvas& clan::GUIWindowManagerProvider::get_canvas ( GUITopLevelWindow *  handle)
pure virtual

Get canvas.

Parameters
handle= GUITop Level Window
Returns
Canvas
Canvas& clan::GUIWindowManager::get_canvas ( GUITopLevelWindow *  handle) const

Get canvas.

Parameters
handle= GUITop Level Window
Returns
Canvas
Canvas clan::GUIComponent::get_canvas ( ) const

Return the graphic context for the component.

GUIComponent* clan::GUIManager::get_capture_component ( ) const

Returns the mouse capture component.

std::vector<GUIComponent*> clan::GUIComponent::get_child_component_group ( const std::string &  group_name) const

Returns a list of child components belonging to the specified group.

std::vector<GUIComponent*> clan::GUIComponent::get_child_components ( ) const

Returns a list of the child components.

bool clan::GUIThemePart::get_class ( const std::string &  name) const

Returns whether a CSS class is present or not.

bool clan::GUIComponent::get_class ( const std::string &  name) const

Returns whether a CSS class is present or not.

std::vector<std::string> clan::GUIThemePart::get_classes ( ) const

Returns all classes currently present.

std::vector<std::string> clan::GUIComponent::get_classes ( ) const

Returns all classes currently present.

bool clan::GUIComponent::get_clip_children ( ) const

Returns true if the components children are clipped to the parent component when drawn.

std::string clan::GUIManager::get_clipboard_text ( ) const

Get Clipboard text.

Returns
clipboard_text
GUIComponent* clan::GUIComponent::get_component_at ( const Point point)

Return the component under 'point', in local viewport coordinates.

std::string clan::GUIComponent::get_component_group_name ( ) const

Returns the name of the component group, or an empty string if no group name has been set.

bool clan::GUIComponent::get_constant_repaint ( ) const

Enabled whether the GUI will constantly repaint this component when there are no other messages to process.

Rect clan::GUIComponent::get_content_box ( ) const

Returns the content box area relative to the component geometry.

Rect clan::GUIThemePart::get_content_box ( const Rect render_box_rect) const

Returns the position of the content box for a given render box.

Rect clan::GUIThemePart::get_content_shrink_box ( ) const

Returns the content shrink box of the theme part.

Rect clan::GUIComponent::get_content_shrink_box ( ) const

Returns the content shrink box of the theme part.

CSSDocument clan::GUIManager::get_css_document ( ) const

Returns the CSS document being used.

int clan::GUIThemePart::get_css_height ( ) const

Returns the css height of a render box.

virtual Size clan::GUILayoutProvider::get_css_size ( ) const
pure virtual

Returns the size of the dialog, as set in the editor.

Size clan::GUILayout::get_css_size ( ) const

Returns the size of the dialog, as set in the editor.

Size clan::GUIThemePart::get_css_size ( ) const

Returns the css size of a render box.

const CSSComputedValues& clan::GUIThemePart::get_css_values ( ) const

Returns the standard W3C CSS properties active for this component.

const CSSComputedValues& clan::GUIComponent::get_css_values ( ) const

Returns the standard W3C CSS properties active for this component.

int clan::GUIThemePart::get_css_width ( ) const

Returns the css width of a render box.

bool clan::AcceleratorKey::get_ctrl ( ) const

Get Ctrl.

Returns
ctrl
virtual DisplayWindow clan::GUIWindowManagerProvider::get_display_window ( GUITopLevelWindow *  handle) const
pure virtual

Get display window.

Parameters
handle= GUITop Level Window
Returns
Display Window
DisplayWindow clan::GUIWindowManager::get_display_window ( GUITopLevelWindow *  handle) const

Get display window.

Parameters
handle= GUITop Level Window
Returns
Display Window
DisplayWindow clan::GUIComponent::get_display_window ( ) const

Returns the display window in which this component is hosted.

int clan::GUIManager::get_exit_code ( ) const

Returns the dialog exit code.

bool clan::GUIManager::get_exit_flag ( ) const

Returns if a dialog message pump loop should exit.

const GUIComponent* clan::GUIComponent::get_first_child ( ) const

Returns the first child component.

GUIComponent* clan::GUIComponent::get_first_child ( )

Get First child.

Returns
first_child
FocusPolicy clan::GUIComponent::get_focus_policy ( ) const

Returns the focus policy of the component.

GUIComponent* clan::GUIManager::get_focused_component ( )

Returns the currently focused component.

Font clan::GUIThemePart::get_font ( ) const

Gets the font.

Font clan::GUIComponent::get_font ( ) const

Gets the font.

Rect clan::GUIWindowManagerTextureWindow::get_geometry ( ) const

Get Geometry.

Returns
geometry
Rect clan::GUIComponent::get_geometry ( ) const

Returns the position and size of the drawable area of the component relative to its parent component.

If there is no parent component this function returns the position relative to the window viewport (its client area).

virtual Rect clan::GUIWindowManagerProvider::get_geometry ( GUITopLevelWindow *  handle,
bool  client_area 
) const
pure virtual

Get geometry.

Parameters
handle= GUITop Level Window
client_area= bool
Returns
Rect
Rect clan::GUIWindowManager::get_geometry ( GUITopLevelWindow *  handle,
bool  client_area 
) const

Get geometry.

Parameters
handle= GUITop Level Window
client_area= bool
Returns
Rect
GUIComponent* clan::GUIComponent::get_group_selected_component ( )

Returns the selected item in a component group of which this component is a member.

GUIManager clan::GUIComponent::get_gui_manager ( ) const

Returns the GUI manager owning this component.

int clan::GUIComponent::get_height ( ) const

Returns the height of the drawable area of the component.

virtual InputContext clan::GUIWindowManagerProvider::get_ic ( GUITopLevelWindow *  handle) const
pure virtual

Get ic.

Parameters
handle= GUITop Level Window
Returns
Input Context
InputContext clan::GUIWindowManager::get_ic ( GUITopLevelWindow *  handle) const

Get ic.

Parameters
handle= GUITop Level Window
Returns
Input Context
InputContext clan::GUIComponent::get_ic ( )

Return the input context for the component.

std::string clan::GUIThemePart::get_id ( ) const

Returns the CSS id attribute.

int clan::AcceleratorKey::get_id ( ) const

Get Id.

Returns
id
std::string clan::GUIComponent::get_id ( ) const

Returns the CSS id attribute.

const GUIComponent* clan::GUIComponent::get_last_child ( ) const

Returns the last child component.

GUIComponent* clan::GUIComponent::get_last_child ( )

Get Last child.

Returns
last_child
GUILayout clan::GUIComponent::get_layout ( ) const

Returns the layout manager set for this component. Check GUILayout.is_null() if none set.

GUIComponent* clan::GUIComponent::get_named_item ( const std::string &  id)

Find child component with the specified component ID name.

GUIComponent* clan::GUIComponent::get_next_component_in_tree ( )

Returns the next component in the component tree, or 'this', if none found.

const GUIComponent* clan::GUIComponent::get_next_sibling ( ) const

Returns the next sibling component.

GUIComponent* clan::GUIComponent::get_next_sibling ( )

Get Next sibling.

Returns
next_sibling
const GUIComponent* clan::GUIComponent::get_owner_component ( ) const

Return the component owning this component.

Only top-level components has an owner.

GUIComponent* clan::GUIComponent::get_owner_component ( )

Get Owner component.

Returns
owner_component
const GUIComponent* clan::GUIComponent::get_parent_component ( ) const

Returns the parent component.

Only child components has a parent.

GUIComponent* clan::GUIComponent::get_parent_component ( )

Get Parent component.

Returns
parent_component
virtual float clan::GUIComponent::get_preferred_content_height ( float  width)
virtual

Returns the preferred content height for the specified content width.

Override this function if the component has non-css content.

Reimplemented in clan::ScrollBar, clan::LineEdit, clan::Slider, clan::ImageView, clan::PushButton, clan::Label, and clan::RadioButton.

virtual float clan::GUIComponent::get_preferred_content_width ( )
virtual

Returns the preferred content width.

Override this function if the component has non-css content.

Reimplemented in clan::ScrollBar, clan::LineEdit, clan::Slider, clan::ImageView, clan::PushButton, clan::Label, and clan::RadioButton.

GUIComponent* clan::GUIComponent::get_previous_component_in_tree ( )

Returns the previous component in the component tree, or 'this', if none found.

const GUIComponent* clan::GUIComponent::get_previous_sibling ( ) const

Returns the previous sibling component.

GUIComponent* clan::GUIComponent::get_previous_sibling ( )

Get Previous sibling.

Returns
previous_sibling
std::string clan::GUIThemePart::get_property ( const std::string &  property,
const std::string &  default_value 
) const

Returns the value of a property.

std::string clan::GUIComponent::get_property ( const std::string &  property,
const std::string &  default_value 
) const

Returns the value of a property.

int clan::GUIThemePart::get_property_int ( const std::string &  property,
const std::string &  default_value 
) const

Returns the value of a property as an integer.

int clan::GUIComponent::get_property_int ( const std::string &  property,
const std::string &  default_value 
) const

Returns the value of a property as an integer.

GUIWindowManagerProvider_System* clan::GUIWindowManagerSystem::get_provider ( ) const

Retrieves the provider.

GUIWindowManagerProvider_Direct* clan::GUIWindowManagerDirect::get_provider ( ) const

Retrieves the provider.

GUILayoutProvider_Corners* clan::GUILayoutCorners::get_provider ( ) const

Retrieves the provider.

GUIWindowManagerProvider_Texture* clan::GUIWindowManagerTexture::get_provider ( ) const

Retrieves the provider.

GUILayoutProvider* clan::GUILayout::get_provider ( ) const

Retrieves the provider.

GUIWindowManagerProvider* clan::GUIWindowManager::get_provider ( ) const

Retrieves the provider.

bool clan::GUIThemePart::get_pseudo_class ( const std::string &  name) const

Returns whether a CSS pseudo class is present or not.

bool clan::GUIComponent::get_pseudo_class ( const std::string &  name) const

Returns whether a CSS pseudo class is present or not.

std::vector<std::string> clan::GUIThemePart::get_pseudo_classes ( ) const

Returns all pseudo classes currently present.

std::vector<std::string> clan::GUIComponent::get_pseudo_classes ( ) const

Returns all pseudo classes currently present.

Rect clan::GUIThemePart::get_render_text_box ( Canvas canvas,
const std::string &  str,
const Rect content_rect 
) const

Calculates the text box using the font defined for the current state for use with render_text()

Rect clan::GUIComponent::get_render_text_box ( Canvas canvas,
const std::string &  str 
) const

Calculates the text box using the font defined for the current state for use with render_text().

Size clan::GUIThemePart::get_render_text_size ( Canvas canvas,
const std::string &  str 
) const

Calculates the text size using the font defined for the current state for use with render_text()

Size clan::GUIComponent::get_render_text_size ( Canvas canvas,
const std::string &  str 
) const

Calculates the text size using the font defined for the current state for use with render_text().

Rect clan::GUIThemePart::get_render_text_span_box ( Canvas canvas,
const std::string &  str,
const Rect content_rect 
) const

Calculates the text size using the font defined for the current state for use with render_text_span()

Rect clan::GUIComponent::get_render_text_span_box ( Canvas canvas,
const std::string &  str,
const Rect content_rect 
) const

Calculates the text size using the font defined for the current state for use with render_text_span().

ResourceManager clan::GUIManager::get_resource_manager ( ) const

Returns the resource manager.

ResourceManager clan::GUIComponent::get_resources ( ) const

Returns the resource manager for the GUI resources.

bool clan::AcceleratorKey::get_shift ( ) const

Get Shift.

Returns
shift
Size clan::GUIComponent::get_size ( ) const

Returns the size of the drawable area of the component.

std::string clan::GUIThemePart::get_tag_name ( ) const

Returns the CSS tag name.

std::string clan::GUIComponent::get_tag_name ( ) const

Returns the CSS tag name.

Subtexture clan::GUIWindowManagerTextureWindow::get_texture ( ) const

Get Texture.

Returns
texture
const GUIComponent* clan::GUIComponent::get_top_level_component ( ) const

Returns the top level component this GUIComponent is a child of.

GUIComponent* clan::GUIComponent::get_top_level_component ( )

Get Top level component.

Returns
top_level_component
GUITopLevelWindow* clan::GUIComponent::get_top_level_window ( ) const

Returns the top level window this GUIComponent belongs to.

GUIComponent* clan::GUIWindowManagerTextureWindow::get_toplevel_component ( ) const

Get Toplevel component.

Returns
toplevel_component
VerticalTextPosition clan::GUIThemePart::get_vertical_text_align ( Canvas canvas,
const Rect content_rect 
)

Calculates the vertical text position for the current font.

VerticalTextPosition clan::GUIComponent::get_vertical_text_align ( Canvas canvas)

Calculates the vertical text position for the current font using the component content box.

VerticalTextPosition clan::GUIComponent::get_vertical_text_align ( Canvas canvas,
const Rect rect 
)

Calculates the vertical text position for the current font.

Rect clan::GUIComponent::get_viewport ( ) const

Returns the position and size of the viewport of the component window in screen coordinates.

int clan::GUIComponent::get_width ( ) const

Returns the width of the drawable area of the component.

GUITopLevelWindow* clan::GUIWindowManagerTextureWindow::get_window ( ) const

Get Window.

Returns
window
Rect clan::GUIComponent::get_window_geometry ( ) const

Returns the position and size of the component window (window frame, borders etc).

GUIWindowManager clan::GUIManager::get_window_manager ( ) const

Returns the windows manager being used.

virtual GUIWindowManager::WindowManagerType clan::GUIWindowManagerProvider::get_window_manager_type ( ) const
pure virtual
WindowManagerType clan::GUIWindowManager::get_window_manager_type ( ) const

Get Window manager type.

Returns
window_manager_type
std::vector<GUIWindowManagerTextureWindow> clan::GUIWindowManagerTexture::get_windows ( bool  only_visible = true) const

Get the window textures.

Parameters
only_visible= True = Only return windows when they are visible
Returns
The window textures
bool clan::GUIComponent::has_child_components ( ) const

Returns true if the component has any child components.

virtual bool clan::GUIWindowManagerProvider::has_focus ( GUITopLevelWindow *  handle) const
pure virtual

Has focus.

Parameters
handle= GUITop Level Window
Returns
bool
bool clan::GUIComponent::has_focus ( ) const

Returns true if the component has the focus.

bool clan::GUIWindowManager::has_focus ( GUITopLevelWindow *  handle) const

Has focus.

Parameters
handle= GUITop Level Window
Returns
bool
bool clan::GUIComponent::is_active ( ) const

Returns true if the component is active.

bool clan::GUIComponent::is_ancestor_of ( GUIComponent component)

Checks if this component is the ancestor of target component.

Returns
true if target component is ancestor, false otherwise.
bool clan::GUIComponent::is_cancel ( )

Returns true if this component will receive unhandled escape keypress messages.

bool clan::GUIComponent::is_default ( )

Returns true if this component will receive unhandled enter/return keypress messages.

bool clan::GUIComponent::is_descendant_of ( GUIComponent component)

Checks if this component is a descendant of target component.

Returns
true if target component is descendant, false otherwise.
bool clan::GUIComponent::is_double_click_enabled ( ) const

Returns true if this component will generate double click messages.

bool clan::GUIComponent::is_enabled ( ) const

Return true if the component, and all its parents are enabled.

virtual bool clan::GUIWindowManagerProvider::is_maximized ( GUITopLevelWindow *  handle) const
pure virtual

Is maximized.

Parameters
handle= GUITop Level Window
Returns
bool
bool clan::GUIWindowManager::is_maximized ( GUITopLevelWindow *  handle) const

Is maximized.

Parameters
handle= GUITop Level Window
Returns
bool
virtual bool clan::GUIWindowManagerProvider::is_minimized ( GUITopLevelWindow *  handle) const
pure virtual

Is minimized.

Parameters
handle= GUITop Level Window
Returns
bool
bool clan::GUIWindowManager::is_minimized ( GUITopLevelWindow *  handle) const

Is minimized.

Parameters
handle= GUITop Level Window
Returns
bool
bool clan::GUIThemePart::is_null ( ) const
inline

Returns true if this object is invalid.

bool clan::GUILayout::is_null ( ) const

Is Null.

Returns
true = null
bool clan::AcceleratorKey::is_null ( ) const
inline

Returns true if this object is invalid.

bool clan::GUIWindowManager::is_null ( ) const

Is Null.

Returns
true = null
bool clan::GUIComponent::is_selected_in_group ( ) const

Returns true if the component is the selected item in a group of components where FocusPolicy is focus_group.

bool clan::GUIComponent::is_visible ( ) const

Return true if the component, and all its parents are visible.

void clan::GUIComponent::paint ( )

Paints the component.

This function renders all components affecting the component or area specified and makes the changes visible.

void clan::GUIComponent::paint ( const Rect clip_rect)

Paint.

Parameters
clip_rect= Rect
virtual void clan::GUIWindowManagerProvider::pop_cliprect ( GUITopLevelWindow *  handle,
Canvas canvas 
)
pure virtual

Push cliprect.

Parameters
handle= GUITop Level Window
canvas= Canvas
void clan::GUIWindowManager::pop_cliprect ( GUITopLevelWindow *  handle,
Canvas canvas 
)

Pop cliprect.

Parameters
handle= GUITop Level Window
canvas= Canvas
void clan::GUIComponent::pop_cliprect ( Canvas canvas)

Pop a clipping rectangle.

void clan::GUIWindowManagerTexture::process ( )

Process the windows.

Can you use this function if you do not want the GUIManager to control the application main loop
Use draw_windows() after this to draw the windows to the screen

void clan::AcceleratorTable::process_message ( std::shared_ptr< GUIMessage > &  msg)

Check if the message is an accelerator key and invoke relevant accelerator callback.

void clan::GUIWindowManager::process_message ( )

Process message.

void clan::GUIManager::process_messages ( int  timeout)

Processes all messages available.

Parameters
timeout= Timeout (ms). -1 = Wait forever
virtual void clan::GUIWindowManagerProvider::push_cliprect ( GUITopLevelWindow *  handle,
Canvas canvas,
const Rect rect 
)
pure virtual

Push cliprect.

Parameters
handle= GUITop Level Window
canvas= Canvas
rect= Clip rect
void clan::GUIWindowManager::push_cliprect ( GUITopLevelWindow *  handle,
Canvas canvas,
const Rect rect 
)

Push cliprect.

Parameters
handle= GUITop Level Window
canvas= Canvas
rect= Clip rect
void clan::GUIComponent::push_cliprect ( Canvas canvas,
const Rect rect 
)

Push a clipping rectangle.

void clan::GUILayoutCorners::remove_component ( GUIComponent component)

Remove component.

Parameters
component= GUIComponent
void clan::GUIComponent::render ( Canvas canvas,
const Rect clip_rect,
bool  include_children = true 
)

Renders the component and its children.

void clan::GUIThemePart::render_box ( Canvas canvas,
const Rect border_box 
)

Renders the component and its children.

Rect clan::GUIThemePart::render_text ( Canvas canvas,
const std::string &  text,
const Rect content_box 
)
Rect clan::GUIThemePart::render_text ( Canvas canvas,
const std::string &  text,
const Rect content_box,
int  baseline 
)
Rect clan::GUIComponent::render_text ( Canvas canvas,
const std::string &  text 
)
Rect clan::GUIComponent::render_text ( Canvas canvas,
const std::string &  text,
int  xpos,
int  baseline 
)
Rect clan::GUIThemePart::render_text_span ( Canvas canvas,
const std::string &  text,
const Rect content_rect 
)
Rect clan::GUIComponent::render_text_span ( Canvas canvas,
const std::string &  text,
const Rect content_rect 
)
void clan::GUIManager::render_windows ( )

Render windows.

virtual void clan::GUIWindowManagerProvider::request_repaint ( GUITopLevelWindow *  handle,
const Rect update_region 
)
pure virtual

Request repaint.

Parameters
handle= GUITop Level Window
update_region= Rect
void clan::GUIManager::request_repaint ( const Rect rect,
GUIComponent root_component 
)

Mark the specified area to be redrawn.

void clan::GUIWindowManager::request_repaint ( GUITopLevelWindow *  handle,
const Rect update_region 
)

Request repaint.

Parameters
handle= GUITop Level Window
update_region= Rect
void clan::GUIComponent::request_repaint ( )
void clan::GUIComponent::request_repaint ( Rect  rect)

Request repaint.

Parameters
rect= Rect
virtual void clan::GUIWindowManagerProvider::reset_cliprect ( GUITopLevelWindow *  handle,
Canvas canvas 
)
pure virtual

Reset cliprect.

Parameters
handle= GUITop Level Window
canvas= Canvas
void clan::GUIWindowManager::reset_cliprect ( GUITopLevelWindow *  handle,
Canvas canvas 
)

Reset cliprect.

Parameters
handle= GUITop Level Window
canvas= Canvas
void clan::GUIComponent::reset_cliprect ( Canvas canvas)

Reset the clipping rectangle.

void clan::GUIComponent::reset_geometry ( )

Reset back to automatic layout.

Point clan::GUIComponent::screen_to_component_coords ( const Point screen_point) const

Convert the screen coordinates to component coordinates.

virtual Point clan::GUIWindowManagerProvider::screen_to_window ( GUITopLevelWindow *  handle,
const Point screen_point,
bool  client_area 
) const
pure virtual

Screen to window.

Parameters
handle= GUITop Level Window
screen_point= Point
client_area= bool
Returns
Point
Point clan::GUIWindowManager::screen_to_window ( GUITopLevelWindow *  handle,
const Point screen_point,
bool  client_area 
) const

Screen to window.

Parameters
handle= GUITop Level Window
screen_point= Point
client_area= bool
Returns
Point
void clan::GUIManager::set_accelerator_table ( const AcceleratorTable table)

Set the accelerator table.

void clan::AcceleratorKey::set_alt ( bool  )

Set Alt.

void clan::GUIComponent::set_blocks_default_action ( bool  block)

Set to true if this component, when focused, blocks the default action of the parent dialog.

void clan::GUIComponent::set_cancel ( bool  value)

When set to true, this component will receive unhandled escape keypress messages.

If multiple components are set as 'cancel' handlers, the first child with the property will receive the keypress message.

void clan::GUIManager::set_capture_component ( GUIComponent component,
bool  state 
)

Set the mouse capture component.

bool clan::GUIThemePart::set_class ( const std::string &  name,
bool  enable 
)

Controls the presence of a CSS class.

Returns
true if changed
bool clan::GUIComponent::set_class ( const std::string &  name,
bool  enable 
)

Controls the presence of a CSS class.

Returns
true if changed
void clan::GUIComponent::set_clip_children ( bool  clip = true,
const Rect clip_rect = Rect(0, 0, 0, 0) 
)

Sets the components children to be clipped to the parent component when drawn.

void clan::GUIManager::set_clipboard_text ( const std::string &  str)

Set clipboard text.

virtual void clan::GUIWindowManagerProvider::set_cliprect ( GUITopLevelWindow *  handle,
Canvas canvas,
const Rect rect 
)
pure virtual

Set cliprect.

Parameters
handle= GUITop Level Window
canvas= Canvas
rect= Rect
void clan::GUIWindowManager::set_cliprect ( GUITopLevelWindow *  handle,
Canvas canvas,
const Rect rect 
)

Set cliprect.

Parameters
handle= GUITop Level Window
canvas= Canvas
rect= Rect
void clan::GUIComponent::set_cliprect ( Canvas canvas,
const Rect rect 
)

Set a clipping rectangle.

void clan::GUIComponent::set_component_group_name ( const std::string &  str)

Set group name.

Parameters
str= String Ref
void clan::GUIComponent::set_constant_repaint ( bool  enable)

Enabled whether the GUI will constantly repaint this component when there are no other messages to process.

void clan::AcceleratorKey::set_ctrl ( bool  )

Set Ctrl.

virtual void clan::GUIWindowManagerProvider::set_cursor ( GUITopLevelWindow *  handle,
const Cursor cursor 
)
pure virtual

Set cursor.

Parameters
handle= GUITop Level Window
cursor= Cursor
virtual void clan::GUIWindowManagerProvider::set_cursor ( GUITopLevelWindow *  handle,
enum StandardCursor  type 
)
pure virtual

Set cursor.

Parameters
handle= GUITop Level Window
type= StandardCursor
void clan::GUIWindowManager::set_cursor ( GUITopLevelWindow *  handle,
const Cursor cursor 
)

Set cursor.

Parameters
handle= GUITop Level Window
cursor= Cursor
void clan::GUIWindowManager::set_cursor ( GUITopLevelWindow *  handle,
enum StandardCursor  type 
)

Set cursor.

Parameters
handle= GUITop Level Window
type= StandardCursor
void clan::GUIComponent::set_cursor ( const Cursor cursor)

Sets the current cursor icon.

void clan::GUIComponent::set_cursor ( enum StandardCursor  type)

Set cursor.

Parameters
type= StandardCursor
void clan::GUIComponent::set_default ( bool  value)

When set to true, this component will receive unhandled enter/return keypress messages.

If multiple components are set as 'default' handlers, the first child with the property will receive the keypress message.

void clan::GUIComponent::set_double_click_enabled ( bool  enable)

Modifies whether this component will generate double click messages or not.

void clan::GUIComponent::set_enabled ( bool  enable = true)

Sets the component as enabled or disabled.

void clan::GUIComponent::set_focus ( bool  enable = true)

Set this component focus.

Parameters
enable= true = To set the focus. false = Loose the focus (if in focus)
void clan::GUIComponent::set_focus_policy ( FocusPolicy  policy)

Sets the focus policy of the component.

virtual void clan::GUILayoutProvider::set_geometry ( const Rect pos)
pure virtual

Set geometry.

Parameters
pos= Rect
void clan::GUILayout::set_geometry ( const Rect pos)

Set geometry.

Parameters
pos= Rect
virtual void clan::GUIWindowManagerProvider::set_geometry ( GUITopLevelWindow *  handle,
const Rect geometry,
bool  client_area 
)
pure virtual

Set geometry.

Parameters
handle= GUITop Level Window
geometry= Rect
client_area= bool
void clan::GUIWindowManager::set_geometry ( GUITopLevelWindow *  handle,
const Rect geometry,
bool  client_area 
)

Set geometry.

Parameters
handle= GUITop Level Window
geometry= Rect
client_area= bool
void clan::GUIComponent::set_geometry ( Rect  geometry)

Set manual component position and size.

void clan::AcceleratorKey::set_id ( int  )

Set Id.

void clan::GUIThemePart::set_id ( const std::string &  name)

Sets the CSS id.

void clan::GUIComponent::set_id ( const std::string &  name)

Sets the CSS id.

void clan::GUIComponent::set_layout ( GUILayout layout)

Set a layout on the component.

void clan::GUIComponent::set_parent_component ( GUIComponent new_parent)

Makes this component a child of the given component, removing it from the previous parent.

virtual void clan::GUILayoutProvider::set_preferred_size ( const Size size)
pure virtual

Set preferred size.

Parameters
size= Size
void clan::GUILayout::set_preferred_size ( const Size size)

Set preferred size.

Parameters
size= Size
bool clan::GUIThemePart::set_pseudo_class ( const std::string &  name,
bool  enable 
)

Controls the presence of a CSS pseudo class.

Returns
true if changed
bool clan::GUIComponent::set_pseudo_class ( const std::string &  name,
bool  enable 
)

Controls the presence of a CSS pseudo class.

Returns
true if changed
void clan::GUIManager::set_resource_manager ( ResourceManager resource_manager)

Set the resource manager (other than the default one)

void clan::GUIComponent::set_selected_in_component_group ( bool  selected)

Set to true if this component is the selected item in a group of components where FocusPolicy is focus_group.

void clan::AcceleratorKey::set_shift ( bool  )

Set Shift.

virtual void clan::GUIWindowManagerProvider::set_site ( GUIWindowManagerSite site)
pure virtual

Set site.

Parameters
site= GUIWindow Manager Site
void clan::GUIWindowManager::set_site ( GUIWindowManagerSite site)

Set site.

Parameters
site= GUIWindow Manager Site
void clan::GUIThemePart::set_style ( const std::string &  name)

Sets additional CSS style properties that should be applied to this element.

This replaces all existing styles. Use "" to clear styles.

void clan::GUIThemePart::set_style ( const CSSPropertyValue value,
bool  enable 
)

Sets additional CSS style properties that should be applied to this element.

void clan::GUIComponent::set_style ( const std::string &  name)

Sets additional CSS style properties that should be applied to this element.

This replaces all existing styles. Use "" to clear styles.

void clan::GUIComponent::set_style ( const CSSPropertyValue value,
bool  enable 
)

Sets additional CSS style properties that should be applied to this element.

void clan::GUIManager::set_tablet_proximity_component ( GUIComponent ,
bool  state 
)

Redirect proximity events from tablet to the specified component.

void clan::GUIThemePart::set_tag_name ( const std::string &  name)

Sets the CSS tag name.

void clan::GUIComponent::set_tag_name ( const std::string &  name)

Sets the CSS tag name.

Referenced by clan::RolloutList::add_rollout().

void clan::GUIWindowManagerTexture::set_texture_group ( TextureGroup new_texture_group)

Set texture group.

Parameters
new_texture_group= Texture Group
void clan::GUIManager::set_theme ( CSSDocument  css)

Sets the GUI theme.

void clan::GUIManager::set_theme ( const std::string &  fullname)

Sets the GUI theme.

void clan::GUIManager::set_theme ( const std::string &  filename,
const FileSystem fs 
)

Set the GUI theme.

Parameters
filename= String
directory= Virtual Directory
virtual void clan::GUIWindowManagerProvider::set_visible ( GUITopLevelWindow *  handle,
bool  visible,
bool  activate_root_win 
)
pure virtual

Set visible.

Parameters
handle= GUITop Level Window
visible= bool
activate_root_win= bool
void clan::GUIWindowManager::set_visible ( GUITopLevelWindow *  handle,
bool  visible,
bool  activate_root_win 
)

Set visible.

Parameters
handle= GUITop Level Window
visible= bool
activate_root_win= bool
void clan::GUIComponent::set_visible ( bool  visible = true,
bool  activate_root_win = true 
)

Sets the component as visible or hidden.

Parameters
visible= Visible state
activate_root_win= In case the component is a root window, this parameter controls whether the window is activated.
void clan::GUIComponent::set_window_geometry ( Rect  geometry,
bool  client_area = false 
)

Set component window position and size.

void clan::GUIManager::set_window_manager ( GUIWindowManager window_manager)

Sets the windows manager.

Signal_v1<std::shared_ptr<GUIMessage> &>& clan::GUIManager::sig_filter_message ( )

bool func_filter_message(std::shared_ptr<GUIMessage> &message)

Signal_v0& clan::GUIComponent::sig_style_changed ( )
Signal_v1<DisplayWindow>& clan::GUIWindowManagerSystem::sig_toplevel_window_created ( )
Signal_v1<DisplayWindow>& clan::GUIWindowManagerSystem::sig_toplevel_window_destroyed ( )
void clan::GUIThemePart::throw_if_null ( ) const

Throw an exception if this object is invalid.

void clan::AcceleratorKey::throw_if_null ( ) const

Throw an exception if this object is invalid.

virtual void clan::GUIWindowManagerProvider::update ( )
pure virtual

Perform any updates.

This is called by GUIManager::exec(), after all messages has been processed

void clan::GUIWindowManager::update ( )

Perform any updates.

This is called by GUIManager::exec(), after all messages has been processed

void clan::GUIComponent::update_layout ( )

Re-evaluates the geometry of the component.

Point clan::GUIComponent::window_to_component_coords ( const Point window_point) const

Convert the top-level window client coordinates to component coordinates.

Rect clan::GUIComponent::window_to_component_coords ( const Rect window_rect) const

Convert the top-level window client coordinates to component coordinates.

virtual Point clan::GUIWindowManagerProvider::window_to_screen ( GUITopLevelWindow *  handle,
const Point window_point,
bool  client_area 
) const
pure virtual

Window to screen.

Parameters
handle= GUITop Level Window
window_point= Point
client_area= bool
Returns
Point
Point clan::GUIWindowManager::window_to_screen ( GUITopLevelWindow *  handle,
const Point window_point,
bool  client_area 
) const

Window to screen.

Parameters
handle= GUITop Level Window
window_point= Point
client_area= bool
Returns
Point

Variable Documentation

ActivationType clan::GUIMessage_ActivationChange::activation_type

Retrieves the focus type of this message.

float clan::VerticalTextPosition::baseline
float clan::VerticalTextPosition::bottom
bool clan::GUIMessage::consumed

Indicates whether the message has been consumed yet.

FocusType clan::GUIMessage_FocusChange::focus_type

The focus type of this message.

Callback_v1<GUITopLevelWindow *>* clan::GUIWindowManagerSite::func_close

Pointer to close notification callback function.

Callback_v1<GUITopLevelWindow *>* clan::GUIWindowManagerSite::func_destroy

Pointer to destroy notification callback function.

Callback_v1<GUITopLevelWindow *>* clan::GUIWindowManagerSite::func_focus_gained

Pointer to focus gained notification callback function.

Callback_v1<GUITopLevelWindow *>* clan::GUIWindowManagerSite::func_focus_lost

Pointer to focus lost notification callback function.

Callback_v2<GUITopLevelWindow *, const InputEvent &>* clan::GUIWindowManagerSite::func_input_received

Pointer to close notification callback function.

Callback_v2<GUITopLevelWindow *, const Rect &>* clan::GUIWindowManagerSite::func_paint

Pointer to paint notification callback function.

Callback_v2<GUITopLevelWindow *, const Size &>* clan::GUIWindowManagerSite::func_resize

Pointer to focus gained notification callback function.

Rect clan::GUIMessage_Resize::geometry

The geometry contained in this message.

std::shared_ptr<GUIThemePart_Impl> clan::GUIThemePart::impl
std::unique_ptr<GUIComponent_Impl> clan::GUIComponent::impl
InputEvent clan::GUIMessage_Input::input_event

Input event for this message.

PointerType clan::GUIMessage_Pointer::pointer_type

Retrieves the pointer type of this message.

GUIComponent* clan::GUIMessage::target

The target destination of the message.

float clan::VerticalTextPosition::top

Friends

friend class GUIComponent_Impl
friend