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

Class for ActionButton gadget template. More...

#include <resactionbutton.h>

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

Public Types

enum  { TYPE_ID = 128 }
 

Public Member Functions

 ResActionButton (const ResGadget &other)
 Construct an action button gadget resource. More...
 
 ResActionButton (const ResActionButton &other)
 Construct an action button gadget resource. More...
 
ResActionButtonoperator= (const ResGadget &other)
 Assign from a ResGadget. More...
 
ResActionButtonoperator= (const ResActionButton &other)
 Assign from another action button gadget resource. More...
 
 ResActionButton ()
 Construct a action button gadget resource. More...
 
bool is_default () const
 Check if this is the default button. More...
 
void is_default (bool value)
 Set if this is a default button. More...
 
bool cancel () const
 Check if this is the cancel button. More...
 
void cancel (bool value)
 Set if this is the cancel button. More...
 
bool local () const
 Check if this is a local button. More...
 
void local (bool value)
 Set if this is a local button. More...
 
bool click_show_transient () const
 Check if the object shown on a click is transient. More...
 
void click_show_transient (bool value)
 Set if the object shown on a click is transient. More...
 
const char * text () const
 Get the text for the button. More...
 
void text (const char *value, int max_length=-1)
 Set the text for the button. More...
 
void text (const std::string &value, int max_length=-1)
 Set the text for the button. More...
 
int max_text_len () const
 Get the maximum length for the text. More...
 
const char * click_show () const
 Get the name of object to show on click. More...
 
void click_show (const char *value)
 Set the name of the object to show on click. More...
 
void click_show (const std::string &value)
 Set the name of the object to show on click. More...
 
int event () const
 Get the event number generated by this button. More...
 
void event (int value)
 Set the event number to be generated by this button. 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 ActionButton gadget template.

Constructor & Destructor Documentation

◆ ResActionButton() [1/3]

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

Construct an action button gadget resource.

Parameters
otherResGadget to copy resource from
Exceptions
ResGadgetTypeMismatchif the ResGadget is not an action button

◆ ResActionButton() [2/3]

tbx::res::ResActionButton::ResActionButton ( const ResActionButton other)
inline

Construct an action button gadget resource.

Parameters
otheraction button to copy resource from

◆ ResActionButton() [3/3]

tbx::res::ResActionButton::ResActionButton ( )
inline

Construct a action button gadget resource.

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

Member Function Documentation

◆ cancel() [1/2]

bool tbx::res::ResActionButton::cancel ( ) const
inline

Check if this is the cancel button.

The cancel button is also activated by pressing escape in the window.

Returns
true if this is the cancel button

◆ cancel() [2/2]

void tbx::res::ResActionButton::cancel ( bool  value)
inline

Set if this is the cancel button.

The cancel button is also activated by pressing escape in the window.

Parameters
valuetrue to make this the cancel button

◆ click_show() [1/3]

const char* tbx::res::ResActionButton::click_show ( ) const
inline

Get the name of object to show on click.

Returns
pointer to zero terminated name of the object to show or 0 if no object will be shown.

◆ click_show() [2/3]

void tbx::res::ResActionButton::click_show ( const char *  value)
inline

Set the name of the object to show on click.

Parameters
valuename of object to show or 0 for no object

◆ click_show() [3/3]

void tbx::res::ResActionButton::click_show ( const std::string &  value)
inline

Set the name of the object to show on click.

Parameters
valuename of object to show

◆ click_show_transient() [1/2]

bool tbx::res::ResActionButton::click_show_transient ( ) const
inline

Check if the object shown on a click is transient.

Returns
true if the shown object is transient.

◆ click_show_transient() [2/2]

void tbx::res::ResActionButton::click_show_transient ( bool  value)
inline

Set if the object shown on a click is transient.

Parameters
valuetrue to make the shown object is transient.

◆ event() [1/2]

int tbx::res::ResActionButton::event ( ) const
inline

Get the event number generated by this button.

Returns
event number or 0 to generate the default event

◆ event() [2/2]

void tbx::res::ResActionButton::event ( int  value)
inline

Set the event number to be generated by this button.

Parameters
valueevent number or 0 to generate the default event

◆ is_default() [1/2]

bool tbx::res::ResActionButton::is_default ( ) const
inline

Check if this is the default button.

The default button is displayed slightly differently and is activated when return is pressed.

Returns
true if this will create a default button

◆ is_default() [2/2]

void tbx::res::ResActionButton::is_default ( bool  value)
inline

Set if this is a default button.

The default button is displayed slightly differently and is activated when return is pressed in the window.

Parameters
valuetrue to make this button the default button

◆ local() [1/2]

bool tbx::res::ResActionButton::local ( ) const
inline

Check if this is a local button.

A local button does not close the window when it is selected, whereas a non-local button will close the window when selected.

Returns
true if this is a local button

◆ local() [2/2]

void tbx::res::ResActionButton::local ( bool  value)
inline

Set if this is a local button.

A local button does not close the window when it is selected, whereas a non-local button will close the window when selected.

Parameters
valuetrue to make this a local button

◆ max_text_len()

int tbx::res::ResActionButton::max_text_len ( ) const
inline

Get the maximum length for the text.

Returns
maximum buffer size for the text.

◆ operator=() [1/2]

ResActionButton& tbx::res::ResActionButton::operator= ( const ResGadget other)
inline

Assign from a ResGadget.

Parameters
otherResGadget to copy
Exceptions
ResGadgetTypeMismatchif the ResGadget is not an action button

◆ operator=() [2/2]

ResActionButton& tbx::res::ResActionButton::operator= ( const ResActionButton other)
inline

Assign from another action button gadget resource.

Parameters
otheraction button gadget resource to copy

◆ text() [1/3]

const char* tbx::res::ResActionButton::text ( ) const
inline

Get the text for the button.

Returns
zero terminated string.

◆ text() [2/3]

void tbx::res::ResActionButton::text ( const char *  value,
int  max_length = -1 
)
inline

Set the text for the button.

Parameters
valuethe text for the button
max_lengththe maximum length the text will be changed to after the gadget is created. The default (-1) will use the length of value

◆ text() [3/3]

void tbx::res::ResActionButton::text ( const std::string &  value,
int  max_length = -1 
)
inline

Set the text for the button.

Parameters
valuethe text for the button
max_lengththe maximum length the text will be changed to when the gadget is created. The default (-1) will use the length of value

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