tbx
0.7.6
|
Class to represent a ProgInfo resource. More...
#include <resproginfo.h>
Public Types | |
enum | { CLASS_ID = 0x82b40 } |
Public Member Functions | |
ResProgInfo (std::string name, bool has_web_button=false) | |
Constructor and empty ResProgInfo. More... | |
ResProgInfo (const ResProgInfo &other) | |
Copy constructor. More... | |
ResProgInfo (const ResObject &other) | |
Construct from a ResObject. More... | |
ResProgInfo & | operator= (const ResProgInfo &other) |
Assignment. More... | |
ResProgInfo & | 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_about_to_be_shown () const |
Check if the about to be shown event should be generated. More... | |
void | generate_about_to_be_shown (bool value) |
Set if the about to be shown event should be generated. More... | |
bool | generate_dialogue_completed () const |
Check if the dialogue completed event should be generated. More... | |
void | generate_dialogue_completed (bool value) |
Set if the dialogue completed event should be generated. More... | |
bool | include_licence_type () const |
Check if licence type is included on the dialogue. More... | |
void | include_licence_type (bool value) |
Set if licence type is included on the dialogue. More... | |
bool | include_web_page_button () const |
Check if the web page button is included on the dialogue. More... | |
bool | generate_web_page_click () const |
Check if the web page button generates a click event. More... | |
const char * | title () const |
Get the title of the dialogue. More... | |
void | title (const char *value, int max_length=-1) |
Set the title of the dialogue. More... | |
void | title (const std::string &value, int max_length=-1) |
Set the title of the dialogue. More... | |
int | max_title () const |
Get the maximum size the title can be. | |
const char * | purpose () const |
Get the purpose. | |
void | purpose (const char *value) |
Set the purpose of the application. More... | |
void | purpose (const std::string &value) |
Set the purpose of the application. More... | |
const char * | author () const |
Get the author. | |
void | author (const char *value) |
Set the author of the application. More... | |
void | author (const std::string &value) |
Set the author of the application. More... | |
int | licence_type () const |
Get the licence type. More... | |
void | licence_type (int type) |
Set the licence type. More... | |
const char * | version () const |
Get the version. | |
void | version (const char *value) |
Set the version of the application. More... | |
void | version (const std::string &value) |
Set the version of the application. More... | |
const char * | window () const |
Get the name of the window template that provides the window for this object. More... | |
void | window (const char *value) |
Set the name of the window template that provides the window for this object. More... | |
void | window (const std::string &value) |
Set the name of the window template that provides the window for this object. More... | |
const char * | uri () const |
Get URI. More... | |
void | uri (const char *value) |
Set URI. More... | |
void | uri (const std::string &value) |
Set URI. More... | |
int | web_event () const |
Get the event generated for web page click added with version 1.01. More... | |
void | web_event (int event_id) |
Set the event generated for web page click added with version 1.01. More... | |
![]() | |
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 to represent a ProgInfo resource.
TODO: New version with web url
|
inline |
Constructor and empty ResProgInfo.
name | template name of the object |
has_web_button | us newer (version 1.01 item with web page button) |
|
inline |
Copy constructor.
other | object to create copy of |
|
inline |
Construct from a ResObject.
other | object to create copy of |
|
inline |
Set the author of the application.
value | author of the application |
|
inline |
Set the author of the application.
value | author of the application |
|
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
|
inline |
Check if the about to be shown event should be generated.
|
inline |
Set if the about to be shown event should be generated.
value | set to true if the about to be shown event should be generated |
|
inline |
Check if the dialogue completed event should be generated.
|
inline |
Set if the dialogue completed event should be generated.
value | set to true if the dialogue completed event should be generated |
|
inline |
Check if the web page button generates a click event.
This property required version 1.01 or later of the ProgInfo Toolbox object.
|
inline |
Check if licence type is included on the dialogue.
|
inline |
Set if licence type is included on the dialogue.
value | set to true to include licence type on the dialogue |
|
inline |
Check if the web page button is included on the dialogue.
This property required version 1.01 or later of the ProgInfo Toolbox object.
|
inline |
Get the licence type.
|
inline |
Set the licence type.
type | the new licence type |
Can be one of the following values: 0 public domain 1 single user 2 single machine 3 site 4 network 5 authority
|
inline |
Assignment from ResObject.
other | object to create copy of |
|
inline |
Assignment.
other | object to create copy of |
|
inline |
Set the purpose of the application.
value | purpose of the application |
|
inline |
Set the purpose of the application.
value | purpose of the application |
|
inline |
Get the title of the dialogue.
|
inline |
Set the title of the dialogue.
value | zero terminated string with the title or 0 for the default |
max_length | maximum length the title will be changed to. -1 (the default) to use the length of the title given. |
|
inline |
Set the title of the dialogue.
value | new title |
max_length | maximum length the title will be changed to. -1 (the default) to use the length of the title given. |
|
inline |
Get URI.
This method requires the Proginfo Toolbox object version 1.01 or later
|
inline |
Set URI.
This method requires the Proginfo Toolbox object version 1.01 or later
value | pointer to zero terminated uri string or 0 if none. |
std::invalid_argument | if object version is < 1.01 |
|
inline |
Set URI.
This method requires the Proginfo Toolbox object version 1.01 or later
value | pointer to zero terminated uri string or 0 if none. |
std::invalid_argument | if object version is < 1.01 |
|
inline |
Set the version of the application.
value | the new version string |
|
inline |
Set the version of the application.
value | the new version string |
|
inline |
Get the event generated for web page click added with version 1.01.
|
inline |
Set the event generated for web page click added with version 1.01.
event_id | event ID |
std::invalid_argument | if object version is < 1.01 |
|
inline |
Get the name of the window template that provides the window for this object.
|
inline |
Set the name of the window template that provides the window for this object.
value | The name of window to use or 0 if default internal window will be used |
|
inline |
Set the name of the window template that provides the window for this object.
value | The name of window to use or 0 if default internal window will be used |