tbx  0.7.3
Public Types | Public Member Functions | List of all members
tbx::ActionButton Class Reference

ActionButton wrapper for an underlying toolbox ActionButton gadget. More...

#include <actionbutton.h>

Inheritance diagram for tbx::ActionButton:
tbx::Gadget tbx::Component

Public Types

enum  { TOOLBOX_CLASS = 128 }
 

Public Member Functions

 ActionButton ()
 Construct an uninitialised display field.
 
 ActionButton (const ActionButton &other)
 Construct a action button from another action button. More...
 
 ActionButton (const Gadget &other)
 Construct a action button from another gadget. More...
 
 ActionButton (const Component &other)
 Construct a action button from a gadget. More...
 
ActionButtonoperator= (const ActionButton &other)
 Assign a action button to refer to the same underlying toolbox gadget as another.
 
ActionButtonoperator= (const Gadget &other)
 Assign a action button to refer to the same underlying toolbox gadget as an existing Gadget. More...
 
ActionButtonoperator= (const Component &other)
 Assign a action button to refer to the same underlying toolbox component as an existing Gadget. More...
 
bool operator== (const Gadget &other) const
 Check if this action button refers to the same underlying toolbox gadget as another gadget. More...
 
bool operator!= (const Gadget &other) const
 Check if this action button refers to the same underlying toolbox gadget as another gadget. More...
 
void text (const std::string &value)
 Set the the text to display.
 
std::string text () const
 Get the the text this is being displayed.
 
int text_length () const
 Get the length of the text property. More...
 
void event (int code)
 Set the event to be raised when this action button is clicked.
 
int event () const
 Get the event that will be raised when this action button is clicked.
 
void click_show (const Object &object, bool transient=false)
 Set object to show when the button is clicked. More...
 
void clear_click_show ()
 Clear object shown on click.
 
bool has_click_show () const
 Check if action button will show an object. More...
 
Object click_show (bool *transient=0)
 Get object shown on a click. More...
 
void add_selected_listener (ButtonSelectedListener *listener)
 Add listener for button selected with the select or adjust mouse buttons or the keyboard (return or escape)
 
void remove_selected_listener (ButtonSelectedListener *listener)
 Remove listener for button selected with the select or adjust mouse buttons or the keyboard (return or escape)
 
void add_selected_command (Command *command)
 Add command to be run if the button is selected with the select or adjust mouse buttons or the keyboard (return or escape)
 
void remove_selected_command (Command *command)
 Remove command to be run if the button is selected with the select or adjust mouse buttons or the keyboard (return or escape)
 
void add_select_command (Command *command)
 Add command to be run if the button is selected with the select mouse button or the keyboard (return or escape)
 
void remove_select_command (Command *command)
 Remove command to be run if the button is selected with the select mouse button or the keyboard (return or escape)
 
void add_adjust_command (Command *command)
 Add command to be run if the button is selected with the adjust mouse button only.
 
void remove_adjust_command (Command *command)
 Remove command to be run if the button is selected with the adjust mouse button only.
 
- Public Member Functions inherited from tbx::Gadget
 Gadget ()
 Construct an uninitialised gadget. More...
 
 Gadget (const Gadget &other)
 Construct a gadget as a copy of another gadget object. More...
 
 Gadget (const Component &other)
 Construct a gadget as a copy of another component object. More...
 
Window window ()
 Get the window that contains this gadget.
 
Window window () const
 Get the window that contains this gadget.
 
Gadgetoperator= (const Gadget &other)
 Assign this gadget to refer to the same underlying toolbox gadget as another gadget.
 
Gadgetoperator= (const Component &other)
 Assign this gadget to refer to the same underlying toolbox gadget as the specified Component. More...
 
bool operator== (const Component &other) const
 Check if this gadget refers to the same underlying toolbox component as the given Component. More...
 
bool operator!= (const Component &other) const
 Check if this gadget refers to the same underlying toolbox component as the given Component. More...
 
bool operator== (const Gadget &other) const
 Check if this gadget refers to the same underlying toolbox component as the given Gadget. More...
 
bool operator!= (const Gadget &other) const
 Check if this gadget refers to the same underlying toolbox component as the given Gadget. More...
 
void check_toolbox_class (int class_id) const
 Check the underlying gadget class for this object has the given class id. More...
 
int toolbox_class () const
 Get the toolbox class for a gadget. More...
 
int toolbox_class_and_size () const
 Get the toolbox class and size for a gadget. More...
 
unsigned int flags () const
 Return the gadget flags. More...
 
void set_flag (unsigned int set)
 Sets bits in the gadgets flags. More...
 
void clear_flag (unsigned int clear)
 Clear bits in the gadget flags. More...
 
void fade ()
 Fade the gadget.
 
void unfade ()
 Clear the gadgets fade state.
 
void fade (bool fade)
 Fade/unfade the gadget. More...
 
bool faded () const
 Check if the gadget is faded. More...
 
void focus ()
 Set input focus to the gadget. More...
 
std::vector< IconHandleicon_list ()
 Get list of icons used in this gadget. More...
 
BBox bounds () const
 Get the bounding box of the gadget.
 
void bounds (const BBox &bounds)
 Set the bounds of the gadget. More...
 
Point bottom_left () const
 Get the bottom left location of gadget. More...
 
Point top_left () const
 Get the top left location of gadget. More...
 
void move_to (const Point &pos)
 Move gadget (without resizing) More...
 
void move_to (int x, int y)
 Move gadget without resizing. More...
 
void move_by (int bx, int by)
 Move gadget relative to it's current position without resizing. More...
 
Size size () const
 Return the size of the gadget. More...
 
void size (const Size &sz)
 Set size of gadget without moving it. More...
 
void add_loader (Loader *loader, int file_type=-2)
 Add a file loader. More...
 
void remove_loader (Loader *loader, int file_type=-2)
 Remove a file loader. More...
 
- Public Member Functions inherited from tbx::Component
 Component ()
 Construct an uninitialised component. More...
 
 Component (Object obj, ComponentId id)
 Construct a component from an object and component id. More...
 
 Component (ObjectId handle, ComponentId id)
 Construct a component from an object handle and component id. More...
 
bool null () const
 Check if this component is in an uninitialised state. More...
 
Object object ()
 Return the object his component belongs to.
 
Object object () const
 Return the object his component belongs to.
 
ObjectId handle () const
 Return the object handle for his component.
 
ComponentId id () const
 Get the component ID of this component. More...
 
Componentoperator= (const Component &other)
 Assign the Component to refer to the same underlying toolbox component.
 
bool operator== (const Component &other) const
 Check if this component refers to the same underlying toolbox component. More...
 
bool operator!= (const Component &other) const
 Check if this component refers to the same underlying toolbox gadget. More...
 
void add_command (int command_id, Command *command)
 Add a command to this Component. More...
 
void remove_command (int command_id, Command *command)
 Remove a command from this component. More...
 
void add_user_event_listener (int event_id, UserEventListener *listener)
 Add a user event listener. More...
 
void remove_user_event_listener (int event_id, UserEventListener *listener)
 Remove a user event listener from this component. More...
 
void remove_all_listeners ()
 Remove all the listeners on this component. More...
 

Additional Inherited Members

- Protected Member Functions inherited from tbx::Component
void add_listener (int action, Listener *listener, RawToolboxEventHandler handler)
 Helper function to add listeners to this component. More...
 
void remove_listener (int action, Listener *listener)
 Helper function to remove listeners from this component.
 
void add_window_listener (int event_code, Listener *listener)
 Helper function to add a listener for a WIMP window event.
 
void remove_window_listener (int event_code, Listener *listener)
 Helper function to remove a listener for a WIMP window event.
 
int int_property (int property_id) const
 Get an integer property from the toolbox Component. More...
 
void int_property (int property_id, int value)
 Set an integer property from the toolbox object. More...
 
bool bool_property (int property_id) const
 Get a boolean property from the toolbox Component. More...
 
void bool_property (int property_id, bool value)
 Set a boolean property from the toolbox object. More...
 
std::string string_property (int property_id) const
 Get a string property from the toolbox object. More...
 
int string_property_length (int property_id) const
 Get a the length of a string property from the toolbox object. More...
 
void string_property (int property_id, const std::string &value)
 Set a string property in the toolbox object. More...
 
bool flag_property (int property_id, int flag) const
 Check if a particular flag is set in a property. More...
 
void flag_property (int property_id, int flag, bool value)
 Set a particular flag in a property. More...
 
- Protected Attributes inherited from tbx::Component
ObjectId _handle
 Underlying toolbox handle.
 
int _id
 Underlying toolbox component id.
 

Detailed Description

ActionButton wrapper for an underlying toolbox ActionButton gadget.

An ActionButton a gadget that shows a button with text in a Window.

Constructor & Destructor Documentation

tbx::ActionButton::ActionButton ( const ActionButton other)
inline

Construct a action button from another action button.

Both ActionButton will refer to the same underlying toolbox gadget.

tbx::ActionButton::ActionButton ( const Gadget other)
inline

Construct a action button from another gadget.

The ActionButton and the Gadget will refer to the same underlying toolbox gadget.

Exceptions
GadgetClassErrorif the underlying toolbox gadget isn't a action button
tbx::ActionButton::ActionButton ( const Component other)
inline

Construct a action button from a gadget.

The ActionButton and the Component will refer to the same underlying toolbox component.

Member Function Documentation

void tbx::ActionButton::click_show ( const Object object,
bool  transient = false 
)

Set object to show when the button is clicked.

Parameters
objectobject to show
transientshow transiently (default false)
Object tbx::ActionButton::click_show ( bool *  transient = 0)

Get object shown on a click.

Parameters
transientif used will return the transient state
Returns
Object that will be shown. Can be null() object if nothing shown
bool tbx::ActionButton::has_click_show ( ) const

Check if action button will show an object.

Returns
true if action button will show an object
bool tbx::ActionButton::operator!= ( const Gadget other) const
inline

Check if this action button refers to the same underlying toolbox gadget as another gadget.

Returns
true if they do not refer to the same underlying toolbox gadget.
ActionButton& tbx::ActionButton::operator= ( const Gadget other)
inline

Assign a action button to refer to the same underlying toolbox gadget as an existing Gadget.

Exceptions
GadgetClassErrorif the underlying toolbox gadget isn't a action button
ActionButton& tbx::ActionButton::operator= ( const Component other)
inline

Assign a action button to refer to the same underlying toolbox component as an existing Gadget.

Exceptions
ObjectClassErrorif the component is not in a window.
GadgetClassErrorif the underlying toolbox gadget isn't a action button
bool tbx::ActionButton::operator== ( const Gadget other) const
inline

Check if this action button refers to the same underlying toolbox gadget as another gadget.

Returns
true if they refer to the same underlying toolbox gadget.
int tbx::ActionButton::text_length ( ) const
inline

Get the length of the text property.

Returns
Number of characters for this property

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