tbx
0.7.5
|
Class for StringSet gadget template. More...
#include <resstringset.h>
Public Types | |
enum | { TYPE_ID = 896 } |
Public Member Functions | |
ResStringSet (const ResGadget &other) | |
Construct an string set gadget resource. More... | |
ResStringSet (const ResStringSet &other) | |
Construct an string set gadget resource. More... | |
ResStringSet & | operator= (const ResGadget &other) |
Assign from a ResGadget. More... | |
ResStringSet & | operator= (const ResStringSet &other) |
Assign from another string set gadget resource. More... | |
ResStringSet () | |
Construct a string set gadget resource. More... | |
bool | generate_value_changed () const |
Check if the value changed event will be generated. More... | |
void | generate_value_changed (bool value) |
Set if the value changed event will be generated. More... | |
bool | writable () const |
Check if user can enter values in the string set. More... | |
void | writable (bool value) |
Set if user can enter values in the string set. More... | |
bool | generate_event_before_showing_menu () const |
Check if an event will be generated before the menu is shown. More... | |
void | generate_event_before_showing_menu (bool value) |
Set if an event will be generated before the menu is shown. More... | |
bool | no_value_field () const |
Check if string set has no display or writable field. More... | |
void | no_value_field (bool value) |
Set if string set has no display or writable field. More... | |
ResJustification | justification () const |
Get justification of the value. More... | |
void | justification (ResJustification value) |
Set justification of the value. More... | |
const char * | string_set () const |
Get the set of values shown in the string set menu. More... | |
void | string_set (const char *value) |
Set the set of values shown in the string set menu. More... | |
void | string_set (const std::string &value) |
Set the set of values shown in the string set menu. More... | |
const char * | title () const |
Get the title for the menu. More... | |
void | title (const char *value) |
Set the title for the menu. More... | |
void | title (const std::string &value) |
Set the title for the menu. More... | |
const char * | selected_string () const |
Get the initially selected string. More... | |
void | selected_string (const char *value, int max_length=-1) |
Set the initially selected string. More... | |
void | selected_string (const std::string &value, int max_length=-1) |
Set the initially selected string. More... | |
int | max_selected_string () const |
Get the maximum length the selected string can be increased to when using the string set. | |
const char * | allowable () const |
Get the allowable characters in a writable string set. More... | |
void | allowable (const char *value, int max_length=-1) |
Set the allowable characters in a writable string set. More... | |
void | allowable (const std::string &value, int max_length=-1) |
Set the allowable characters in a writable string set. More... | |
int | max_allowable () const |
Get the maximum length the allowable character can be changed to when the gadget is shown. | |
ComponentId | before () const |
Get the component ID of the gadget before this one in the Tab order. More... | |
void | before (ComponentId value) |
Set the component ID of the gadget before this one in the Tab order. More... | |
ComponentId | after () const |
Get the component ID of the gadget after this one in the Tab order. More... | |
void | after (ComponentId value) |
Set the component ID of the gadget after this one in the Tab order. More... | |
![]() | |
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 StringSet gadget template.
|
inline |
Construct an string set gadget resource.
other | ResGadget to copy resource from |
ResGadgetTypeMismatch | if the ResGadget is not an string set |
|
inline |
Construct an string set gadget resource.
other | string set to copy resource from |
|
inline |
Construct a string set gadget resource.
All options are false, events unset and messages are null.
|
inline |
Get the component ID of the gadget after this one in the Tab order.
|
inline |
Set the component ID of the gadget after this one in the Tab order.
value | component ID of next gadget |
|
inline |
Get the allowable characters in a writable string set.
|
inline |
Set the allowable characters in a writable string set.
value | pointer to zero terminated string of allowable characters or 0 if there is no restriction |
max_length | maximum length the allowable character can be changed to when the gadget is shown or -1 (the default) for the length of value. |
|
inline |
Set the allowable characters in a writable string set.
value | string of allowable characters |
max_length | maximum length the allowable character can be changed to when the gadget is shown or -1 (the default) for the length of value. |
|
inline |
Get the component ID of the gadget before this one in the Tab order.
|
inline |
Set the component ID of the gadget before this one in the Tab order.
value | component ID of previous gadget |
|
inline |
Check if an event will be generated before the menu is shown.
|
inline |
Set if an event will be generated before the menu is shown.
value | set to true to generate the event |
|
inline |
Check if the value changed event will be generated.
|
inline |
Set if the value changed event will be generated.
value | set to true to generate the event |
|
inline |
Get justification of the value.
|
inline |
Set justification of the value.
value | ResJustification value specifying justification |
|
inline |
Check if string set has no display or writable field.
|
inline |
Set if string set has no display or writable field.
value | set to true if no value field should be shown |
|
inline |
Assign from a ResGadget.
other | ResGadget to copy |
ResGadgetTypeMismatch | if the ResGadget is not an string set |
|
inline |
Assign from another string set gadget resource.
other | string set gadget resource to copy |
|
inline |
Get the initially selected string.
|
inline |
Set the initially selected string.
value | pointer to zero terminated string or 0 if none |
max_length | The maximum length the selected string can be increased to when using the string set or -1 (the default) to use the length of value. |
|
inline |
Set the initially selected string.
value | selected string |
max_length | The maximum length the selected string can be increased to when using the string set or -1 (the default) to use the length of value. |
|
inline |
Get the set of values shown in the string set menu.
The values are separated by commas. To include a comma use "\," to include a backslash use "\\".
|
inline |
Set the set of values shown in the string set menu.
The values are separated by commas. To include a comma use "\," to include a backslash use "\\".
value | pointer to zero terminated list of strings or 0 if none |
|
inline |
Set the set of values shown in the string set menu.
The values are separated by commas. To include a comma use "\," to include a backslash use "\\".
value | list of strings |
|
inline |
Get the title for the menu.
|
inline |
Set the title for the menu.
value | pointer to zero terminated menu title or 0 if none |
|
inline |
Set the title for the menu.
value | menu title |
|
inline |
Check if user can enter values in the string set.
|
inline |
Set if user can enter values in the string set.
value | set to true to make the string set is writable |