tbx
0.7.3
|
Class for Draggable gadget template. More...
#include <resdraggable.h>
Public Types | |
enum | { TYPE_ID = 640 } |
enum | DraggableType { DRAG_ONLY, DRAG_CLICK_DOUBLECLICK, DRAG_SELECT_DOUBLECLICK } |
Enumerations for mouse actions allowed on the draggable. More... | |
Public Member Functions | |
ResDraggable (const ResGadget &other) | |
Construct an draggable gadget resource. More... | |
ResDraggable (const ResDraggable &other) | |
Construct an draggable gadget resource. More... | |
ResDraggable & | operator= (const ResGadget &other) |
Assign from a ResGadget. More... | |
ResDraggable & | operator= (const ResDraggable &other) |
Assign from another draggable gadget resource. More... | |
ResDraggable () | |
Construct a draggable gadget resource. More... | |
bool | generate_drag_started () const |
Check if draggable should generate an event when the drag has started. More... | |
void | generate_drag_started (bool value) |
Set if the draggable should generate an event when the drag has started. More... | |
bool | has_sprite () const |
Check if the draggable includes a sprite. More... | |
void | has_sprite (bool value) |
Set if the draggable includes a sprite. More... | |
bool | has_text () const |
Check if the draggable includes text. More... | |
void | has_text (bool value) |
Set if the draggable includes text. More... | |
DraggableType | draggable_type () const |
Get the interaction with the mouse for this draggable. More... | |
void | draggable_type (DraggableType value) |
Set the interaction with the mouse for this draggable. More... | |
bool | deliver_toolbox_ids () const |
Check if the draggable will deliver Toolbox IDs on drag completion. More... | |
void | deliver_toolbox_ids (bool value) |
Set if the draggable will deliver Toolbox IDs on drag completion. More... | |
bool | drop_shadow () const |
Check if the draggable will show a drop shadow when dragged. More... | |
void | drop_shadow (bool value) |
Set if the draggable will show a drop shadow when dragged. More... | |
bool | not_dithered () const |
Check if the draggable will be dithered when dragged. More... | |
void | not_dithered (bool value) |
Set if the draggable will be dithered when dragged. More... | |
const char * | text () const |
Get the text for the draggable. More... | |
void | text (const char *value, int max_length=-1) |
Set the text for the draggable. More... | |
void | text (const std::string &value, int max_length=-1) |
Set the text for the draggable. More... | |
int | max_text_len () const |
Get the maximum length for the text. More... | |
const char * | sprite () const |
Get the sprite name for the draggable. More... | |
void | sprite (const char *value, int max_length=-1) |
Set the sprite name for the draggable. More... | |
void | sprite (const std::string &value, int max_length=-1) |
Set the sprite name for the draggable. More... | |
int | max_sprite_len () const |
Get the maximum length of the sprite name for the draggable. | |
![]() | |
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 Draggable gadget template.
|
inline |
Construct an draggable gadget resource.
other | ResGadget to copy resource from |
ResGadgetTypeMismatch | if the ResGadget is not an draggable |
|
inline |
Construct an draggable gadget resource.
other | draggable to copy resource from |
|
inline |
Construct a draggable gadget resource.
All options are false, events unset and messages are null.
|
inline |
Check if the draggable will deliver Toolbox IDs on drag completion.
|
inline |
Set if the draggable will deliver Toolbox IDs on drag completion.
value | set to true to return Toolbox IDs or false to return WIMP handles. |
|
inline |
Get the interaction with the mouse for this draggable.
|
inline |
Set the interaction with the mouse for this draggable.
value | DraggableType enumeration value |
|
inline |
Check if the draggable will show a drop shadow when dragged.
|
inline |
Set if the draggable will show a drop shadow when dragged.
value | true to show a drop shadow |
|
inline |
Check if draggable should generate an event when the drag has started.
|
inline |
Set if the draggable should generate an event when the drag has started.
value | true if the draggable should generate the drag started event |
|
inline |
Check if the draggable includes a sprite.
|
inline |
Set if the draggable includes a sprite.
Use the sprite() method to set the sprite name
value | set to true if the draggable includes a sprite |
|
inline |
Check if the draggable includes text.
|
inline |
Set if the draggable includes text.
Use the text() method to set the text
value | set to true if the draggable includes text |
|
inline |
Get the maximum length for the text.
|
inline |
Check if the draggable will be dithered when dragged.
|
inline |
Set if the draggable will be dithered when dragged.
value | set to true if dithering is required |
|
inline |
Assign from a ResGadget.
other | ResGadget to copy |
ResGadgetTypeMismatch | if the ResGadget is not an draggable |
|
inline |
Assign from another draggable gadget resource.
other | draggable gadget resource to copy |
|
inline |
Get the sprite name for the draggable.
|
inline |
Set the sprite name for the draggable.
The sprite will only be used if has_sprite(true) has been set.
value | sprite name for the draggable or 0 if none |
max_length | the maximum length the spritename will be changed to after the gadget is created. The default (-1) will use the length of value. |
|
inline |
Set the sprite name for the draggable.
The sprite will only be used if has_sprite(true) has been set.
value | sprite name for the draggable |
max_length | the maximum length the spritename will be changed to after the gadget is created. The default (-1) will use the length of value. |
|
inline |
Get the text for the draggable.
|
inline |
Set the text for the draggable.
The text will only be used if has_text(true) has been set.
value | text for the draggable or 0 if text none |
max_length | the maximum length the text will be changed to after the gadget is created. The default (-1) will use the length of value. |
|
inline |
Set the text for the draggable.
The text will only be used if has_text(true) has been set.
value | text for the draggable |
max_length | the maximum length the text will be changed to after the gadget is created. The default (-1) will use the length of value. |