tbx
0.7.6
|
Class for NumberRange gadget template. More...
#include <resnumberrange.h>
Public Types | |
enum | { TYPE_ID = 832 } |
enum | SliderType { NO_SLIDER, SLIDER_RIGHT, SLIDER_LEFT } |
Enumaration for how slider is shown. More... | |
Public Member Functions | |
ResNumberRange (const ResGadget &other) | |
Construct an number range gadget resource. More... | |
ResNumberRange (const ResNumberRange &other) | |
Construct an number range gadget resource. More... | |
ResNumberRange & | operator= (const ResGadget &other) |
Assign from a ResGadget. More... | |
ResNumberRange & | operator= (const ResNumberRange &other) |
Assign from another number range gadget resource. More... | |
ResNumberRange () | |
Construct a number range 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 number range is writable. More... | |
void | writable (bool value) |
Set if number range is writable. More... | |
bool | no_display_area () const |
Check if display area is omitted from the number range. More... | |
void | no_display_area (bool value) |
Set if display area is omitted from the number range. More... | |
bool | has_adjuster_arrows () const |
Check if the number range shows adjuster arrows. More... | |
void | has_adjuster_arrows (bool value) |
Set if the number range shows adjuster arrows. More... | |
SliderType | slider_type () const |
Get how the slider is displayed. More... | |
void | slider_type (SliderType value) |
Set how the slider is displayed. More... | |
ResJustification | justification () const |
Get the horizontal position of the number range in its bounding box. More... | |
void | justification (ResJustification value) |
Set the horizontal position of the number range in its bounding box. More... | |
WimpColour | slider_colour () const |
Get slider foreground colour. More... | |
void | slider_colour (WimpColour value) |
Set slider foreground colour. More... | |
WimpColour | slider_background_colour () const |
Get slider background colour. More... | |
void | slider_background_colour (WimpColour value) |
Set slider background colour. More... | |
int | lower_bound () const |
Get the minimum value for the number range. More... | |
void | lower_bound (int value) |
Set the minimum value for the number range. More... | |
int | upper_bound () const |
Get the maximum value for the number range. More... | |
void | upper_bound (int value) |
Set the maximum value for the number range. More... | |
int | step_size () const |
Get the step size value for the number range. More... | |
void | step_size (int value) |
Set the step size value for the number range. More... | |
int | initial_value () const |
Get the initial value for the number range. More... | |
void | initial_value (int value) |
Set the initial value for the number range. More... | |
int | precision () const |
Get the precision of the number range. More... | |
void | precision (int value) |
Set the precision of the number range. More... | |
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... | |
int | display_length () const |
Get the length of the display field. More... | |
void | display_length (int value) |
Set the length of the display field. 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 NumberRange gadget template.
|
inline |
Construct an number range gadget resource.
other | ResGadget to copy resource from |
ResGadgetTypeMismatch | if the ResGadget is not an number range |
|
inline |
Construct an number range gadget resource.
other | number range to copy resource from |
|
inline |
Construct a number range 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 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 |
Get the length of the display field.
|
inline |
Set the length of the display field.
value | length of the display field |
|
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 value changed event |
|
inline |
Check if the number range shows adjuster arrows.
|
inline |
Set if the number range shows adjuster arrows.
value | set to true to shows adjuster arrows |
|
inline |
Get the initial value for the number range.
|
inline |
Set the initial value for the number range.
value | the initial value (this is the value scaled by the precision) |
|
inline |
Get the horizontal position of the number range in its bounding box.
|
inline |
Set the horizontal position of the number range in its bounding box.
value | ResJustification enumeration specifying the position |
|
inline |
Get the minimum value for the number range.
|
inline |
Set the minimum value for the number range.
value | the minimum value (this is the value scaled by the precision) |
|
inline |
Check if display area is omitted from the number range.
|
inline |
Set if display area is omitted from the number range.
value | set to true to omit the display area |
|
inline |
Assign from a ResGadget.
other | ResGadget to copy |
ResGadgetTypeMismatch | if the ResGadget is not an number range |
|
inline |
Assign from another number range gadget resource.
other | number range gadget resource to copy |
|
inline |
Get the precision of the number range.
The precision sets the number of decimal places displayed on the number range. All values are passed to and retrieved from the number range scaled by the power of ten of this value.
e.g. If the precision is 2, 123 is passed to the methods and shown as 1.23.
|
inline |
Set the precision of the number range.
This sets the number of decimal places displayed on the number range. All values are passed to and retrieved from the number range scaled by the power of ten of this value.
e.g. If the precision is 2, 123 is passed to the methods and shown as 1.23.
value | the number of decimal places to display |
|
inline |
Get slider background colour.
|
inline |
Set slider background colour.
value | WimpColour with slider colour |
|
inline |
Get slider foreground colour.
|
inline |
Set slider foreground colour.
value | WimpColour with slider colour |
|
inline |
Get how the slider is displayed.
|
inline |
Set how the slider is displayed.
value | set to the SliderType enumeration value for the display required |
|
inline |
Get the step size value for the number range.
|
inline |
Set the step size value for the number range.
value | the step size value (this is the value scaled by the precision) |
|
inline |
Get the maximum value for the number range.
|
inline |
Set the maximum value for the number range.
value | the maximum value (this is the value scaled by the precision) |
|
inline |
Check if number range is writable.
|
inline |
Set if number range is writable.
value | set to true to make the number range writable |