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

Class for Tabs gadget template. More...

#include <restreeview.h>

Inheritance diagram for tbx::ext::res::ResTreeView:
tbx::res::ResGadget tbx::res::ResBase

Public Types

enum  { TYPE_ID = 0x402c }
 

Public Member Functions

 ResTreeView (const tbx::res::ResGadget &other)
 Construct a tree view gadget resource. More...
 
 ResTreeView (const ResTreeView &other)
 Construct a tree view gadget resource. More...
 
ResTreeViewoperator= (const tbx::res::ResGadget &other)
 Assign from a ResGadget. More...
 
ResTreeViewoperator= (const ResTreeView &other)
 Assign from another tree view gadget resource. More...
 
 ResTreeView ()
 Construct a tree view gadget resource. More...
 
bool allow_vscroll () const
 
void allow_vscroll (bool value)
 
bool allow_hscroll () const
 
void allow_hscroll (bool value)
 
bool auto_update () const
 
void auto_update (bool value)
 
bool show_current_node () const
 
void show_current_node (bool value)
 
bool plot_lines () const
 
void plot_lines (bool value)
 
bool allow_selection () const
 
void allow_selection (bool value)
 
bool notify_selection () const
 
void notify_selection (bool value)
 
bool select_children () const
 
void select_children (bool value)
 
bool allow_expand () const
 
void allow_expand (bool value)
 
bool notify_expansion () const
 
void notify_expansion (bool value)
 
bool expand_by_default () const
 
void expand_by_default (bool value)
 
bool allow_rename () const
 
void allow_rename (bool value)
 
bool notify_rename () const
 
void notify_rename (bool value)
 
bool allow_drags () const
 
void allow_drags (bool value)
 
bool notify_drag_end () const
 
void notify_drag_end (bool value)
 
bool all_events () const
 
void all_events (bool value)
 
bool double_click_expands () const
 
void double_click_expands (bool value)
 
bool flat_mode () const
 
void flat_mode (bool value)
 
bool text_below_sprite () const
 
void text_below_sprite (bool value)
 
bool sort_display () const
 
void sort_display (bool value)
 
bool sort_reversed () const
 
void sort_reversed (bool value)
 
bool sort_by_sprite () const
 
void sort_by_sprite (bool value)
 
int foreground () const
 Get foreground/text colour for the Tabs. More...
 
void foreground (int value)
 Set foreground/text colour for the Tabs. More...
 
int background () const
 Get background colour for the Tabs. More...
 
void background (int value)
 Set background colour for the Tabs. More...
 
int linecolour () const
 Get linecolour colour for the Tabs. More...
 
void linecolour (int value)
 Set linecolour colour for the Tabs. More...
 
int version () const
 Get tree view version. More...
 
void version (int value)
 Set tree view version. More...
 
unsigned int vertical_spacing () const
 
void vertical_spacing (unsigned int value)
 
unsigned int horizontal_spacing () const
 
void horizontal_spacing (unsigned int value)
 
- 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 Tabs gadget template.

Constructor & Destructor Documentation

◆ ResTreeView() [1/3]

tbx::ext::res::ResTreeView::ResTreeView ( const tbx::res::ResGadget other)
inline

Construct a tree view gadget resource.

Parameters
otherResGadget to copy resource from
Exceptions
ResGadgetTypeMismatchif the ResGadget is not a tree view

◆ ResTreeView() [2/3]

tbx::ext::res::ResTreeView::ResTreeView ( const ResTreeView other)
inline

Construct a tree view gadget resource.

Parameters
othertree view to copy resource from

◆ ResTreeView() [3/3]

tbx::ext::res::ResTreeView::ResTreeView ( )
inline

Construct a tree view gadget resource.

All options are false, default wimp colours set and messages are null.

Member Function Documentation

◆ background() [1/2]

int tbx::ext::res::ResTreeView::background ( ) const
inline

Get background colour for the Tabs.

Returns
background

◆ background() [2/2]

void tbx::ext::res::ResTreeView::background ( int  value)
inline

Set background colour for the Tabs.

Parameters
valuebackground wimp colour

◆ foreground() [1/2]

int tbx::ext::res::ResTreeView::foreground ( ) const
inline

Get foreground/text colour for the Tabs.

Returns
foreground/text wimp colour

◆ foreground() [2/2]

void tbx::ext::res::ResTreeView::foreground ( int  value)
inline

Set foreground/text colour for the Tabs.

Parameters
valueforeground/text wimp colour

◆ linecolour() [1/2]

int tbx::ext::res::ResTreeView::linecolour ( ) const
inline

Get linecolour colour for the Tabs.

Returns
linecolour

◆ linecolour() [2/2]

void tbx::ext::res::ResTreeView::linecolour ( int  value)
inline

Set linecolour colour for the Tabs.

Parameters
valuelinecolour wimp colour

◆ operator=() [1/2]

ResTreeView& tbx::ext::res::ResTreeView::operator= ( const ResTreeView other)
inline

Assign from another tree view gadget resource.

Parameters
othertree view gadget resource to copy

◆ operator=() [2/2]

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

Assign from a ResGadget.

Parameters
otherResGadget to copy
Exceptions
ResGadgetTypeMismatchif the ResGadget is not a tree view

◆ version() [1/2]

int tbx::ext::res::ResTreeView::version ( ) const
inline

Get tree view version.

Returns
tree view version number

◆ version() [2/2]

void tbx::ext::res::ResTreeView::version ( int  value)
inline

Set tree view version.

Parameters
valueversion of tree view

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