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

Class for OptionButton gadget template. More...

#include <resoptionbutton.h>

Inheritance diagram for tbx::res::ResOptionButton:
tbx::res::ResGadget tbx::res::ResBase

Public Types

enum  { TYPE_ID = 192 }
 

Public Member Functions

 ResOptionButton (const ResGadget &other)
 Construct an option button gadget resource. More...
 
 ResOptionButton (const ResOptionButton &other)
 Construct an option button gadget resource. More...
 
ResOptionButtonoperator= (const ResGadget &other)
 Assign from a ResGadget. More...
 
ResOptionButtonoperator= (const ResOptionButton &other)
 Assign from another option button gadget resource. More...
 
 ResOptionButton ()
 Construct a option button gadget resource. More...
 
bool generate_state_changed () const
 Check if state change message will be generated. More...
 
void generate_state_changed (bool value)
 Set if state change message will be generated. More...
 
bool on () const
 Check if option is on. More...
 
void on (bool value)
 Set state of option button. More...
 
const char * label () const
 Get the label for the option button. More...
 
void label (const char *value, int max_length=-1)
 Set the label for the option button. More...
 
void label (const std::string &value, int max_length=-1)
 Set the label for the option button. More...
 
int max_label_len () const
 Get the maximum length of the label text. More...
 
int event_id () const
 Get the event ID generated when the state changes. More...
 
void event_id (int value)
 Set the event ID generated when the state changes. More...
 
- Public Member Functions inherited from tbx::res::ResGadget
 ResGadget (const ResGadget &other)
 Construct a resource gadget as a copy of another. More...
 
ResGadgetoperator= (const ResGadget &other)
 Assign a resource gadget as a copy of another. More...
 
 ResGadget (int type, int size)
 Construct an empty gadget of the given type and size. More...
 
void check_type (int type) const
 Check if this gadgets type is as specified. More...
 
unsigned int flags () const
 Get all flags as a word raw access. More...
 
void flags (unsigned int value)
 Set all flags as a word. More...
 
bool back () const
 Check if gadget is at the back (created first) More...
 
void back (bool value)
 Set if gadget should be at the back. More...
 
bool faded () const
 Check if the gadget is faded. More...
 
void faded (bool value)
 Set if the gadget is faded. More...
 
unsigned short type () const
 Get the gadget type. More...
 
unsigned short stored_size () const
 Get the size stored in template. More...
 
int size () const
 Size of gadget (including header). More...
 
int xmin () const
 Get the minimum x coordinate of the gadget's bounding box. More...
 
void xmin (int x)
 Set the minimum x coordinate of the gadget's bounding box. More...
 
int ymin () const
 Get the minimum y coordinate of the gadget's bounding box. More...
 
void ymin (int y)
 Set the minimum y coordinate of the gadget's bounding box. More...
 
int xmax () const
 Get the maximum x coordinate of the gadget's bounding box. More...
 
void xmax (int x)
 Set the maximum x coordinate of the gadget's bounding box. More...
 
int ymax () const
 Get the maximum y coordinate of the gadget's bounding box. More...
 
void ymax (int y)
 Set the maximum y coordinate of the gadget's bounding box. More...
 
ComponentId component_id () const
 Get the Component ID. More...
 
void component_id (ComponentId value)
 Set the Component ID. More...
 
const char * help_message () const
 Get the help message for the gadget. More...
 
void help_message (const char *msg, int max_length=-1)
 Set the help message for the gadget. More...
 
void help_message (const std::string &msg, int max_length=-1)
 Set the help message for the gadget. More...
 
int max_help () const
 Max size of message.
 
- Public Member Functions inherited from tbx::res::ResBase
 ResBase (const ResBase &other)
 Copy constructor. More...
 
virtual ~ResBase ()
 Destructor.
 
ResBaseoperator= (const ResBase &other)
 Assignment. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from tbx::res::ResGadget
static int gadget_size (unsigned int type_and_size)
 Get gadget size given its type and size value. More...
 
- Protected Member Functions inherited from tbx::res::ResGadget
void make_writeable ()
 Make item writeable.
 
- Protected Member Functions inherited from tbx::res::ResBase
 ResBase (ResImpl *impl)
 Create from internal resource implementation. More...
 
const char * string (int offset) const
 Return a string at the given offset. More...
 
void string (int offset, const char *value)
 Set a string at the given offset. More...
 
void string (int offset, std::string value)
 Set a string at the given offset. More...
 
void string_with_length (int offset, const char *value, int length=-1)
 Assign a string where the length is at offset+4. More...
 
void string_with_length (int offset, const std::string &value, int length=-1)
 Assign a string where the length is at offset+4. More...
 
const char * message (int offset) const
 Get the message string at the given offset. More...
 
void message (int offset, const char *value)
 Set a message at the given offset. More...
 
void message (int offset, std::string value)
 Set a message at the given offset. More...
 
void message_with_length (int offset, const char *value, int length=-1)
 Assign a message where the length is at offset+4. More...
 
void message_with_length (int offset, const std::string &value, int length=-1)
 Assign a message where the length is at offset+4. More...
 
int int_value (int offset) const
 Get an integer value. More...
 
void int_value (int offset, int value)
 Set a number at the specified offset. More...
 
unsigned int uint_value (int offset) const
 Get an unsigned integer value. More...
 
void uint_value (int offset, unsigned int value)
 Set an unsigned number at the specified offset. More...
 
unsigned char byte_value (int offset) const
 Get a byte value. More...
 
void byte_value (int offset, unsigned char value)
 Set an unsigned byte (8 bit value) at the specified offset. More...
 
unsigned short ushort_value (int offset) const
 Get a unsigned short value. More...
 
void ushort_value (int offset, unsigned short value)
 Set an unsigned short (16 bit value) at the specified offset. More...
 
bool flag (int offset, int mask) const
 Check if any of the bits in a mask are set. More...
 
void flag (int offset, int mask, bool on)
 Set/clear the bits in mask. More...
 
int flag_value (int offset, int mask) const
 Get the bits for the given mask. More...
 
void flag_value (int offset, int mask, int value)
 Set bits in given mask clearing others. More...
 
void init_string (int offset, const char *value)
 Initialise a string in a constructor helper. More...
 
void init_message (int offset, const char *value)
 Initialise a message in a constructor helper. More...
 
void init_sprite_area_ref (int offset)
 Initialise a sprite area reference. More...
 
void init_object_ref (int offset)
 Initialise an object reference. More...
 
- Protected Attributes inherited from tbx::res::ResBase
ResImpl * _impl
 Internal Resource implementation.
 

Detailed Description

Class for OptionButton gadget template.

Constructor & Destructor Documentation

tbx::res::ResOptionButton::ResOptionButton ( const ResGadget other)
inline

Construct an option button gadget resource.

Parameters
otherResGadget to copy resource from
Exceptions
ResGadgetTypeMismatchif the ResGadget is not an option button
tbx::res::ResOptionButton::ResOptionButton ( const ResOptionButton other)
inline

Construct an option button gadget resource.

Parameters
otheroption button to copy resource from
tbx::res::ResOptionButton::ResOptionButton ( )
inline

Construct a option button gadget resource.

All options are false, events unset and messages are null.

Member Function Documentation

int tbx::res::ResOptionButton::event_id ( ) const
inline

Get the event ID generated when the state changes.

Returns
event ID set by user or 0 for the default event
void tbx::res::ResOptionButton::event_id ( int  value)
inline

Set the event ID generated when the state changes.

Parameters
valueevent ID set by user or 0 for the default event
bool tbx::res::ResOptionButton::generate_state_changed ( ) const
inline

Check if state change message will be generated.

Returns
true if state change message will be generated
void tbx::res::ResOptionButton::generate_state_changed ( bool  value)
inline

Set if state change message will be generated.

Parameters
valueset to true if state change message should be generated
const char* tbx::res::ResOptionButton::label ( ) const
inline

Get the label for the option button.

Returns
pointer to zero terminated label text or 0 if none
void tbx::res::ResOptionButton::label ( const char *  value,
int  max_length = -1 
)
inline

Set the label for the option button.

Parameters
valuepointer to zero terminated label text or 0 if none
max_lengthmaximum length the label text can be changed to or -1 (the default) to use the length of value.
void tbx::res::ResOptionButton::label ( const std::string &  value,
int  max_length = -1 
)
inline

Set the label for the option button.

Parameters
valuepointer to zero terminated label text
max_lengthmaximum length the label text can be changed to or -1 (the default) to use the length of value.
int tbx::res::ResOptionButton::max_label_len ( ) const
inline

Get the maximum length of the label text.

Returns
maximum label text length
bool tbx::res::ResOptionButton::on ( ) const
inline

Check if option is on.

Returns
true if option is on
void tbx::res::ResOptionButton::on ( bool  value)
inline

Set state of option button.

Parameters
valuetrue to turn the option on
ResOptionButton& tbx::res::ResOptionButton::operator= ( const ResGadget other)
inline

Assign from a ResGadget.

Parameters
otherResGadget to copy
Exceptions
ResGadgetTypeMismatchif the ResGadget is not an option button
ResOptionButton& tbx::res::ResOptionButton::operator= ( const ResOptionButton other)
inline

Assign from another option button gadget resource.

Parameters
otheroption button gadget resource to copy

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