tbx  0.7.6
Public Types | Public Member Functions | List of all members
tbx::res::ResDCS Class Reference

Class for DCS object template. More...

#include <resdcs.h>

Inheritance diagram for tbx::res::ResDCS:
tbx::res::ResObject tbx::res::ResBase

Public Types

enum  { CLASS_ID = 0x82a80 }
 

Public Member Functions

 ResDCS (const ResObject &other)
 Construct a discard/cancel/save dialogue resource from a ResObject. More...
 
 ResDCS (const ResDCS &other)
 Construct a discard/cancel/save dialogue resource by copying another. More...
 
ResDCSoperator= (const ResObject &other)
 Assign from a ResObject. More...
 
ResDCSoperator= (const ResDCS &other)
 Assign from another discard/cancel/save dialogue resource. More...
 
 ResDCS (std::string name)
 Construct a discard/cancel/save dialogue resource. More...
 
int flags () const
 Raw access to all the object flags. More...
 
void flags (int value)
 Set all the flags. 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...
 
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 * alternative_message () const
 Get the alternative message to display in the DCS box. More...
 
void alternative_message (const char *value, int max_length=-1)
 Set the alternative message to display in the DCS box. More...
 
void alternative_message (const std::string &value, int max_length=-1)
 Set the alternative message to display in the DCS box. More...
 
int max_alternative_message () const
 Get the maximum size the alternative title can be.
 
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...
 
- Public Member Functions inherited from tbx::res::ResObject
 ResObject (const ResObject &other)
 Copy constructor.
 
virtual ~ResObject ()
 Destructor.
 
ResObjectoperator= (const ResObject &other)
 Assignment.
 
bool save (std::ostream &file)
 Save a resource object to a stream. More...
 
const ResObjectHeaderobject_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...
 
- Public Member Functions inherited from tbx::res::ResBase
 ResBase (const ResBase &other)
 Copy constructor. More...
 
virtual ~ResBase ()
 Destructor.
 
ResBaseoperator= (const ResBase &other)
 Assignment. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from tbx::res::ResObject
static ResObjectload (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.
 
- Protected Member Functions inherited from tbx::res::ResObject
 ResObject (std::string name, int class_id, int version, int object_size)
 Protected constructor for creating a subclass.
 
ResObjectHeaderobject_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...
 
- Protected Member Functions inherited from tbx::res::ResBase
 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...
 
- Protected Attributes inherited from tbx::res::ResBase
ResImpl * _impl
 Internal Resource implementation.
 

Detailed Description

Class for DCS object template.

Constructor & Destructor Documentation

◆ ResDCS() [1/3]

tbx::res::ResDCS::ResDCS ( const ResObject other)
inline

Construct a discard/cancel/save dialogue resource from a ResObject.

Parameters
otherResObject to construct from
Exceptions
ResObjectClassMismatchif the ResObject is not a discard/cancel/save dialogue resource

◆ ResDCS() [2/3]

tbx::res::ResDCS::ResDCS ( const ResDCS other)
inline

Construct a discard/cancel/save dialogue resource by copying another.

Parameters
otherResDCS to copy

◆ ResDCS() [3/3]

tbx::res::ResDCS::ResDCS ( std::string  name)
inline

Construct a discard/cancel/save dialogue resource.

All options are false, events unset and messages are null.

Parameters
namethe name of this object (maximum 12 characters)

Member Function Documentation

◆ alternative_message() [1/3]

const char* tbx::res::ResDCS::alternative_message ( ) const
inline

Get the alternative message to display in the DCS box.

Returns
alternative message or 0 if it will use the default message

◆ alternative_message() [2/3]

void tbx::res::ResDCS::alternative_message ( const char *  value,
int  max_length = -1 
)
inline

Set the alternative message to display in the DCS box.

Parameters
valuenew alternative message or 0 to use the default message
max_lengthmaximum length the title will be changed to. -1 (the default) to use the length of the title given.

◆ alternative_message() [3/3]

void tbx::res::ResDCS::alternative_message ( const std::string &  value,
int  max_length = -1 
)
inline

Set the alternative message to display in the DCS box.

Parameters
valuenew alternative message
max_lengthmaximum length the title will be changed to. -1 (the default) to use the length of the title given.

◆ flags() [1/2]

int tbx::res::ResDCS::flags ( ) const
inline

Raw access to all the object flags.

It is recommended you use the other methods in this class rather than use this directly.

Returns
integer with individual bits specifying various flags

◆ flags() [2/2]

void tbx::res::ResDCS::flags ( int  value)
inline

Set all the flags.

It is recommended you use the other methods in this class rather than use this directly.

Parameters
valuethe new flags

◆ generate_about_to_be_shown() [1/2]

bool tbx::res::ResDCS::generate_about_to_be_shown ( ) const
inline

Check if the about to be shown event should be generated.

Returns
true if the about to be shown event should be generated

◆ generate_about_to_be_shown() [2/2]

void tbx::res::ResDCS::generate_about_to_be_shown ( bool  value)
inline

Set if the about to be shown event should be generated.

Parameters
valueset to true if the about to be shown event should be generated

◆ generate_dialogue_completed() [1/2]

bool tbx::res::ResDCS::generate_dialogue_completed ( ) const
inline

Check if the dialogue completed event should be generated.

Returns
true if the dialogue completed event should be generated

◆ generate_dialogue_completed() [2/2]

void tbx::res::ResDCS::generate_dialogue_completed ( bool  value)
inline

Set if the dialogue completed event should be generated.

Parameters
valueset to true if the dialogue completed event should be generated

◆ operator=() [1/2]

ResDCS& tbx::res::ResDCS::operator= ( const ResDCS other)
inline

Assign from another discard/cancel/save dialogue resource.

Parameters
otherbutton gadget resource to copy

◆ operator=() [2/2]

ResDCS& tbx::res::ResDCS::operator= ( const ResObject other)
inline

Assign from a ResObject.

Parameters
otherResObject to copy
Exceptions
ResObjectClassMismatchif the ResObject is not a discard/cancel/save dialogue resource

◆ title() [1/3]

const char* tbx::res::ResDCS::title ( ) const
inline

Get the title of the dialogue.

Returns
zero terminated string with title or 0 for the default title

◆ title() [2/3]

void tbx::res::ResDCS::title ( const char *  value,
int  max_length = -1 
)
inline

Set the title of the dialogue.

Parameters
valuezero terminated string with the title or 0 for the default
max_lengthmaximum length the title will be changed to. -1 (the default) to use the length of the title given.

◆ title() [3/3]

void tbx::res::ResDCS::title ( const std::string &  value,
int  max_length = -1 
)
inline

Set the title of the dialogue.

Parameters
valuenew title
max_lengthmaximum length the title will be changed to. -1 (the default) to use the length of the title given.

◆ window() [1/3]

const char* tbx::res::ResDCS::window ( ) const
inline

Get the name of the window template that provides the window for this object.

Returns
name of window to use or 0 if default internal window will be used

◆ window() [2/3]

void tbx::res::ResDCS::window ( const char *  value)
inline

Set the name of the window template that provides the window for this object.

Parameters
valueThe name of window to use or 0 if default internal window will be used

◆ window() [3/3]

void tbx::res::ResDCS::window ( const std::string &  value)
inline

Set the name of the window template that provides the window for this object.

Parameters
valueThe name of window to use or 0 if default internal window will be used

The documentation for this class was generated from the following file: