tbx  0.7.5
Public Types | Public Member Functions | List of all members
tbx::OptionButton Class Reference

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

#include <optionbutton.h>

Inheritance diagram for tbx::OptionButton:
tbx::Gadget tbx::Component

Public Types

enum  { TOOLBOX_CLASS = 192 }
 

Public Member Functions

 OptionButton ()
 Construct an uninitialised option button.
 
 OptionButton (const OptionButton &other)
 Construct a option button from another option button. More...
 
 OptionButton (const Gadget &other)
 Construct a option button from another gadget. More...
 
 OptionButton (const Component &other)
 Construct a option button from a gadget. More...
 
OptionButtonoperator= (const OptionButton &other)
 Assign a option button to refer to the same underlying toolbox gadget as another.
 
OptionButtonoperator= (const Gadget &other)
 Assign a option button to refer to the same underlying toolbox gadget as an existing Gadget. More...
 
OptionButtonoperator= (const Component &other)
 Assign a option button to refer to the same underlying toolbox component as an existing Gadget. More...
 
bool operator== (const Gadget &other) const
 Check if this option button refers to the same underlying toolbox gadget as another gadget. More...
 
bool operator!= (const Gadget &other) const
 Check if this option button refers to the same underlying toolbox gadget as another gadget. More...
 
void label (const std::string &value)
 Set the the label. More...
 
std::string label () const
 Get the the label. More...
 
int label_length () const
 Get the length of the label. More...
 
void event (int code)
 Set the event to be raised when this option button is clicked. More...
 
int event () const
 Get the event that will be raised when this option button is clicked. More...
 
void on (bool value)
 Turn option button on or off. More...
 
bool on () const
 Check if option button is on. More...
 
void add_state_listener (OptionButtonStateListener *listener)
 Add listener for option button state changed. More...
 
void remove_state_listener (OptionButtonStateListener *listener)
 Remove listener for option button state changed. More...
 
- 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

OptionButton wrapper for an underlying toolbox OptionButton gadget.

An OptionButton a gadget that shows a check mark and is either on or off.

Constructor & Destructor Documentation

◆ OptionButton() [1/3]

tbx::OptionButton::OptionButton ( const OptionButton other)
inline

Construct a option button from another option button.

Both OptionButton will refer to the same underlying toolbox gadget.

◆ OptionButton() [2/3]

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

Construct a option button from another gadget.

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

Exceptions
GadgetClassErrorif the underlying toolbox gadget isn't a option button

◆ OptionButton() [3/3]

tbx::OptionButton::OptionButton ( const Component other)
inline

Construct a option button from a gadget.

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

Member Function Documentation

◆ add_state_listener()

void tbx::OptionButton::add_state_listener ( OptionButtonStateListener listener)

Add listener for option button state changed.

i.e. goes from on to off or off to on

Parameters
listenerlistener to add

◆ event() [1/2]

void tbx::OptionButton::event ( int  code)
inline

Set the event to be raised when this option button is clicked.

Parameters
codeNew event code

◆ event() [2/2]

int tbx::OptionButton::event ( ) const
inline

Get the event that will be raised when this option button is clicked.

Returns
event code

◆ label() [1/2]

void tbx::OptionButton::label ( const std::string &  value)
inline

Set the the label.

Parameters
valuenew value for the label

◆ label() [2/2]

std::string tbx::OptionButton::label ( ) const
inline

Get the the label.

Returns
current value for the label

◆ label_length()

int tbx::OptionButton::label_length ( ) const
inline

Get the length of the label.

Returns
Number of characters for the label buffer

◆ on() [1/2]

void tbx::OptionButton::on ( bool  value)
inline

Turn option button on or off.

Parameters
valuetrue to turn the option button on

◆ on() [2/2]

bool tbx::OptionButton::on ( ) const
inline

Check if option button is on.

Returns
true if the option button is on

◆ operator!=()

bool tbx::OptionButton::operator!= ( const Gadget other) const
inline

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

Returns
true if they do not refer to the same underlying toolbox gadget.

◆ operator=() [1/2]

OptionButton& tbx::OptionButton::operator= ( const Gadget other)
inline

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

Exceptions
GadgetClassErrorif the underlying toolbox gadget isn't a option button

◆ operator=() [2/2]

OptionButton& tbx::OptionButton::operator= ( const Component other)
inline

Assign a option 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 option button

◆ operator==()

bool tbx::OptionButton::operator== ( const Gadget other) const
inline

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

Returns
true if they refer to the same underlying toolbox gadget.

◆ remove_state_listener()

void tbx::OptionButton::remove_state_listener ( OptionButtonStateListener listener)

Remove listener for option button state changed.

Parameters
listenerlistener to remove

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