tbx
0.7.3
|
Class for Iconbar in memory template. More...
#include <resiconbar.h>
Public Types | |
enum | { CLASS_ID = 0x82900 } |
Public Member Functions | |
ResIconbar (std::string name) | |
Constructor and empty ResIconBar. More... | |
ResIconbar (const ResIconbar &other) | |
Copy constructor. More... | |
ResIconbar (const ResObject &other) | |
Construct from a ResObject. More... | |
ResIconbar & | operator= (const ResIconbar &other) |
Assignment. More... | |
ResIconbar & | operator= (const ResObject &other) |
Assignment from ResObject. 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 | generate_select_about_to_be_shown () const |
Check if an iconbar select about to be shown event will be generated before the object* which has been associated with a select click is shown. More... | |
void | generate_select_about_to_be_shown (bool generate) |
Set if an iconbar select about to be shown event will be generated before the object* which has been associated with a select click is shown. More... | |
bool | generate_adjust_about_to_be_shown () const |
Check if an iconbar adjust about to be shown event will be generated before the object* which has been associated with a adjust click is shown. More... | |
void | generate_adjust_about_to_be_shown (bool generate) |
Set if an iconbar adjust about to be shown event will be generated before the object* which has been associated with a adjust click is shown. More... | |
bool | select_show_transient () const |
Check if the select show object will be shown transient (i.e. More... | |
void | select_show_transient (bool transient) |
Set to show the select show object as a transient (i.e. More... | |
bool | adjust_show_transient () const |
Check if the adjust show object will be shown transient (i.e. More... | |
void | adjust_show_transient (bool transient) |
Set to show the adjust object as a transient (i.e. More... | |
bool | generate_clicked_on_select () const |
Check if the iconbar clicked (or client-specified) event is generate when select is clicked. More... | |
void | generate_clicked_on_select (bool generate) |
Set if the iconbar clicked (or client-specified) event is generate when select is clicked. More... | |
bool | generate_clicked_on_adjust () const |
Check if the iconbar clicked (or client-specified) event is generate when adjust is clicked. More... | |
void | generate_clicked_on_adjust (bool generate) |
Set if the iconbar clicked (or client-specified) event is generate when adjust is clicked. More... | |
int | position () const |
Get a negative integer giving the position of this icon on the iconbar. | |
void | position (int value) |
Set a negative integer giving the position of this icon on the iconbar. More... | |
int | priority () const |
Get The priority used to position the icon on the iconbar. | |
void | priority (int value) |
Set The priority used to position the icon on the iconbar. | |
const char * | sprite_name () const |
Get the sprite name. | |
void | sprite_name (const char *name, int max_length=-1) |
Set the spritename. More... | |
void | sprite_name (const std::string &name, int max_length=-1) |
Set the spritename. More... | |
int | max_sprite_name () const |
Get the sprite name length. | |
const char * | text () const |
Get the iconbar icon text. | |
void | text (const char *value, int max_length=-1) |
Set the text. More... | |
void | text (const std::string &value, int max_length=-1) |
Set the text. More... | |
int | max_text () const |
Get the maximum text length. | |
const char * | menu () const |
Get name of menu to show. | |
void | menu (const char *name) |
Set name of menu to show. More... | |
void | menu (std::string name) |
Set name of menu to show. More... | |
unsigned int | select_event () const |
Get The event to generate when select is clicked or 0 for the default. | |
void | select_event (unsigned int value) |
Set The event to generate when select is clicked or 0 for the default. More... | |
unsigned int | adjust_event () const |
Get The event to generate when adjust is clicked or 0 for the default. | |
void | adjust_event (unsigned int value) |
Set The event to generate when adjust is clicked or 0 for the default. More... | |
const char * | select_show () const |
Get name of object to show on select. More... | |
void | select_show (const char *name) |
Set name of object to show on select. More... | |
void | select_show (std::string name) |
Set name of object to show on select. More... | |
const char * | adjust_show () const |
Get name of object to show on adjust. More... | |
void | adjust_show (const char *name) |
Set name of object to show on adjust. More... | |
void | adjust_show (std::string name) |
Set name of object to show on adjust. More... | |
const char * | help_message () const |
Get the iconbar icon help message. | |
void | help_message (const char *value, int max_length=-1) |
Set the help message. More... | |
void | help_message (const std::string &value, int max_length=-1) |
Set the help message. More... | |
int | max_help_message () const |
Get the maximum help message length. | |
![]() | |
ResObject (const ResObject &other) | |
Copy constructor. | |
virtual | ~ResObject () |
Destructor. | |
ResObject & | operator= (const ResObject &other) |
Assignment. | |
bool | save (std::ostream &file) |
Save a resource object to a stream. More... | |
const ResObjectHeader * | object_header () const |
Return a pointer to the header information for this object. | |
const char * | name () const |
Return pointer to name of object. | |
void | name (std::string name) |
Set the name of the object. | |
int | class_id () const |
Return class id of object. | |
int | object_version () const |
Return version number * 100. | |
void | object_version (int new_version) |
Set version for object. | |
unsigned int | object_flags () const |
object flags - use methods below for named access to the bits of the flags | |
void | object_flags (unsigned int flags) |
Set the object flags for this object. More... | |
bool | create_on_load () const |
Get create on load flag. More... | |
void | create_on_load (bool value) |
Set if the object should be automatically created when the Resource file is loaded. More... | |
bool | show_on_create () const |
Get show on create flags. More... | |
void | show_on_create (bool value) |
Set if the object to be automatically shown when it is created. More... | |
bool | shared () const |
Get shared flag. More... | |
void | shared (bool value) |
Set if the object is to be a shared object. More... | |
bool | ancestor () const |
Get ancestor flags. More... | |
void | ancestor (bool value) |
Set if the object should be an ancestor object. More... | |
void | check_class_id (int class_id) const |
Check if this objects class id is as specified. More... | |
![]() | |
ResBase (const ResBase &other) | |
Copy constructor. More... | |
virtual | ~ResBase () |
Destructor. | |
ResBase & | operator= (const ResBase &other) |
Assignment. More... | |
Additional Inherited Members | |
![]() | |
static ResObject * | load (std::istream &file) |
Load a resource object from a stream. More... | |
static OsSpriteAreaPtr | client_sprite_pointer () |
Get pointer to client sprite area. More... | |
static void | client_sprite_pointer (OsSpriteAreaPtr ptr) |
Set Sprite area to use for new and loaded objects. | |
![]() | |
ResObject (std::string name, int class_id, int version, int object_size) | |
Protected constructor for creating a subclass. | |
ResObjectHeader * | object_header () |
Return a pointer to the header information for this object. | |
void | make_writeable () |
Make object writeable, call before any change. More... | |
ResData * | component_data (char *new_body, int offset, int size) const |
Extract a copy of a components data from this object. More... | |
void | insert_component (int offset, const ResImpl *comp_impl) |
Insert a component in an object. More... | |
void | replace_component (int offset, int old_size, const ResImpl *comp_impl) |
Replace a component. More... | |
void | erase_component (int offset, int size) |
Erase a component of the given size. More... | |
![]() | |
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 Iconbar in memory template.
|
inline |
Constructor and empty ResIconBar.
name | template name of the object |
|
inline |
Copy constructor.
other | object to create copy of |
|
inline |
Construct from a ResObject.
other | object to create copy of |
|
inline |
Set The event to generate when adjust is clicked or 0 for the default.
value | number of event to generate |
|
inline |
Get name of object to show on adjust.
|
inline |
Set name of object to show on adjust.
name | name of object to show on adjust or 0 for none |
|
inline |
Set name of object to show on adjust.
name | name of object to show on adjust |
|
inline |
Check if the adjust show object will be shown transient
(i.e.
with the semantics of Wimp_CreateMenu)
|
inline |
Set to show the adjust object as a transient
(i.e.
with the semantics of Wimp_CreateMenu)
transient | true to show the adjust object as transient |
|
inline |
Get all flags as a word raw access.
Not normally used as there are named methods that allow access to the individual items in the flags
|
inline |
Set all flags as a word.
Not normally used as there are named methods that allow access to the individual items in the flags
value | new value for the flags |
|
inline |
Check if an iconbar adjust about to be shown event will be generated before the object* which has been associated with a adjust click is shown.
|
inline |
Set if an iconbar adjust about to be shown event will be generated before the object* which has been associated with a adjust click is shown.
generate | true to generate the event |
|
inline |
Check if the iconbar clicked (or client-specified) event is generate when adjust is clicked.
|
inline |
Set if the iconbar clicked (or client-specified) event is generate when adjust is clicked.
generate | true if the clicked event is generated on adjust |
|
inline |
Check if the iconbar clicked (or client-specified) event is generate when select is clicked.
|
inline |
Set if the iconbar clicked (or client-specified) event is generate when select is clicked.
generate | true if the clicked event is generated on select |
|
inline |
Check if an iconbar select about to be shown event will be generated before the object* which has been associated with a select click is shown.
|
inline |
Set if an iconbar select about to be shown event will be generated before the object* which has been associated with a select click is shown.
generate | true to generate the event |
|
inline |
Set the help message.
value | iconbar icon help message or 0 for none |
max_length | maximum length for help message or -1 to use current value. This is alway adjusted to allow for the full length of the help message. |
|
inline |
Set the help message.
value | iconbar icon help message |
max_length | maximum length for help message or -1 to use current value. This is alway adjusted to allow for the full length of the help message. |
|
inline |
Set name of menu to show.
name | name of menu to show |
|
inline |
Set name of menu to show.
name | name of menu to show |
|
inline |
Assignment.
other | object to create copy of |
|
inline |
Assignment from ResObject.
other | object to create copy of |
|
inline |
Set a negative integer giving the position of this icon on the iconbar.
value | position on iconbar |
|
inline |
Set The event to generate when select is clicked or 0 for the default.
value | number of event to generate |
|
inline |
Get name of object to show on select.
|
inline |
Set name of object to show on select.
name | name of object to show on select or 0 for none |
|
inline |
Set name of object to show on select.
name | name of object to show on select |
|
inline |
Check if the select show object will be shown transient
(i.e.
with the semantics of Wimp_CreateMenu)
|
inline |
Set to show the select show object as a transient
(i.e.
with the semantics of Wimp_CreateMenu)
transient | true to show the select object as transient |
|
inline |
Set the spritename.
name | name of sprite |
max_length | maximum length for sprite name or -1 to use current value. This is alway adjusted to allow for the full length on name. |
|
inline |
Set the spritename.
name | name of sprite |
max_length | maximum length for sprite name or -1 to use current value. This is alway adjusted to allow for the full length on name. |
|
inline |
Set the text.
value | iconbar icon text |
max_length | maximum length for text or -1 to use current value. This is alway adjusted to allow for the full length of the text. |
|
inline |
Set the text.
value | iconbar icon text |
max_length | maximum length for text or -1 to use current value. This is alway adjusted to allow for the full length of the text. |