libt3widget
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups
List of all members | Public Member Functions
t3_widget::button_t Class Reference

Button widget. More...

Inheritance diagram for t3_widget::button_t:
t3_widget::widget_t t3_widget::focus_widget_t t3_widget::window_component_t t3_widget::mouse_target_t t3_widget::window_component_t

Public Member Functions

 button_t (const char *_text, bool _is_default=false)
 Create a button_t.
int get_width (void)
 Retrieve this button_t's width.
virtual bool is_hotkey (key_t key)
 Query whether key is a hotkey for this widget.
virtual bool process_key (key_t key)
virtual bool process_mouse_event (mouse_event_t event)
 Process a mouse event.
virtual void set_focus (focus_t focus)
virtual bool set_size (optint height, optint width)
 Set the size of this button_t.
 T3_WIDGET_SIGNAL (activate, void)
 Signal emitted when the button is pressed.
virtual void update_contents (void)
- Public Member Functions inherited from t3_widget::widget_t
virtual bool accepts_focus (void)
 Query whether this widget accepts focus.
virtual void force_redraw (void)
virtual void hide (void)
virtual bool is_enabled (void)
 Query the enabled status of this widget.
virtual bool is_shown (void)
 Query the visibility status of this widget.
virtual void set_anchor (window_component_t *anchor, int relation)
 Set this widget's anchor.
virtual void set_enabled (bool enable)
 Set the enabled status of this widget.
virtual void set_position (optint top, optint left)
virtual void show (void)
- Public Member Functions inherited from t3_widget::window_component_t
virtual void force_redraw (void)=0
 Request that this window_component_t be completely redrawn.
virtual t3_window_t * get_base_window (void)
 Retrieve the t3_window_t for this window_component_t.
virtual void hide (void)=0
 Hide the window_component_t.
virtual bool process_key (key_t key)=0
 Handle a key press by the user.
virtual void set_focus (focus_t focus)=0
 Set whether this window_component_t has the input focus.
virtual void set_position (optint top, optint left)=0
 Move the window_component_t to a specified position.
virtual bool set_size (optint height, optint width)=0
 Set the size of this window_component_t.
virtual void show (void)=0
 Display the window_component_t.
virtual void update_contents (void)=0
 Update the contents of the window.
 window_component_t (void)
 Base constructor.
virtual ~window_component_t (void)
 Base destructor.
- Public Member Functions inherited from t3_widget::mouse_target_t
void grab_mouse (void)
 Grab all future mouse events.
void register_mouse_target (t3_window_t *target)
 Register a window to receive mouse events.
void release_mouse_grab (void)
 Release a previous mouse grab.
void unregister_mouse_target (t3_window_t *target)
 Unregister a window to receive mouse events.

Additional Inherited Members

- Public Types inherited from t3_widget::window_component_t
enum  focus_t {
  FOCUS_OUT, FOCUS_SET, FOCUS_IN_FWD, FOCUS_IN_BCK,
  FOCUS_REVERT
}
- Static Public Member Functions inherited from t3_widget::mouse_target_t
static bool handle_mouse_event (mouse_event_t event)
- Protected Member Functions inherited from t3_widget::widget_t
void init_unbacked_window (int height, int width, bool register_as_mouse_target=false)
 Initialize the window with an unbacked t3_window_t with height and width.
void init_window (int height, int width, bool register_as_mouse_target=true)
 Initialize the window with a t3_window_t with height and width.
 widget_t (int height, int width, bool register_as_mouse_target=true)
 Constructor which creates a default t3_window_t with height and width.
 widget_t (void)
 Constructor which does not create a default t3_window_t.
- Protected Attributes inherited from t3_widget::widget_t
bool enabled
 Widget is enabled.
bool redraw
 Widget requires redrawing on next update_contents call.
bool shown
 Widget is shown.

Detailed Description

Button widget.

Constructor & Destructor Documentation

t3_widget::button_t::button_t ( const char *  _text,
bool  _is_default = false 
)

Create a button_t.

Parameters
_textThe text to show on the button.
_is_defaultBoolean indicating whether this button should be drawn as the default button.

The _text is used to initialize a smart_label_text_t, therefore the character following the underscore will be highlighted.

Member Function Documentation

int t3_widget::button_t::get_width ( void  )

Retrieve this button_t's width.

bool t3_widget::button_t::is_hotkey ( key_t  key)
virtual

Query whether key is a hotkey for this widget.

Reimplemented from t3_widget::widget_t.

bool t3_widget::button_t::process_mouse_event ( mouse_event_t  event)
virtual

Process a mouse event.

Returns
A boolean indicating whether this mouse_target_t handled the mouse event.

Reimplemented from t3_widget::widget_t.

bool t3_widget::button_t::set_size ( optint  height,
optint  width 
)
virtual

Set the size of this button_t.

The height parameter is ignored. If width is negative, the natural size of the button_t based on the text width is used.

t3_widget::button_t::T3_WIDGET_SIGNAL ( activate  ,
void   
)

Signal emitted when the button is pressed.