tbx
0.7.6
|
Class for Button gadget template. More...
#include <resbutton.h>
Public Types | |
enum | { TYPE_ID = 960 } |
enum | ButtonType { IGNORE_CLICKS, CONTINUOUS, CLICK_AUTO_REPEAT, CLICK_ONCE, CLICK_SELECTS, CLICK_SELECTS_DOUBLE, CLICK_ONCE_DRAG, CLICK_SELECTS_DRAG, CLICK_SELECTS_DOUBLE_DRAG, OVER_SELECTS, CLICK_DOUBLE_DRAG, CLICK_NOTIFY_AND_SELECTS_DRAG, FOCUS_AND_DRAG = 14, WRITEABLE } |
Enumeration for how the button processes clicks. | |
Public Member Functions | |
ResButton (const ResGadget &other) | |
Construct an button gadget resource. More... | |
ResButton (const ResButton &other) | |
Construct an button gadget resource. More... | |
ResButton & | operator= (const ResGadget &other) |
Assign from a ResGadget. More... | |
ResButton & | operator= (const ResButton &other) |
Assign from another button gadget resource. More... | |
ResButton () | |
Construct a button gadget resource. More... | |
bool | use_task_sprite_area () const |
Check if button uses the task sprite area. More... | |
void | use_task_sprite_area (bool value) |
Set if button uses the task sprite area. More... | |
bool | return_menu_clicks () const |
Check if button will return clicks with the menu button. More... | |
void | return_menu_clicks (bool value) |
Set if button will return clicks with the menu button. More... | |
int | button_flags () const |
Raw access to all button flags. More... | |
void | button_flags (int value) |
Raw access to all button flags. More... | |
bool | has_text () const |
Check if the button shows text. More... | |
void | has_text (bool value) |
Set if the button shows text. More... | |
bool | is_sprite () const |
Check if the button shows a sprite. More... | |
void | is_sprite (bool value) |
Set if the button shows a sprite. More... | |
bool | has_border () const |
Check if the button has a border. More... | |
void | has_border (bool value) |
Set if the button has a border. More... | |
bool | hcentred () const |
Check if the contents of the button are horizontally centred. More... | |
void | hcentred (bool value) |
Set if the contents of the button are horizontally centred. More... | |
bool | vcentred () const |
Check if the contents of the button are vertically centred. More... | |
void | vcentred (bool value) |
Set if the contents of the button are vertically centred. More... | |
bool | filled () const |
Check if the button background is filled. More... | |
void | filled (bool value) |
Set if the button background is filled. More... | |
bool | anti_aliased_font () const |
Check if the button uses an anti aliased font. More... | |
void | anti_aliased_font (bool value) |
Set if the button uses an anti aliased font. More... | |
bool | redraw_needs_help () const |
Check if the button need help from the user application to be redrawn. More... | |
void | redraw_needs_help (bool value) |
Set if the button need help from the user application to be redrawn. More... | |
bool | text_right_justified () const |
Check if the text on the button is right justified. More... | |
void | text_right_justified (bool value) |
Set if the text on the button is right justified. More... | |
bool | adjust_does_not_cancel () const |
Check if the adjust does not cancel other selections in the same ESG group. More... | |
void | adjust_does_not_cancel (bool value) |
Set if the adjust does not cancel other selections in the same ESG group. More... | |
bool | half_size_sprite () const |
Check if the button display the sprite half size. More... | |
void | half_size_sprite (bool value) |
Set if the button shows the sprite half size. More... | |
ButtonType | button_type () const |
Get how the button processes mouse clicks. More... | |
void | button_type (ButtonType type) |
Set how the button processes mouse clicks. More... | |
int | esg () const |
Return the exclusive selection group (ESG) for the button. More... | |
void | esg (int value) |
Set the exclusive selection group (ESG) for the button. More... | |
int | foreground () const |
Return the foreground WIMP colour. More... | |
void | foreground (int value) |
Set the foreground WIMP colour. More... | |
int | background () const |
Return the background WIMP colour. More... | |
void | background (int value) |
Set the background WIMP colour. More... | |
int | font_handle () const |
Get the WIMP font handle for drawing text. More... | |
void | font_handle (int value) |
Set the WIMP font handle for drawing text. More... | |
const char * | value () const |
Get the value (text or sprite name) of the button. More... | |
void | value (const char *value, int max_length=-1) |
Set the value (text or sprite name) of the button. More... | |
void | value (const std::string &value, int max_length=-1) |
Set the value (text or sprite name) of the button. More... | |
int | max_value () const |
Get the maximum length of the value string. More... | |
const char * | validation () const |
Get the validation (sprite name) for the button. More... | |
void | validation (const char *value, int max_length=-1) |
Set the validation (sprite name) for the button. More... | |
void | validation (const std::string &value, int max_length=-1) |
Set the validation (sprite name) for the button. More... | |
int | max_validation () const |
Get the maximum length the validation (sprite name) that can be used. | |
![]() | |
ResGadget (const ResGadget &other) | |
Construct a resource gadget as a copy of another. More... | |
ResGadget & | operator= (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. | |
![]() | |
ResBase (const ResBase &other) | |
Copy constructor. More... | |
virtual | ~ResBase () |
Destructor. | |
ResBase & | operator= (const ResBase &other) |
Assignment. More... | |
Additional Inherited Members | |
![]() | |
static int | gadget_size (unsigned int type_and_size) |
Get gadget size given its type and size value. More... | |
![]() | |
void | make_writeable () |
Make item writeable. | |
![]() | |
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... | |
![]() | |
ResImpl * | _impl |
Internal Resource implementation. | |
Class for Button gadget template.
|
inline |
Construct an button gadget resource.
other | ResGadget to copy resource from |
ResGadgetTypeMismatch | if the ResGadget is not an button |
|
inline |
Construct an button gadget resource.
other | button to copy resource from |
|
inline |
Construct a button gadget resource.
All options are false, events unset and messages are null.
|
inline |
Check if the adjust does not cancel other selections in the same ESG group.
|
inline |
Set if the adjust does not cancel other selections in the same ESG group.
value | true so set the button so adjust does not cancel other selections |
|
inline |
Check if the button uses an anti aliased font.
|
inline |
Set if the button uses an anti aliased font.
Note: if the anti-aliased flag is set the font_handle methods become available, but the foreground and background methods should not be used.
value | true to make the button use an anti aliased font |
|
inline |
Return the background WIMP colour.
This method is only valid when anti_aliased_font() == false
|
inline |
Set the background WIMP colour.
This method is only valid when anti_aliased_font() == false
value | background WIMP colour (0-15) |
|
inline |
Raw access to all button flags.
It is recommended you use the other methods in this class rather than use this directly.
|
inline |
Raw access to all button flags.
It is recommended you use the other methods in this class rather than use this directly.
value | new button flags |
|
inline |
Get how the button processes mouse clicks.
|
inline |
Set how the button processes mouse clicks.
type | ButtonType for how clicks are handled |
|
inline |
Return the exclusive selection group (ESG) for the button.
Selecting one button that is an ESG will unselect all the others in the same ESG.
|
inline |
Set the exclusive selection group (ESG) for the button.
Selecting one button that is an ESG will unselect all the others in the same ESG.
value | ESG number (0-31). 0 Means not in a group. |
|
inline |
Check if the button background is filled.
|
inline |
Set if the button background is filled.
value | true to fill the button background |
|
inline |
Get the WIMP font handle for drawing text.
This method is only valid when anti_aliased_font() == true
|
inline |
Set the WIMP font handle for drawing text.
This method is only valid when anti_aliased_font() == true
|
inline |
Return the foreground WIMP colour.
This method is only valid when anti_aliased_font() == false
|
inline |
Set the foreground WIMP colour.
This method is only valid when anti_aliased_font() == false
value | foreground WIMP colour (0-15) |
|
inline |
Check if the button display the sprite half size.
|
inline |
Set if the button shows the sprite half size.
value | true to set the button to display the sprite half size |
|
inline |
Check if the button has a border.
|
inline |
Set if the button has a border.
value | true to give the button a border |
|
inline |
Check if the button shows text.
|
inline |
Set if the button shows text.
value | set to true if the button should show text |
|
inline |
Check if the contents of the button are horizontally centred.
|
inline |
Set if the contents of the button are horizontally centred.
value | true to horizontally centre the button |
|
inline |
Check if the button shows a sprite.
|
inline |
Set if the button shows a sprite.
value | true if the button will show a sprite |
|
inline |
Get the maximum length of the value string.
Assign from another button gadget resource.
other | button gadget resource to copy |
Assign from a ResGadget.
other | ResGadget to copy |
ResGadgetTypeMismatch | if the ResGadget is not an button |
|
inline |
Check if the button need help from the user application to be redrawn.
|
inline |
Set if the button need help from the user application to be redrawn.
value | true if the button needs help to be redrawn |
|
inline |
Check if button will return clicks with the menu button.
|
inline |
Set if button will return clicks with the menu button.
value | true to make the button return menu clicks |
|
inline |
Check if the text on the button is right justified.
|
inline |
Set if the text on the button is right justified.
value | true to make the text on the button right justified |
|
inline |
Check if button uses the task sprite area.
|
inline |
Set if button uses the task sprite area.
value | true to make the button use the task sprite area, false to make the button use the WIMP sprite area |
|
inline |
Get the validation (sprite name) for the button.
|
inline |
Set the validation (sprite name) for the button.
value | new validation or 0 for none |
max_length | maximum length for the validation string |
|
inline |
Set the validation (sprite name) for the button.
value | new validation or 0 for none |
max_length | maximum length for the validation string |
|
inline |
Get the value (text or sprite name) of the button.
|
inline |
Set the value (text or sprite name) of the button.
value | pointer to null terminate value string |
max_length | maximum length the value will be set to or -1 (the default) to use the length of the value. |
|
inline |
Set the value (text or sprite name) of the button.
value | new value |
max_length | maximum length the value will be set to or -1 (the default) to use the length of the value. |
|
inline |
Check if the contents of the button are vertically centred.
|
inline |
Set if the contents of the button are vertically centred.
value | true to vertically centre the button |