tbx  0.7.5
Public Types | Public Member Functions | List of all members
tbx::res::ResWritableField Class Reference

Class for WritableField gadget template. More...

#include <reswritablefield.h>

Inheritance diagram for tbx::res::ResWritableField:
tbx::res::ResGadget tbx::res::ResBase

Public Types

enum  { TYPE_ID = 512 }
 

Public Member Functions

 ResWritableField (const ResGadget &other)
 Construct an writable field gadget resource. More...
 
 ResWritableField (const ResWritableField &other)
 Construct an writable field gadget resource. More...
 
ResWritableFieldoperator= (const ResGadget &other)
 Assign from a ResGadget. More...
 
ResWritableFieldoperator= (const ResWritableField &other)
 Assign from another writable field gadget resource. More...
 
 ResWritableField ()
 Construct a writable field 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...
 
ResJustification justification () const
 Get justification of the value. More...
 
void justification (ResJustification value)
 Set justification of the value. More...
 
bool do_not_display_text () const
 Check if the text should not be displayed. More...
 
void do_not_display_text (bool value)
 Set if the text should not be displayed. More...
 
const char * text () const
 Get the initially text for the writable field. More...
 
void text (const char *value, int max_length=-1)
 Set the initially text for the writable field. More...
 
void text (const std::string &value, int max_length=-1)
 Set the initially text for the writable field. More...
 
int max_text_len () const
 Get the maximum length for the writable text.
 
const char * allowable () const
 Get the allowable characters in a writable field. More...
 
void allowable (const char *value, int max_length=-1)
 Set the allowable characters in a writable field. More...
 
void allowable (const std::string &value, int max_length=-1)
 Set the allowable characters in a writable field. More...
 
int max_allowable_len () const
 Get the maximum length the allowable character can be changed to when the gadget is shown.
 
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...
 
- Public Member Functions inherited from tbx::res::ResGadget
 ResGadget (const ResGadget &other)
 Construct a resource gadget as a copy of another. More...
 
ResGadgetoperator= (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.
 
- 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::ResGadget
static int gadget_size (unsigned int type_and_size)
 Get gadget size given its type and size value. More...
 
- Protected Member Functions inherited from tbx::res::ResGadget
void make_writeable ()
 Make item writeable.
 
- 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 WritableField gadget template.

Constructor & Destructor Documentation

◆ ResWritableField() [1/3]

tbx::res::ResWritableField::ResWritableField ( const ResGadget other)
inline

Construct an writable field gadget resource.

Parameters
otherResGadget to copy resource from
Exceptions
ResGadgetTypeMismatchif the ResGadget is not an writable field

◆ ResWritableField() [2/3]

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

Construct an writable field gadget resource.

Parameters
otherwritable field to copy resource from

◆ ResWritableField() [3/3]

tbx::res::ResWritableField::ResWritableField ( )
inline

Construct a writable field gadget resource.

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

Member Function Documentation

◆ after() [1/2]

ComponentId tbx::res::ResWritableField::after ( ) const
inline

Get the component ID of the gadget after this one in the Tab order.

Returns
component ID of next gadget

◆ after() [2/2]

void tbx::res::ResWritableField::after ( ComponentId  value)
inline

Set the component ID of the gadget after this one in the Tab order.

Parameters
valuecomponent ID of next gadget

◆ allowable() [1/3]

const char* tbx::res::ResWritableField::allowable ( ) const
inline

Get the allowable characters in a writable field.

See also
tbx::WritableField::allowable()
Returns
pointer to zero terminated string of allowable characters or 0 if there is no restriction

◆ allowable() [2/3]

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

Set the allowable characters in a writable field.

See also
tbx::WritableField::allowable()
Parameters
valuepointer to zero terminated string of allowable characters or 0 if there is no restriction
max_lengthmaximum length the allowable character can be changed to when the gadget is shown or -1 (the default) for the length of value.

◆ allowable() [3/3]

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

Set the allowable characters in a writable field.

See also
tbx::WritableField::allowable()
Parameters
valuestring of allowable characters
max_lengthmaximum length the allowable character can be changed to when the gadget is shown or -1 (the default) for the length of value.

◆ before() [1/2]

ComponentId tbx::res::ResWritableField::before ( ) const
inline

Get the component ID of the gadget before this one in the Tab order.

Returns
component ID of previous gadget

◆ before() [2/2]

void tbx::res::ResWritableField::before ( ComponentId  value)
inline

Set the component ID of the gadget before this one in the Tab order.

Parameters
valuecomponent ID of previous gadget

◆ do_not_display_text() [1/2]

bool tbx::res::ResWritableField::do_not_display_text ( ) const
inline

Check if the text should not be displayed.

This is used for a password type field

Returns
true if the text should not be displayed

◆ do_not_display_text() [2/2]

void tbx::res::ResWritableField::do_not_display_text ( bool  value)
inline

Set if the text should not be displayed.

This is used for a password type field

Parameters
valueset to true if the text should not be displayed

◆ generate_value_changed() [1/2]

bool tbx::res::ResWritableField::generate_value_changed ( ) const
inline

Check if the value changed event will be generated.

Returns
true if the event will be generated

◆ generate_value_changed() [2/2]

void tbx::res::ResWritableField::generate_value_changed ( bool  value)
inline

Set if the value changed event will be generated.

Parameters
valueset to true to generate the event

◆ justification() [1/2]

ResJustification tbx::res::ResWritableField::justification ( ) const
inline

Get justification of the value.

Returns
ResJustification value specifying justification

◆ justification() [2/2]

void tbx::res::ResWritableField::justification ( ResJustification  value)
inline

Set justification of the value.

Parameters
valueResJustification value specifying justification

◆ operator=() [1/2]

ResWritableField& tbx::res::ResWritableField::operator= ( const ResGadget other)
inline

Assign from a ResGadget.

Parameters
otherResGadget to copy
Exceptions
ResGadgetTypeMismatchif the ResGadget is not an writable field

◆ operator=() [2/2]

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

Assign from another writable field gadget resource.

Parameters
otherwritable field gadget resource to copy

◆ text() [1/3]

const char* tbx::res::ResWritableField::text ( ) const
inline

Get the initially text for the writable field.

Returns
pointer to zero terminated string or 0 if none

◆ text() [2/3]

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

Set the initially text for the writable field.

Parameters
valuepointer to zero terminated string or 0 if none
max_lengthThe maximum length the text can be increased to when using the string set or -1 (the default) to use the length of value.

◆ text() [3/3]

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

Set the initially text for the writable field.

Parameters
valueinitial text
max_lengthThe maximum length the text can be increased to when using the string set or -1 (the default) to use the length of value.

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