CL_PushButton Class Reference
[clanGUI Components]

Push button component. More...

#include <push_button.h>

Inheritance diagram for CL_PushButton:
Inheritance graph
[legend]

List of all members.

Public Member Functions

Construction

 CL_PushButton (CL_GUIComponent *parent)
 Constructs a PushButton.
virtual ~CL_PushButton ()
Operations

void set_pushed (bool enable)
 Set pushed.
void set_toggle (bool enable)
 Set toggle.
void set_flat (bool enable)
 Set flat.
void set_icon (const CL_Image &icon)
 Set icon.
void set_icon_position (IconPosition pos)
 Set icon position.
void set_text (const CL_StringRef &text)
 Set text.
Events

CL_Callback_v0func_clicked ()
 Func clicked.
Events

CL_Callback_v2
< CL_GraphicContext &, const
CL_Rect & > & 
func_render ()
 void func_render(CL_GraphicContext &gc, const CL_Rect &clip_rect)
CL_Callback_v1< CL_GUIMessage & > & func_process_message ()
 void func_process_message(const CL_GUIMessage &message)
CL_Callback_0< bool > & func_close ()
 bool func_close()
CL_Callback_0< bool > & func_activated ()
 bool func_activated()
CL_Callback_0< bool > & func_deactivated ()
 bool func_deactivated()
CL_Callback_0< bool > & func_focus_lost ()
 bool func_focus_lost()
CL_Callback_0< bool > & func_focus_gained ()
 bool func_focus_gained()
CL_Callback_0< bool > & func_pointer_enter ()
 bool func_pointer_enter()
CL_Callback_0< bool > & func_pointer_exit ()
 bool func_pointer_exit()
CL_Callback_v1< CL_GUIMessage & > & func_filter_message ()
 Lets a component filter the messages intended for another component. Consumed messages will not reach the original target component.
CL_Callback_1< bool, const
CL_InputEvent & > & 
func_input ()
 bool func_input(const CL_InputEvent &input_event)
CL_Callback_1< bool, const
CL_InputEvent & > & 
func_input_pressed ()
 bool func_input_pressed(const CL_InputEvent &input_event)
CL_Callback_1< bool, const
CL_InputEvent & > & 
func_input_released ()
 bool func_input_released(const CL_InputEvent &input_event)
CL_Callback_1< bool, const
CL_InputEvent & > & 
func_input_doubleclick ()
 bool func_input_doubleclick(const CL_InputEvent &input_event)
CL_Callback_1< bool, const
CL_InputEvent & > & 
func_input_pointer_moved ()
 bool func_input_pointer_moved(const CL_InputEvent &input_event)
CL_Callback_v1< bool > & func_visibility_change ()
 bool func_visibility_change()
CL_Callback_v0func_style_changed ()
 void func_style_changed()
CL_Callback_v0func_enablemode_changed ()
 void func_enablemode_changed()
CL_Callback_v0func_resized ()
 Callback invoked when the component is resized, i.e. when set_geometry is called.
CL_Callback_v1< CL_Rect & > & func_constrain_resize ()
 void func_constrain_resize(CL_Rect &geometry)
virtual CL_Callback_2
< CL_GUIComponent
*, CL_GUIComponent
*, CL_String > & 
func_create_custom_component ()
 Callback invoked when loading a custom component from XML.
Operations

void render (CL_GraphicContext &gc, const CL_Rect &clip_rect, bool include_children=true)
 Renders the component and its children.
void paint ()
 Paints the component.
void paint (const CL_Rect &clip_rect)
 Paint.
int exec ()
 Run component in modal mode.
void exit_with_code (int exit_code)
 Break message pump.
void set_geometry (CL_Rect geometry)
 Set component position and size.
void set_window_geometry (CL_Rect geometry)
 Set component window position and size.
void set_type_name (const CL_StringRef &name)
 Sets the component type name. (csstype.cssclass::cssid).
void set_class_name (const CL_StringRef &name)
 Sets the component class name. (csstype.cssclass::cssid).
void set_id_name (const CL_StringRef &name)
 Sets the component ID name. (csstype.cssclass::cssid).
void set_enabled (bool enable=true)
 Sets the component as enabled or disabled.
void set_clip_children (bool clip=true, const CL_Rect &clip_rect=CL_Rect(0, 0, 0, 0))
 Sets the components children to be clipped to the parent component when drawn.
void set_visible (bool visible=true, bool activate_root_win=true)
 Sets the component as visible or hidden.
void set_focus (bool enable=true)
 Set this component focus.
void capture_mouse (bool capture)
 Make all mouse messages be redirected to this component.
void capture_proximity (bool capture)
 Make tablet proximity messages be redirected to this component.
void set_focus_policy (FocusPolicy policy)
 Sets the focus policy of the component.
void set_double_click_enabled (bool enable)
 Modifies whether this component will generate double click messages or not.
void set_component_group_name (const CL_StringRef &str)
 Set group name.
void 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 create_components (const CL_DomDocument &gui_xml)
 Create child components from a GUI definition file.
void create_components (const CL_StringRef &fullname)
 Create components.
void create_components (CL_IODevice &file)
 Create components.
void create_components (const CL_StringRef &filename, const CL_VirtualDirectory &dir)
 Create components.
void request_repaint ()
void request_repaint (CL_Rect rect)
 Request repaint.
void set_cliprect (CL_GraphicContext &gc, const CL_Rect &rect)
 Set a clipping rectangle.
void reset_cliprect (CL_GraphicContext &gc)
 Reset the clipping rectangle.
void push_cliprect (CL_GraphicContext &gc, const CL_Rect &rect)
 Push a clipping rectangle.
void pop_cliprect (CL_GraphicContext &gc)
 Pop a clipping rectangle.
void delete_child_components ()
 Deletes all child components.
void set_parent_component (CL_GUIComponent *new_parent)
 Makes this component a child of the given component, removing it from the previous parent.
void set_layout (CL_GUILayout &layout)
 Set a layout on the component.
void set_cursor (const CL_Cursor &cursor)
 Sets the current cursor icon.
void set_cursor (enum CL_StandardCursor type)
 Set cursor.
void focus_next ()
 Set focus to the next component in tab order.
void focus_previous ()
 Set focus to the previous component in tab order.
void set_default (bool value)
 When set to true, this component will receive unhandled enter/return keypress messages.
void set_cancel (bool value)
 When set to true, this component will receive unhandled escape keypress messages.
void set_blocks_default_action (bool block)
 Set to true if this component, when focused, blocks the default action of the parent dialog.
void set_constant_repaint (bool enable)
 Enabled whether the GUI will constantly repaint this component when there are no other messages to process.
void load_css_layout (const CL_String &xml_filename, const CL_String &css_filename)
 Loads a layout from file.

Attributes



enum  IconPosition { icon_left, icon_top, icon_right, icon_bottom }
bool is_pushed () const
 Is Pushed.
bool is_toggle () const
 Is Toggle.
bool is_flat () const
 Is Flat.
CL_Image get_icon () const
 Get Icon.
IconPosition get_icon_position () const
 Get Icon position.
const CL_Stringget_text () const
CL_Size get_preferred_size () const
 Get Preferred size.
static CL_PushButtonget_named_item (CL_GUIComponent *reference_component, const CL_StringRef &id)
 Find the child CL_PushButton with the specified component ID name.

Attributes



enum  FocusPolicy { focus_refuse, focus_local, focus_group, focus_parent }
 

Focus policies.

More...
CL_Rect get_geometry () const
 Returns the position and size of the drawable area of the component.
int get_width () const
 Returns the width of the drawable area of the component.
int get_height () const
 Returns the height of the drawable area of the component.
CL_Size get_size () const
 Returns the size of the drawable area of the component.
CL_Rect get_window_geometry () const
 Returns the position and size of the component window (window frame, borders etc).
CL_StringRef get_type_name () const
 Returns the component type name.
CL_StringRef get_class_name () const
 Returns the component class name.
CL_StringRef get_id_name () const
 Returns the component ID name.
CL_StringRef get_element_name () const
 Returns the CSS element name for the component.
bool has_focus () const
 Returns true if the component has the focus.
bool get_allow_resize () const
 Returns true if the components size can be changed.
bool get_clip_children () const
 Returns true if the components children are clipped to the parent component when drawn.
FocusPolicy get_focus_policy () const
 Returns the focus policy of the component.
CL_StringRef get_component_group_name () const
 Returns the name of the component group, or an empty string if no group name has been set.
bool 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 get_blocks_default_action () const
 Returns true if this component, when focused, blocks the default action of its parent dialog.
CL_ResourceManager get_resources () const
 Returns the resource manager for the GUI resources.
CL_GUIManager get_gui_manager () const
 Returns the GUI manager owning this component.
CL_GUITheme get_theme () const
 Returns the theme used by this component.
const CL_GUIComponentget_parent_component () const
 Returns the parent component.
CL_GUIComponentget_parent_component ()
 Get Parent component.
const CL_GUIComponentget_owner_component () const
 Return the component owning this component.
CL_GUIComponentget_owner_component ()
 Get Owner component.
std::vector< CL_GUIComponent * > get_child_components () const
 Returns a list of the child components.
const CL_GUIComponentget_first_child () const
 Returns the first child component.
CL_GUIComponentget_first_child ()
 Get First child.
const CL_GUIComponentget_last_child () const
 Returns the last child component.
CL_GUIComponentget_last_child ()
 Get Last child.
CL_GUIComponentget_next_component_in_tree ()
 Returns the next component in the component tree, or 'this', if none found.
CL_GUIComponentget_previous_component_in_tree ()
 Returns the previous component in the component tree, or 'this', if none found.
std::vector< CL_GUIComponent * > get_child_component_group (const CL_String &group_name) const
 Returns a list of child components belonging to the specified group.
CL_GUIComponentget_group_selected_component ()
 Returns the selected item in a component group of which this component is a member.
CL_GUIComponentget_named_item (const CL_StringRef &id)
 Find child component with the specified component ID name.
bool has_child_components () const
 Returns true if the component has any child components.
const CL_GUIComponentget_previous_sibling () const
 Returns the previous sibling component.
CL_GUIComponentget_previous_sibling ()
 Get Previous sibling.
const CL_GUIComponentget_next_sibling () const
 Returns the next sibling component.
CL_GUIComponentget_next_sibling ()
 Get Next sibling.
bool is_descendant_of (CL_GUIComponent *component)
 Checks if this component is a descendant of target component.
bool is_ancestor_of (CL_GUIComponent *component)
 Checks if this component is the ancestor of target component.
const CL_GUIComponentget_top_level_component () const
 Returns the top level component this CL_GUIComponent is a child of.
CL_GUIComponentget_top_level_component ()
 Get Top level component.
CL_GraphicContextget_gc ()
 Return the graphic context for the component.
CL_InputContextget_ic ()
 Return the input context for the component.
bool is_enabled () const
 Return true if the component, and all its parents are enabled.
bool is_visible () const
 Return true if the component, and all its parents are visible.
bool is_active () const
 Returns true if the component is active.
CL_GUIComponentget_component_at (const CL_Point &point)
 Return the component under 'point', in local viewport coordinates.
int get_preferred_width () const
 Returns the preferred width of a render box.
int get_preferred_height () const
 Returns the preferred height of a render box.
CL_Point window_to_component_coords (const CL_Point &window_point) const
 Convert the top-level window client coordinates to component coordinates.
CL_Rect window_to_component_coords (const CL_Rect &window_rect) const
 Convert the top-level window client coordinates to component coordinates.
CL_Point component_to_window_coords (const CL_Point &component_point) const
 Convert the component coordinates to top-level window client coordinates.
CL_Rect component_to_window_coords (const CL_Rect &component_rect) const
 Convert the component coordinates to top-level window client coordinates.
CL_Point screen_to_component_coords (const CL_Point &screen_point) const
 Convert the screen coordinates to component coordinates.
CL_Point component_to_screen_coords (const CL_Point &component_point) const
 Convert the component coordinates to screen coordinates.
CL_GUILayout get_layout () const
 Returns the layout manager set for this component. Check CL_GUILayout.is_null() if none set.
CL_DisplayWindow get_display_window () const
 Returns the display window in which this component is hosted.
bool is_default ()
 Returns true if this component will receive unhandled enter/return keypress messages.
bool is_cancel ()
 Returns true if this component will receive unhandled escape keypress messages.
bool is_double_click_enabled () const
 Returns true if this component will generate double click messages.
bool get_constant_repaint () const
 Enabled whether the GUI will constantly repaint this component when there are no other messages to process.
CL_CSSLayout get_css_layout ()
 Gets the css layout.
CL_CSSLayoutElement get_css_element ()
 Gets the css element for this component.

Detailed Description

Push button component.


Member Enumeration Documentation

enum CL_GUIComponent::FocusPolicy [inherited]

Focus policies.

Enumerator:
focus_refuse 
focus_local 
focus_group 
focus_parent 
Enumerator:
icon_left 
icon_top 
icon_right 
icon_bottom 

Constructor & Destructor Documentation

CL_PushButton::CL_PushButton ( CL_GUIComponent parent  ) 

Constructs a PushButton.

Parameters:
parent = GUIComponent
virtual CL_PushButton::~CL_PushButton (  )  [virtual]

Member Function Documentation

void CL_GUIComponent::capture_mouse ( bool  capture  )  [inherited]

Make all mouse messages be redirected to this component.

void CL_GUIComponent::capture_proximity ( bool  capture  )  [inherited]

Make tablet proximity messages be redirected to this component.

CL_Point CL_GUIComponent::component_to_screen_coords ( const CL_Point component_point  )  const [inherited]

Convert the component coordinates to screen coordinates.

CL_Point CL_GUIComponent::component_to_window_coords ( const CL_Point component_point  )  const [inherited]

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

CL_Rect CL_GUIComponent::component_to_window_coords ( const CL_Rect component_rect  )  const [inherited]

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

void CL_GUIComponent::create_components ( const CL_DomDocument gui_xml  )  [inherited]

Create child components from a GUI definition file.

void CL_GUIComponent::create_components ( const CL_StringRef fullname  )  [inherited]

Create components.

Parameters:
fullname = String Ref
void CL_GUIComponent::create_components ( CL_IODevice file  )  [inherited]

Create components.

Parameters:
file = IODevice
void CL_GUIComponent::create_components ( const CL_StringRef filename,
const CL_VirtualDirectory dir 
) [inherited]

Create components.

Parameters:
filename = String Ref
dir = Virtual Directory
void CL_GUIComponent::delete_child_components (  )  [inherited]

Deletes all child components.

int CL_GUIComponent::exec (  )  [inherited]

Run component in modal mode.

void CL_GUIComponent::exit_with_code ( int  exit_code  )  [inherited]

Break message pump.

This function causes CL_GUIComponent::exec or CL_GUIManager::exec to exit with the given exit code.

void CL_GUIComponent::focus_next (  )  [inherited]

Set focus to the next component in tab order.

void CL_GUIComponent::focus_previous (  )  [inherited]

Set focus to the previous component in tab order.

CL_Callback_0<bool>& CL_GUIComponent::func_activated (  )  [inherited]
CL_Callback_v0& CL_PushButton::func_clicked (  ) 

Func clicked.

Returns:
Callback_v0
CL_Callback_0<bool>& CL_GUIComponent::func_close (  )  [inherited]

bool func_close()

Reimplemented in CL_MainWindow.

CL_Callback_v1<CL_Rect &>& CL_GUIComponent::func_constrain_resize (  )  [inherited]

void func_constrain_resize(CL_Rect &geometry)

virtual CL_Callback_2<CL_GUIComponent*, CL_GUIComponent*, CL_String>& CL_GUIComponent::func_create_custom_component (  )  [virtual, inherited]

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: CL_GUIComponent *Fooon_create_custom_component(CL_GUIComponent *parent, CL_String type);

CL_Callback_0<bool>& CL_GUIComponent::func_deactivated (  )  [inherited]
CL_Callback_v0& CL_GUIComponent::func_enablemode_changed (  )  [inherited]
CL_Callback_v1<CL_GUIMessage&>& CL_GUIComponent::func_filter_message (  )  [inherited]

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

CL_Callback_0<bool>& CL_GUIComponent::func_focus_gained (  )  [inherited]

bool func_focus_gained()

Reimplemented in CL_LineEdit, and CL_TextEdit.

CL_Callback_0<bool>& CL_GUIComponent::func_focus_lost (  )  [inherited]

bool func_focus_lost()

Reimplemented in CL_LineEdit, and CL_TextEdit.

CL_Callback_1<bool, const CL_InputEvent &>& CL_GUIComponent::func_input (  )  [inherited]

bool func_input(const CL_InputEvent &input_event)

CL_Callback_1<bool, const CL_InputEvent &>& CL_GUIComponent::func_input_doubleclick (  )  [inherited]

bool func_input_doubleclick(const CL_InputEvent &input_event)

CL_Callback_1<bool, const CL_InputEvent &>& CL_GUIComponent::func_input_pointer_moved (  )  [inherited]

bool func_input_pointer_moved(const CL_InputEvent &input_event)

CL_Callback_1<bool, const CL_InputEvent &>& CL_GUIComponent::func_input_pressed (  )  [inherited]

bool func_input_pressed(const CL_InputEvent &input_event)

CL_Callback_1<bool, const CL_InputEvent &>& CL_GUIComponent::func_input_released (  )  [inherited]

bool func_input_released(const CL_InputEvent &input_event)

CL_Callback_0<bool>& CL_GUIComponent::func_pointer_enter (  )  [inherited]
CL_Callback_0<bool>& CL_GUIComponent::func_pointer_exit (  )  [inherited]
CL_Callback_v1<CL_GUIMessage &>& CL_GUIComponent::func_process_message (  )  [inherited]

void func_process_message(const CL_GUIMessage &message)

CL_Callback_v2<CL_GraphicContext &, const CL_Rect &>& CL_GUIComponent::func_render (  )  [inherited]

void func_render(CL_GraphicContext &gc, const CL_Rect &clip_rect)

CL_Callback_v0& CL_GUIComponent::func_resized (  )  [inherited]

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

CL_Callback_v0& CL_GUIComponent::func_style_changed (  )  [inherited]
CL_Callback_v1<bool>& CL_GUIComponent::func_visibility_change (  )  [inherited]
bool CL_GUIComponent::get_allow_resize (  )  const [inherited]

Returns true if the components size can be changed.

bool CL_GUIComponent::get_blocks_default_action (  )  const [inherited]

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

std::vector<CL_GUIComponent*> CL_GUIComponent::get_child_component_group ( const CL_String group_name  )  const [inherited]

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

std::vector<CL_GUIComponent*> CL_GUIComponent::get_child_components (  )  const [inherited]

Returns a list of the child components.

CL_StringRef CL_GUIComponent::get_class_name (  )  const [inherited]

Returns the component class name.

bool CL_GUIComponent::get_clip_children (  )  const [inherited]

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

CL_GUIComponent* CL_GUIComponent::get_component_at ( const CL_Point point  )  [inherited]

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

CL_StringRef CL_GUIComponent::get_component_group_name (  )  const [inherited]

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

bool CL_GUIComponent::get_constant_repaint (  )  const [inherited]

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

CL_CSSLayoutElement CL_GUIComponent::get_css_element (  )  [inherited]

Gets the css element for this component.

CL_CSSLayout CL_GUIComponent::get_css_layout (  )  [inherited]

Gets the css layout.

CL_DisplayWindow CL_GUIComponent::get_display_window (  )  const [inherited]

Returns the display window in which this component is hosted.

CL_StringRef CL_GUIComponent::get_element_name (  )  const [inherited]

Returns the CSS element name for the component.

CL_GUIComponent* CL_GUIComponent::get_first_child (  )  [inherited]

Get First child.

Returns:
first_child
const CL_GUIComponent* CL_GUIComponent::get_first_child (  )  const [inherited]

Returns the first child component.

FocusPolicy CL_GUIComponent::get_focus_policy (  )  const [inherited]

Returns the focus policy of the component.

CL_GraphicContext& CL_GUIComponent::get_gc (  )  [inherited]

Return the graphic context for the component.

CL_Rect CL_GUIComponent::get_geometry (  )  const [inherited]

Returns the position and size of the drawable area of the component.

CL_GUIComponent* CL_GUIComponent::get_group_selected_component (  )  [inherited]

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

CL_GUIManager CL_GUIComponent::get_gui_manager (  )  const [inherited]

Returns the GUI manager owning this component.

int CL_GUIComponent::get_height (  )  const [inherited]

Returns the height of the drawable area of the component.

CL_InputContext& CL_GUIComponent::get_ic (  )  [inherited]

Return the input context for the component.

CL_Image CL_PushButton::get_icon (  )  const

Get Icon.

Returns:
icon
IconPosition CL_PushButton::get_icon_position (  )  const

Get Icon position.

Returns:
icon_position
CL_StringRef CL_GUIComponent::get_id_name (  )  const [inherited]

Returns the component ID name.

const CL_GUIComponent* CL_GUIComponent::get_last_child (  )  const [inherited]

Returns the last child component.

CL_GUIComponent* CL_GUIComponent::get_last_child (  )  [inherited]

Get Last child.

Returns:
last_child
CL_GUILayout CL_GUIComponent::get_layout (  )  const [inherited]

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

static CL_PushButton* CL_PushButton::get_named_item ( CL_GUIComponent reference_component,
const CL_StringRef id 
) [static]

Find the child CL_PushButton with the specified component ID name.

If it was not found, an exception is thrown.

CL_GUIComponent* CL_GUIComponent::get_named_item ( const CL_StringRef id  )  [inherited]

Find child component with the specified component ID name.

CL_GUIComponent* CL_GUIComponent::get_next_component_in_tree (  )  [inherited]

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

const CL_GUIComponent* CL_GUIComponent::get_next_sibling (  )  const [inherited]

Returns the next sibling component.

CL_GUIComponent* CL_GUIComponent::get_next_sibling (  )  [inherited]

Get Next sibling.

Returns:
next_sibling
const CL_GUIComponent* CL_GUIComponent::get_owner_component (  )  const [inherited]

Return the component owning this component.

Only top-level components has an owner.

CL_GUIComponent* CL_GUIComponent::get_owner_component (  )  [inherited]

Get Owner component.

Returns:
owner_component
const CL_GUIComponent* CL_GUIComponent::get_parent_component (  )  const [inherited]

Returns the parent component.

Only child components has a parent.

CL_GUIComponent* CL_GUIComponent::get_parent_component (  )  [inherited]

Get Parent component.

Returns:
parent_component
int CL_GUIComponent::get_preferred_height (  )  const [inherited]

Returns the preferred height of a render box.

Reimplemented in CL_ScrollBar.

CL_Size CL_PushButton::get_preferred_size (  )  const [virtual]

Get Preferred size.

Returns:
preferred_size

Reimplemented from CL_GUIComponent.

int CL_GUIComponent::get_preferred_width (  )  const [inherited]

Returns the preferred width of a render box.

Reimplemented in CL_ScrollBar.

CL_GUIComponent* CL_GUIComponent::get_previous_component_in_tree (  )  [inherited]

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

const CL_GUIComponent* CL_GUIComponent::get_previous_sibling (  )  const [inherited]

Returns the previous sibling component.

CL_GUIComponent* CL_GUIComponent::get_previous_sibling (  )  [inherited]

Get Previous sibling.

Returns:
previous_sibling
CL_ResourceManager CL_GUIComponent::get_resources (  )  const [inherited]

Returns the resource manager for the GUI resources.

CL_Size CL_GUIComponent::get_size (  )  const [inherited]

Returns the size of the drawable area of the component.

const CL_String& CL_PushButton::get_text (  )  const
CL_GUITheme CL_GUIComponent::get_theme (  )  const [inherited]

Returns the theme used by this component.

const CL_GUIComponent* CL_GUIComponent::get_top_level_component (  )  const [inherited]

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

CL_GUIComponent* CL_GUIComponent::get_top_level_component (  )  [inherited]

Get Top level component.

Returns:
top_level_component
CL_StringRef CL_GUIComponent::get_type_name (  )  const [inherited]

Returns the component type name.

int CL_GUIComponent::get_width (  )  const [inherited]

Returns the width of the drawable area of the component.

CL_Rect CL_GUIComponent::get_window_geometry (  )  const [inherited]

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

bool CL_GUIComponent::has_child_components (  )  const [inherited]

Returns true if the component has any child components.

bool CL_GUIComponent::has_focus (  )  const [inherited]

Returns true if the component has the focus.

bool CL_GUIComponent::is_active (  )  const [inherited]

Returns true if the component is active.

bool CL_GUIComponent::is_ancestor_of ( CL_GUIComponent component  )  [inherited]

Checks if this component is the ancestor of target component.

Returns:
true if target component is ancestor, false otherwise.
bool CL_GUIComponent::is_cancel (  )  [inherited]

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

bool CL_GUIComponent::is_default (  )  [inherited]

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

bool CL_GUIComponent::is_descendant_of ( CL_GUIComponent component  )  [inherited]

Checks if this component is a descendant of target component.

Returns:
true if target component is descendant, false otherwise.
bool CL_GUIComponent::is_double_click_enabled (  )  const [inherited]

Returns true if this component will generate double click messages.

bool CL_GUIComponent::is_enabled (  )  const [inherited]

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

bool CL_PushButton::is_flat (  )  const

Is Flat.

Returns:
true = flat
bool CL_PushButton::is_pushed (  )  const

Is Pushed.

Returns:
true = pushed
bool CL_GUIComponent::is_selected_in_group (  )  const [inherited]

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

bool CL_PushButton::is_toggle (  )  const

Is Toggle.

Returns:
true = toggle
bool CL_GUIComponent::is_visible (  )  const [inherited]

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

void CL_GUIComponent::load_css_layout ( const CL_String xml_filename,
const CL_String css_filename 
) [inherited]

Loads a layout from file.

void CL_GUIComponent::paint ( const CL_Rect clip_rect  )  [inherited]

Paint.

Parameters:
clip_rect = Rect
void CL_GUIComponent::paint (  )  [inherited]

Paints the component.

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

void CL_GUIComponent::pop_cliprect ( CL_GraphicContext gc  )  [inherited]

Pop a clipping rectangle.

void CL_GUIComponent::push_cliprect ( CL_GraphicContext gc,
const CL_Rect rect 
) [inherited]

Push a clipping rectangle.

void CL_GUIComponent::render ( CL_GraphicContext gc,
const CL_Rect clip_rect,
bool  include_children = true 
) [inherited]

Renders the component and its children.

void CL_GUIComponent::request_repaint (  )  [inherited]
void CL_GUIComponent::request_repaint ( CL_Rect  rect  )  [inherited]

Request repaint.

Parameters:
rect = Rect
void CL_GUIComponent::reset_cliprect ( CL_GraphicContext gc  )  [inherited]

Reset the clipping rectangle.

CL_Point CL_GUIComponent::screen_to_component_coords ( const CL_Point screen_point  )  const [inherited]

Convert the screen coordinates to component coordinates.

void CL_GUIComponent::set_blocks_default_action ( bool  block  )  [inherited]

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

void CL_GUIComponent::set_cancel ( bool  value  )  [inherited]

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 CL_GUIComponent::set_class_name ( const CL_StringRef name  )  [inherited]

Sets the component class name. (csstype.cssclass::cssid).

void CL_GUIComponent::set_clip_children ( bool  clip = true,
const CL_Rect clip_rect = CL_Rect(0, 0, 0, 0) 
) [inherited]

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

void CL_GUIComponent::set_cliprect ( CL_GraphicContext gc,
const CL_Rect rect 
) [inherited]

Set a clipping rectangle.

void CL_GUIComponent::set_component_group_name ( const CL_StringRef str  )  [inherited]

Set group name.

Parameters:
str = String Ref
void CL_GUIComponent::set_constant_repaint ( bool  enable  )  [inherited]

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

void CL_GUIComponent::set_cursor ( const CL_Cursor cursor  )  [inherited]

Sets the current cursor icon.

void CL_GUIComponent::set_cursor ( enum CL_StandardCursor  type  )  [inherited]

Set cursor.

Parameters:
type = CL_StandardCursor
void CL_GUIComponent::set_default ( bool  value  )  [inherited]

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 CL_GUIComponent::set_double_click_enabled ( bool  enable  )  [inherited]

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

void CL_GUIComponent::set_enabled ( bool  enable = true  )  [inherited]

Sets the component as enabled or disabled.

void CL_PushButton::set_flat ( bool  enable  ) 

Set flat.

Parameters:
enable = bool
void CL_GUIComponent::set_focus ( bool  enable = true  )  [inherited]

Set this component focus.

Parameters:
enable = true = To set the focus. false = Loose the focus (if in focus)
void CL_GUIComponent::set_focus_policy ( FocusPolicy  policy  )  [inherited]

Sets the focus policy of the component.

void CL_GUIComponent::set_geometry ( CL_Rect  geometry  )  [inherited]

Set component position and size.

void CL_PushButton::set_icon ( const CL_Image icon  ) 

Set icon.

Parameters:
icon = Image
void CL_PushButton::set_icon_position ( IconPosition  pos  ) 

Set icon position.

Parameters:
pos = Icon Position
void CL_GUIComponent::set_id_name ( const CL_StringRef name  )  [inherited]

Sets the component ID name. (csstype.cssclass::cssid).

void CL_GUIComponent::set_layout ( CL_GUILayout layout  )  [inherited]

Set a layout on the component.

void CL_GUIComponent::set_parent_component ( CL_GUIComponent new_parent  )  [inherited]

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

void CL_PushButton::set_pushed ( bool  enable  ) 

Set pushed.

Parameters:
enable = bool
void CL_GUIComponent::set_selected_in_component_group ( bool  selected  )  [inherited]

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

void CL_PushButton::set_text ( const CL_StringRef text  ) 

Set text.

Parameters:
text = String Ref
void CL_PushButton::set_toggle ( bool  enable  ) 

Set toggle.

Parameters:
enable = bool
void CL_GUIComponent::set_type_name ( const CL_StringRef name  )  [inherited]

Sets the component type name. (csstype.cssclass::cssid).

void CL_GUIComponent::set_visible ( bool  visible = true,
bool  activate_root_win = true 
) [inherited]

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 CL_GUIComponent::set_window_geometry ( CL_Rect  geometry  )  [inherited]

Set component window position and size.

CL_Rect CL_GUIComponent::window_to_component_coords ( const CL_Rect window_rect  )  const [inherited]

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

CL_Point CL_GUIComponent::window_to_component_coords ( const CL_Point window_point  )  const [inherited]

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


The documentation for this class was generated from the following file: