tbx  0.7.6
Classes | Public Types | Public Member Functions | Protected Member Functions | Friends | List of all members
tbx::res::ResWindow Class Reference

Window resource object. More...

#include <reswindow.h>

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

Classes

class  const_gadget_iterator
 Constant iterator for gadgets in the window resource. More...
 
class  const_shortcut_iterator
 Constant iterator for shortcuts. More...
 
class  gadget_iterator
 Iterator for gadgets in the window resource. More...
 
class  shortcut_iterator
 Iterator for shortcuts. More...
 

Public Types

enum  { CLASS_ID = 0x82880 }
 

Public Member Functions

 ResWindow (std::string name, bool toolbar=false)
 Constructor and empty ResWindow. More...
 
 ResWindow (const ResWindow &other)
 Copy constructor. More...
 
 ResWindow (const ResObject &other)
 Construct from a ResObject. More...
 
ResWindowoperator= (const ResWindow &other)
 Assignment. More...
 
ResWindowoperator= (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 will be generated. More...
 
void generate_about_to_be_shown (bool value)
 Set if the about to be shown event will be generated. More...
 
bool auto_show () const
 Check if window is automatically shown. More...
 
void auto_show (bool value)
 Set if window is automatically shown. More...
 
bool auto_close () const
 Check if window is automatically closed. More...
 
void auto_close (bool value)
 Set if window is automatically closed. More...
 
bool generate_has_been_hidden () const
 Check if an event will be generated when the window has been hidden. More...
 
void generate_has_been_hidden (bool value)
 Set if an event will be generated when the window has been hidden. More...
 
bool toolbar () const
 Check if this template is for a toolbar. More...
 
void toolbar (bool value)
 Set if this template is for a toolbar. More...
 
const char * help_message () const
 Get the help message. More...
 
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.
 
const char * pointer_shape () const
 Get the name of the sprite to use for the mouse pointer when it is over this window. More...
 
void pointer_shape (const char *value, int max_length=-1)
 Set the name of the sprite to use for the mouse pointer when it is over this window. More...
 
void pointer_shape (const std::string &value, int max_length=-1)
 Set the name of the sprite to use for the mouse pointer when it is over this window. More...
 
int max_pointer_shape () const
 Get the maximum pointer shape length.
 
int pointer_x_hot () const
 Get the X position of the hotspot in the pointer. More...
 
void pointer_x_hot (int value)
 Set the X position of the hotspot in the pointer. More...
 
int pointer_y_hot () const
 Get the Y position of the hotspot in the pointer. More...
 
void pointer_y_hot (int value)
 Set the Y position of the hotspot in the pointer. More...
 
const char * menu () const
 Get the menu to be shown for this menu. More...
 
void menu (const char *value)
 Set the menu to be shown for this menu. More...
 
void menu (const std::string &value)
 Set the menu to be shown for this menu. More...
 
int num_shortcuts () const
 Get the number of shortcut keys in this window. More...
 
int num_gadgets () const
 Get the number of gadgets in this window. More...
 
ComponentId default_focus () const
 Get the component ID of the gadget to get the default focus. More...
 
void default_focus (ComponentId id)
 Set the component ID of the gadget to get the default focus. More...
 
int show_event () const
 Get the event ID of the event generated when the window is shown. More...
 
void show_event (int event_id)
 Set the event ID of the event generated when the window is shown. More...
 
int hide_event () const
 Get the event ID of the event generated when the window has been hidden. More...
 
void hide_event (int value)
 Set the event ID of the event generated when the window has been hidden. More...
 
const char * internal_bl_toolbar () const
 Get the name of the object to use for the internal bottom left toolbar. More...
 
void internal_bl_toolbar (const char *value)
 Set the name of the object to use for the internal bottom left toolbar. More...
 
void internal_bl_toolbar (const std::string &value)
 Set the name of the object to use for the internal bottom left toolbar. More...
 
const char * internal_tl_toolbar () const
 Get the name of the object to use for the internal top left toolbar. More...
 
void internal_tl_toolbar (const char *value)
 Set the name of the object to use for the internal top left toolbar. More...
 
void internal_tl_toolbar (const std::string &value)
 Set the name of the object to use for the internal top left toolbar. More...
 
const char * external_bl_toolbar () const
 Get the name of the object to use for the external bottom left toolbar. More...
 
void external_bl_toolbar (const char *value)
 Set the name of the object to use for the external bottom left toolbar. More...
 
void external_bl_toolbar (const std::string &value)
 Set the name of the object to use for the external bottom left toolbar. More...
 
const char * external_tl_toolbar () const
 Get the name of the object to use for the external top left toolbar. More...
 
void external_tl_toolbar (const char *value)
 Set the name of the object to use for the external top left toolbar. More...
 
void external_tl_toolbar (const std::string &value)
 Set the name of the object to use for the external top left toolbar. More...
 
int visible_xmin () const
 Get the minimum X coordinate of the visible part of the window. More...
 
void visible_xmin (int value)
 Set the minimum X coordinate of the visible part of the window. More...
 
int visible_ymin () const
 Get the minimum Y coordinate of the visible part of the window. More...
 
void visible_ymin (int value)
 Set the minimum Y coordinate of the visible part of the window. More...
 
int visible_xmax () const
 Get the maximum X coordinate of the visible part of the window. More...
 
void visible_xmax (int value)
 Set the maximum X coordinate of the visible part of the window. More...
 
int visible_ymax () const
 Get the maximum Y coordinate of the visible part of the window. More...
 
void visible_ymax (int value)
 Set the maximum Y coordinate of the visible part of the window. More...
 
int scroll_x () const
 Get the X scroll offset into the work area. More...
 
void scroll_x (int value)
 Set the X scroll offset into the work area. More...
 
int scroll_y () const
 Get the Y scroll offset into the work area. More...
 
void scroll_y (int value)
 Set the Y scroll offset into the work area. More...
 
int behind () const
 Get the WIMP window handle this window will be opened behind. More...
 
void behind (int value)
 Set the WIMP window handle this window will be opened behind. More...
 
unsigned int window_flags () const
 Get the window flags. More...
 
void window_flags (unsigned int value)
 Set the window flags. More...
 
bool moveable () const
 Check if the window will be moveable. More...
 
void moveable (bool move)
 Set if the window is moveable. More...
 
bool auto_redraw () const
 Check if window can be redrawn entirely by the WIMP. More...
 
void auto_redraw (bool on)
 Set if window can be redrawn entirely by the WIMP. More...
 
bool pane () const
 Check if a window is a pane. More...
 
void pane (bool p)
 Set if a window is a pane. More...
 
bool allow_off_screen () const
 Check if window is allowed off screen. More...
 
void allow_off_screen (bool allow)
 Set if window is allowed off screen. More...
 
bool user_scroll () const
 Check if a Scroll_Request event if returned with auto-repeat on the arrow icons and no auto-repeat on the outer scroll bar region. More...
 
void user_scroll (bool scroll)
 Set if a Scroll_Request event if returned with auto-repeat on the arrow icons and no auto-repeat on the outer scroll bar region. More...
 
bool user_scroll_debounced () const
 Check if a Scroll_Request event if returned with no auto-repeat on the arrow icons and no auto-repeat on the outer scroll bar region. More...
 
void user_scroll_debounced (bool scroll)
 Set if a Scroll_Request event if returned with no auto-repeat on the arrow icons and no auto-repeat on the outer scroll bar region. More...
 
bool real_colours () const
 Check if window colours are given as gcol numbers. More...
 
void real_colours (bool real)
 Set if window colours are given as gcol numbers. More...
 
bool top_window () const
 Check if window can be opened below this. More...
 
void top_window (bool tw)
 Set if window can be opened below this. More...
 
bool hot_keys () const
 Check if generates events for hot keys. More...
 
void hot_keys (bool generate)
 Set if generates events for hot keys. More...
 
bool force_on_screen () const
 Check if window is forced on screen. More...
 
void force_on_screen (bool on)
 Set if window is forced on screen. More...
 
bool ignore_right_extent () const
 Check if right extent is ignored. More...
 
void ignore_right_extent (bool ignore)
 Set if right extent is ignored. More...
 
bool ignore_lower_extent () const
 Check if lower extent is ignored. More...
 
void ignore_lower_extent (bool ignore)
 Set if lower extent is ignored. More...
 
bool back_icon () const
 Check if window has a back icon. More...
 
void back_icon (bool has_icon)
 Set if window has a back icon. More...
 
bool close_icon () const
 Check if window has a close icon. More...
 
void close_icon (bool has_icon)
 Set if window has a close icon. More...
 
bool titlebar () const
 Check if window has a title bar. More...
 
void titlebar (bool has_tb)
 Set if window has a title bar. More...
 
bool toggle_size_icon () const
 Check if window has a toggle size icon. More...
 
void toggle_size_icon (bool has_icon)
 Set if window has a toggle size icon. More...
 
bool vscrollbar () const
 Check if window has a vertical scroll bar. More...
 
void vscrollbar (bool has_vsb)
 Set if window has a vertical scroll bar. More...
 
bool adjust_size_icon () const
 Check if window has an adjust size icon. More...
 
void adjust_size_icon (bool has_icon)
 Set if window has an adjust size icon. More...
 
bool hscrollbar () const
 Check if window has a horizontal scroll bar. More...
 
void hscrollbar (bool has_hsb)
 Set if window has a horizontal scroll bar. More...
 
WimpColour title_fore () const
 Get the foreground/text colour for the title bar. More...
 
void title_fore (WimpColour value)
 Set the foreground/text colour for the title bar. More...
 
WimpColour title_back () const
 Get the background colour for the title bar. More...
 
void title_back (WimpColour value)
 Set the background colour for the title bar. More...
 
WimpColour work_fore () const
 Get the work area foreground colour. More...
 
void work_fore (WimpColour value)
 Set the work area foreground colour. More...
 
WimpColour work_back () const
 Get the work area background colour. More...
 
void work_back (WimpColour value)
 Set the work area background colour. More...
 
WimpColour scroll_outer () const
 Get the work area scroll bar outer colour. More...
 
void scroll_outer (WimpColour value)
 Set the scroll bar outer colour. More...
 
WimpColour scroll_inner () const
 Get the scroll bar inner colour. More...
 
void scroll_inner (WimpColour value)
 Set the scroll bar inner colour. More...
 
WimpColour title_inputfocus () const
 Get the background colour for the title bar when it has the input focus. More...
 
void title_inputfocus (WimpColour value)
 Set the background colour for the title bar when it has the input focus. More...
 
int work_xmin () const
 Get the minimum X coordinate of the work area extent. More...
 
void work_xmin (int value)
 Set the minimum X coordinate of the work area extent. More...
 
int work_ymin () const
 Get the minimum Y coordinate of the work area extent. More...
 
void work_ymin (int value)
 Set the minimum Y coordinate of the work area extent. More...
 
int work_xmax () const
 Get the maximum X coordinate of the work area extent. More...
 
void work_xmax (int value)
 Set the maximum X coordinate of the work area extent. More...
 
int work_ymax () const
 Get the maximum Y coordinate of the work area extent. More...
 
void work_ymax (int value)
 Set the maximum Y coordinate of the work area extent. More...
 
unsigned int title_flags () const
 Get the title flags. More...
 
void title_flags (unsigned int value)
 Set the title flags. More...
 
unsigned int button_type () const
 Get the button type. More...
 
void button_type (unsigned int value)
 Set the button type. More...
 
OsSpriteAreaPtr sprite_area () const
 Get a pointer to the sprite area used for client icons on this window. More...
 
void sprite_area (OsSpriteAreaPtr value)
 Set a pointer to the sprite area used for client icons on this window. More...
 
unsigned short min_width () const
 Get the minimum width for the window. More...
 
void min_width (unsigned short value)
 Set the minimum width for the window. More...
 
unsigned short min_height () const
 Get the minimum height for the window. More...
 
void min_height (unsigned short value)
 Set the minimum height for the window. More...
 
const char * title_text () const
 Get the text for the title of the window. More...
 
void title_text (const char *value)
 Set the text for the title of the window. More...
 
void title_text (const std::string &value)
 Set the text for the title of the window. More...
 
const char * title_validation () const
 Get the title validation. More...
 
void title_validation (const char *value)
 Set the title validation. More...
 
void title_validation (const std::string &value)
 Set the title validation. More...
 
int title_buflen () const
 Get the length of the buffer to hold the title. More...
 
void title_buflen (int value)
 Set the length of the buffer to hold the title. More...
 
const_shortcut_iterator shortcut_begin () const
 Get constant iterator to first shortcut. More...
 
const_shortcut_iterator shortcut_end () const
 Get constant iterator to end of shortcuts. More...
 
const_shortcut_iterator shortcut_cbegin () const
 Get constant iterator to first shortcut. More...
 
const_shortcut_iterator shortcut_cend () const
 Get constant iterator to end of shortcuts. More...
 
const_shortcut_iterator find_shortcut (int key_code) const
 Find shortcut with given key. More...
 
shortcut_iterator shortcut_begin ()
 Get iterator to first shortcut. More...
 
shortcut_iterator shortcut_end ()
 Get iterator to end of shortcuts. More...
 
shortcut_iterator find_shortcut (int key_code)
 Find shortcut for the given key. More...
 
ResShortcut shortcut (int key_code) const
 Get a copy of shortcut with key_code. More...
 
bool contains_shortcut (int key_code) const
 Returns true if Window contains a shortcut with the given id.
 
void add_shortcut (const ResShortcut &shortcut)
 Adds the shortcut to the end of the window. More...
 
void replace_shortcut (const ResShortcut &shortcut)
 Replace menu shortcut with same key_code as given shortcut. More...
 
void erase_shortcut (int key_code)
 Erase shortcut with specific key_code. More...
 
shortcut_iterator insert_shortcut (shortcut_iterator pos, const ResShortcut &shortcut)
 Insert shortcut at given position. More...
 
shortcut_iterator replace_shortcut (shortcut_iterator pos, const ResShortcut &shortcut)
 Replace the shortcut at the given iterator position. More...
 
shortcut_iterator erase_shortcut (shortcut_iterator pos)
 Delete the component at the given location. More...
 
const_gadget_iterator gadget_begin () const
 Get constant iterator to first gadget. More...
 
const_gadget_iterator gadget_end () const
 Get constant iterator to the end of the gadgets. More...
 
const_gadget_iterator gadget_cbegin () const
 Get constant iterator to first gadget. More...
 
const_gadget_iterator gadget_cend () const
 Get constant iterator to the end of the gadgets. More...
 
const_gadget_iterator find_gadget (int component_id) const
 Find gadget with given id. More...
 
gadget_iterator gadget_begin ()
 Get iterator to first gadget. More...
 
gadget_iterator gadget_end ()
 Get iterator to the end of the gadgets. More...
 
gadget_iterator find_gadget (int component_id)
 Find gadget with given id. More...
 
ResGadget gadget (ComponentId component_id) const
 Get a copy of gadget with given component id. More...
 
bool contains_gadget (ComponentId component_id) const
 Check if the window contains a gadget with the given id. More...
 
void add_gadget (const ResGadget &gadget)
 Adds the gadget to the end of the window. More...
 
void replace_gadget (const ResGadget &gadget)
 Replace menu gadget with same component id as given gadget. More...
 
void erase_gadget (ComponentId component_id)
 Erase gadget with specific id. More...
 
gadget_iterator insert_gadget (gadget_iterator pos, const ResGadget &gadget)
 Insert gadget at given position. More...
 
gadget_iterator replace_gadget (gadget_iterator pos, const ResGadget &gadget)
 Replace the gadget at the given iterator position. More...
 
gadget_iterator erase_gadget (gadget_iterator pos)
 Delete the component at the given location. 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...
 

Protected Member Functions

char * gadget_start () const
 Get pointer to position of first gadget in memory. More...
 
int first_gadget_offset () const
 Get offset to first gadget. More...
 
int end_gadget_offset () const
 Get offset to end of gadgets. More...
 
ResGadget gadget_at_offset (int item_offset) const
 Get a copy of the gadget at the given offset. More...
 
void next_gadget (int &item_offset) const
 Get offset to next gadget in window. More...
 
char * shortcut_start () const
 Get pointer to first short cut in memory. More...
 
int first_shortcut_offset () const
 Get offset of first shortcut in window. More...
 
int end_shortcut_offset () const
 Get offset to end of shortcuts in window. More...
 
ResShortcut shortcut_at_offset (int item_offset) const
 Get a copy of the shortcut at the given offset. More...
 
- 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...
 

Friends

class const_shortcut_iterator
 
class shortcut_iterator
 
class const_gadget_iterator
 
class gadget_iterator
 

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 Attributes inherited from tbx::res::ResBase
ResImpl * _impl
 Internal Resource implementation.
 

Detailed Description

Window resource object.

Constructor & Destructor Documentation

◆ ResWindow() [1/3]

tbx::res::ResWindow::ResWindow ( std::string  name,
bool  toolbar = false 
)
inline

Constructor and empty ResWindow.

Parameters
nametemplate name of the object
toolbartrue to set defaults for a toolbar

◆ ResWindow() [2/3]

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

Copy constructor.

Parameters
otherobject to create copy of

◆ ResWindow() [3/3]

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

Construct from a ResObject.

Parameters
otherobject to create copy of

Member Function Documentation

◆ add_gadget()

void tbx::res::ResWindow::add_gadget ( const ResGadget gadget)

Adds the gadget to the end of the window.

Parameters
gadget- gadget to add
Exceptions
ResGadgetExistsif the gadget's component id is already in the window

◆ add_shortcut()

void tbx::res::ResWindow::add_shortcut ( const ResShortcut shortcut)

Adds the shortcut to the end of the window.

Parameters
shortcut- shortcut to add
Exceptions
ResShortcutExistsif the shortcut's key_code is already in the window

◆ adjust_size_icon() [1/2]

bool tbx::res::ResWindow::adjust_size_icon ( ) const
inline

Check if window has an adjust size icon.

Returns
true if window has an adjust size icon

◆ adjust_size_icon() [2/2]

void tbx::res::ResWindow::adjust_size_icon ( bool  has_icon)
inline

Set if window has an adjust size icon.

Parameters
has_icontrue if window has an adjust size icon

◆ allow_off_screen() [1/2]

bool tbx::res::ResWindow::allow_off_screen ( ) const
inline

Check if window is allowed off screen.

Returns
true if window is allowed off screen

◆ allow_off_screen() [2/2]

void tbx::res::ResWindow::allow_off_screen ( bool  allow)
inline

Set if window is allowed off screen.

Parameters
allowtrue if window is allowed off screen

◆ auto_close() [1/2]

bool tbx::res::ResWindow::auto_close ( ) const
inline

Check if window is automatically closed.

Automatically close this Window when a WIMP CloseWindowRequest is received (when set the client will not see the underlying WIMP requests)

Returns
true if window will be automatically closed

◆ auto_close() [2/2]

void tbx::res::ResWindow::auto_close ( bool  value)
inline

Set if window is automatically closed.

Automatically close this Window when a WIMP CloseWindowRequest is received (when set the client will not see the underlying WIMP requests)

Parameters
valueset to true if window should be automatically closed

◆ auto_redraw() [1/2]

bool tbx::res::ResWindow::auto_redraw ( ) const
inline

Check if window can be redrawn entirely by the WIMP.

i.e there are no user graphics in the work area

Returns
true if WIMP can redraw whole Window

◆ auto_redraw() [2/2]

void tbx::res::ResWindow::auto_redraw ( bool  on)
inline

Set if window can be redrawn entirely by the WIMP.

i.e there are no user graphics in the work area

Parameters
ontrue if WIMP can redraw whole Window

◆ auto_show() [1/2]

bool tbx::res::ResWindow::auto_show ( ) const
inline

Check if window is automatically shown.

Automatically open this Window when a WIMP OpenWindowRequest is received (when set the client will not see the underlying WIMP requests)

Returns
true if window is automatically shown

◆ auto_show() [2/2]

void tbx::res::ResWindow::auto_show ( bool  value)
inline

Set if window is automatically shown.

Automatically open this Window when a WIMP OpenWindowRequest is received (when set the client will not see the underlying WIMP requests)

Parameters
valueset to true if window is automatically shown

◆ back_icon() [1/2]

bool tbx::res::ResWindow::back_icon ( ) const
inline

Check if window has a back icon.

Returns
true if window has a back icon

◆ back_icon() [2/2]

void tbx::res::ResWindow::back_icon ( bool  has_icon)
inline

Set if window has a back icon.

Parameters
has_icontrue if window has a back icon

◆ behind() [1/2]

int tbx::res::ResWindow::behind ( ) const
inline

Get the WIMP window handle this window will be opened behind.

Returns
WIMP window handle or -1 for on top

◆ behind() [2/2]

void tbx::res::ResWindow::behind ( int  value)
inline

Set the WIMP window handle this window will be opened behind.

Parameters
valueWIMP window handle or -1 for on top

◆ button_type() [1/2]

unsigned int tbx::res::ResWindow::button_type ( ) const
inline

Get the button type.

Returns
button type

◆ button_type() [2/2]

void tbx::res::ResWindow::button_type ( unsigned int  value)
inline

Set the button type.

Parameters
valuebutton type

◆ close_icon() [1/2]

bool tbx::res::ResWindow::close_icon ( ) const
inline

Check if window has a close icon.

Returns
true if window has a close icon

◆ close_icon() [2/2]

void tbx::res::ResWindow::close_icon ( bool  has_icon)
inline

Set if window has a close icon.

Parameters
has_icontrue if window has a close icon

◆ contains_gadget()

bool tbx::res::ResWindow::contains_gadget ( ComponentId  component_id) const

Check if the window contains a gadget with the given id.

Parameters
component_idcomponent ID of gadget to check
Returns
true if window contains a gadget with the given ID

◆ default_focus() [1/2]

ComponentId tbx::res::ResWindow::default_focus ( ) const
inline

Get the component ID of the gadget to get the default focus.

Returns
the component ID, FOCUS_TO_WINDOW if focus is on the window or NULL_ComponentID for none

◆ default_focus() [2/2]

void tbx::res::ResWindow::default_focus ( ComponentId  id)
inline

Set the component ID of the gadget to get the default focus.

Parameters
idthe component ID, FOCUS_TO_WINDOW if focus should be on the window or NULL_ComponentID for none

◆ end_gadget_offset()

int tbx::res::ResWindow::end_gadget_offset ( ) const
protected

Get offset to end of gadgets.

Returns
offset to end of gadgets or 0 if no gadgets

◆ end_shortcut_offset()

int tbx::res::ResWindow::end_shortcut_offset ( ) const
protected

Get offset to end of shortcuts in window.

Returns
offset to end of shortcuts or 0 if none

◆ erase_gadget() [1/2]

void tbx::res::ResWindow::erase_gadget ( ComponentId  id)

Erase gadget with specific id.

Parameters
idcomponent id
Exceptions
ResGadgetNotFoundif id is not in the Window

◆ erase_gadget() [2/2]

ResWindow::gadget_iterator tbx::res::ResWindow::erase_gadget ( gadget_iterator  pos)

Delete the component at the given location.

Parameters
positerator to gadget to be deleted
Returns
iterator to gadget following deleted gadget.

◆ erase_shortcut() [1/2]

void tbx::res::ResWindow::erase_shortcut ( int  key_code)

Erase shortcut with specific key_code.

Parameters
key_codeWIMP key code of shortcut to erase
Exceptions
ResShortcutNotFoundif key_code is not in the Window

◆ erase_shortcut() [2/2]

ResWindow::shortcut_iterator tbx::res::ResWindow::erase_shortcut ( shortcut_iterator  pos)

Delete the component at the given location.

Parameters
positerator to shortcut to erase
Returns
iterator to shortcut following erased shortcut

◆ external_bl_toolbar() [1/3]

const char* tbx::res::ResWindow::external_bl_toolbar ( ) const
inline

Get the name of the object to use for the external bottom left toolbar.

Returns
pointer to zero terminated toolbar object name or 0 if none.

◆ external_bl_toolbar() [2/3]

void tbx::res::ResWindow::external_bl_toolbar ( const char *  value)
inline

Set the name of the object to use for the external bottom left toolbar.

Parameters
valuepointer to zero terminated toolbar object name or 0 if none.

◆ external_bl_toolbar() [3/3]

void tbx::res::ResWindow::external_bl_toolbar ( const std::string &  value)
inline

Set the name of the object to use for the external bottom left toolbar.

Parameters
valuetoolbar object name.

◆ external_tl_toolbar() [1/3]

const char* tbx::res::ResWindow::external_tl_toolbar ( ) const
inline

Get the name of the object to use for the external top left toolbar.

Returns
pointer to zero terminated toolbar object name or 0 if none.

◆ external_tl_toolbar() [2/3]

void tbx::res::ResWindow::external_tl_toolbar ( const char *  value)
inline

Set the name of the object to use for the external top left toolbar.

Parameters
valuepointer to zero terminated toolbar object name or 0 if none.

◆ external_tl_toolbar() [3/3]

void tbx::res::ResWindow::external_tl_toolbar ( const std::string &  value)
inline

Set the name of the object to use for the external top left toolbar.

Parameters
valuetoolbar object name.

◆ find_gadget() [1/2]

ResWindow::gadget_iterator tbx::res::ResWindow::find_gadget ( int  component_id)

Find gadget with given id.

Parameters
component_idcomponent ID of gadget to find

◆ find_gadget() [2/2]

ResWindow::const_gadget_iterator tbx::res::ResWindow::find_gadget ( int  component_id) const

Find gadget with given id.

Parameters
component_idcomponent ID of gadget to find

◆ find_shortcut() [1/2]

ResWindow::shortcut_iterator tbx::res::ResWindow::find_shortcut ( int  key_code)

Find shortcut for the given key.

Parameters
key_codekey code for shortcut
Returns
shortcut_iterator or shortcut_end() if not found

◆ find_shortcut() [2/2]

ResWindow::const_shortcut_iterator tbx::res::ResWindow::find_shortcut ( int  key_code) const

Find shortcut with given key.

Parameters
key_codekey code for shortcut
Returns
const_shortcut_iterator or shortcut_cend() if not found

◆ first_gadget_offset()

int tbx::res::ResWindow::first_gadget_offset ( ) const
protected

Get offset to first gadget.

Returns
offset to first gadget or 0 if no gadgets

◆ first_shortcut_offset()

int tbx::res::ResWindow::first_shortcut_offset ( ) const
protected

Get offset of first shortcut in window.

Returns
offset to first shortcut or 0 if none

◆ flags() [1/2]

unsigned int tbx::res::ResWindow::flags ( ) const
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

◆ flags() [2/2]

void tbx::res::ResWindow::flags ( unsigned int  value)
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

◆ force_on_screen() [1/2]

bool tbx::res::ResWindow::force_on_screen ( ) const
inline

Check if window is forced on screen.

Returns
true if window if forced on screen

◆ force_on_screen() [2/2]

void tbx::res::ResWindow::force_on_screen ( bool  on)
inline

Set if window is forced on screen.

Parameters
ontrue if window if forced on screen

◆ gadget()

ResGadget tbx::res::ResWindow::gadget ( ComponentId  component_id) const

Get a copy of gadget with given component id.

Parameters
component_idto find
Exceptions
ResGadgetNotFoundif component can't be found

◆ gadget_at_offset()

ResGadget tbx::res::ResWindow::gadget_at_offset ( int  item_offset) const
protected

Get a copy of the gadget at the given offset.

This is for specialised use only - use gadget iterators for normal access to the gadgets in this window

◆ gadget_begin() [1/2]

gadget_iterator tbx::res::ResWindow::gadget_begin ( )
inline

Get iterator to first gadget.

Returns
iterator for first gadget

◆ gadget_begin() [2/2]

const_gadget_iterator tbx::res::ResWindow::gadget_begin ( ) const
inline

Get constant iterator to first gadget.

Returns
constant iterator for first gadget

◆ gadget_cbegin()

const_gadget_iterator tbx::res::ResWindow::gadget_cbegin ( ) const
inline

Get constant iterator to first gadget.

Returns
constant iterator for first gadget

◆ gadget_cend()

const_gadget_iterator tbx::res::ResWindow::gadget_cend ( ) const
inline

Get constant iterator to the end of the gadgets.

Returns
constant iterator to the position after the last gadget

◆ gadget_end() [1/2]

gadget_iterator tbx::res::ResWindow::gadget_end ( )
inline

Get iterator to the end of the gadgets.

Returns
iterator to the position after the last gadget

◆ gadget_end() [2/2]

const_gadget_iterator tbx::res::ResWindow::gadget_end ( ) const
inline

Get constant iterator to the end of the gadgets.

Returns
constant iterator to the position after the last gadget

◆ gadget_start()

char* tbx::res::ResWindow::gadget_start ( ) const
inlineprotected

Get pointer to position of first gadget in memory.

Returns
pointer to first gadget in memory or 0 if none

◆ generate_about_to_be_shown() [1/2]

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

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

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

◆ generate_about_to_be_shown() [2/2]

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

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

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

◆ generate_has_been_hidden() [1/2]

bool tbx::res::ResWindow::generate_has_been_hidden ( ) const
inline

Check if an event will be generated when the window has been hidden.

Returns
true if the event will be generated

◆ generate_has_been_hidden() [2/2]

void tbx::res::ResWindow::generate_has_been_hidden ( bool  value)
inline

Set if an event will be generated when the window has been hidden.

Parameters
valueset to true if the event should be generated

◆ help_message() [1/3]

const char* tbx::res::ResWindow::help_message ( ) const
inline

Get the help message.

Returns
pointer to zero terminated help message or 0 if none.

◆ help_message() [2/3]

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

Set the help message.

@param value pointer to zero terminated help message or 0 if none.
@param 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.

◆ help_message() [3/3]

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

Set the help message.

@param value help message.
@param 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.

◆ hide_event() [1/2]

int tbx::res::ResWindow::hide_event ( ) const
inline

Get the event ID of the event generated when the window has been hidden.

generate_has_been_hidden must be set for this event to be generated

@returns event ID or -1 for default.

◆ hide_event() [2/2]

void tbx::res::ResWindow::hide_event ( int  value)
inline

Set the event ID of the event generated when the window has been hidden.

generate_has_been_hidden must be set for this event to be generated

@param value event ID or -1 for default.

◆ hot_keys() [1/2]

bool tbx::res::ResWindow::hot_keys ( ) const
inline

Check if generates events for hot keys.

Returns
true if events are generated for hot keys

◆ hot_keys() [2/2]

void tbx::res::ResWindow::hot_keys ( bool  generate)
inline

Set if generates events for hot keys.

Parameters
generatetrue if events are generated for hot keys

◆ hscrollbar() [1/2]

bool tbx::res::ResWindow::hscrollbar ( ) const
inline

Check if window has a horizontal scroll bar.

Returns
true if window has a horizontal scroll bar

◆ hscrollbar() [2/2]

void tbx::res::ResWindow::hscrollbar ( bool  has_hsb)
inline

Set if window has a horizontal scroll bar.

Parameters
has_hsbtrue if window has a horizontal scroll bar

◆ ignore_lower_extent() [1/2]

bool tbx::res::ResWindow::ignore_lower_extent ( ) const
inline

Check if lower extent is ignored.

Returns
true if lower extent is ignored

◆ ignore_lower_extent() [2/2]

void tbx::res::ResWindow::ignore_lower_extent ( bool  ignore)
inline

Set if lower extent is ignored.

Parameters
ignoretrue if lower extent is ignored

◆ ignore_right_extent() [1/2]

bool tbx::res::ResWindow::ignore_right_extent ( ) const
inline

Check if right extent is ignored.

Returns
true if right extent is ignored

◆ ignore_right_extent() [2/2]

void tbx::res::ResWindow::ignore_right_extent ( bool  ignore)
inline

Set if right extent is ignored.

Parameters
ignoretrue if right extent is ignored

◆ insert_gadget()

ResWindow::gadget_iterator tbx::res::ResWindow::insert_gadget ( gadget_iterator  pos,
const ResGadget gadget 
)

Insert gadget at given position.

Parameters
posposition to insert the gadget before
gadgetgadget to insert
Returns
iterator to inserted gadget
Exceptions
ResGadgetExistsif a gadget with the same component ID already exists in the window

◆ insert_shortcut()

ResWindow::shortcut_iterator tbx::res::ResWindow::insert_shortcut ( shortcut_iterator  pos,
const ResShortcut shortcut 
)

Insert shortcut at given position.

Parameters
positerator to position to insert the shortcut
shortcutshortcut to insert
Returns
iterator to inserted shortcut
Exceptions
ResShortcutExistsif a shortcut with the same key code already exists.

◆ internal_bl_toolbar() [1/3]

const char* tbx::res::ResWindow::internal_bl_toolbar ( ) const
inline

Get the name of the object to use for the internal bottom left toolbar.

Returns
pointer to zero terminated toolbar object name or 0 if none.

◆ internal_bl_toolbar() [2/3]

void tbx::res::ResWindow::internal_bl_toolbar ( const char *  value)
inline

Set the name of the object to use for the internal bottom left toolbar.

Parameters
valuepointer to zero terminated toolbar object name or 0 if none.

◆ internal_bl_toolbar() [3/3]

void tbx::res::ResWindow::internal_bl_toolbar ( const std::string &  value)
inline

Set the name of the object to use for the internal bottom left toolbar.

Parameters
valuetoolbar object name.

◆ internal_tl_toolbar() [1/3]

const char* tbx::res::ResWindow::internal_tl_toolbar ( ) const
inline

Get the name of the object to use for the internal top left toolbar.

Returns
pointer to zero terminated toolbar object name or 0 if none.

◆ internal_tl_toolbar() [2/3]

void tbx::res::ResWindow::internal_tl_toolbar ( const char *  value)
inline

Set the name of the object to use for the internal top left toolbar.

Parameters
valuepointer to zero terminated toolbar object name or 0 if none.

◆ internal_tl_toolbar() [3/3]

void tbx::res::ResWindow::internal_tl_toolbar ( const std::string &  value)
inline

Set the name of the object to use for the internal top left toolbar.

Parameters
valuetoolbar object name.

◆ menu() [1/3]

const char* tbx::res::ResWindow::menu ( ) const
inline

Get the menu to be shown for this menu.

Returns
pointer to zero terminated menu object name or 0 for none

◆ menu() [2/3]

void tbx::res::ResWindow::menu ( const char *  value)
inline

Set the menu to be shown for this menu.

Parameters
valuepointer to zero terminated menu object name or 0 for none

◆ menu() [3/3]

void tbx::res::ResWindow::menu ( const std::string &  value)
inline

Set the menu to be shown for this menu.

Parameters
valuemenu object name

◆ min_height() [1/2]

unsigned short tbx::res::ResWindow::min_height ( ) const
inline

Get the minimum height for the window.

Returns
minimum height in OS units

◆ min_height() [2/2]

void tbx::res::ResWindow::min_height ( unsigned short  value)
inline

Set the minimum height for the window.

Parameters
valueminimum height in OS units

◆ min_width() [1/2]

unsigned short tbx::res::ResWindow::min_width ( ) const
inline

Get the minimum width for the window.

Returns
minimum width in OS units

◆ min_width() [2/2]

void tbx::res::ResWindow::min_width ( unsigned short  value)
inline

Set the minimum width for the window.

Parameters
valueminimum width in OS units

◆ moveable() [1/2]

bool tbx::res::ResWindow::moveable ( ) const
inline

Check if the window will be moveable.

Returns
true if the window is moveable

◆ moveable() [2/2]

void tbx::res::ResWindow::moveable ( bool  move)
inline

Set if the window is moveable.

Parameters
movetrue to make window moveable

◆ next_gadget()

void tbx::res::ResWindow::next_gadget ( int &  item_offset) const
protected

Get offset to next gadget in window.

Parameters
item_offsetcurrent offset. Updated to next offset.

◆ num_gadgets()

int tbx::res::ResWindow::num_gadgets ( ) const
inline

Get the number of gadgets in this window.

Returns
the number of gadgets

◆ num_shortcuts()

int tbx::res::ResWindow::num_shortcuts ( ) const
inline

Get the number of shortcut keys in this window.

Returns
the number of shortcut keys

◆ operator=() [1/2]

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

Assignment from ResObject.

Parameters
otherobject to create copy of

◆ operator=() [2/2]

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

Assignment.

Parameters
otherobject to create copy of

◆ pane() [1/2]

bool tbx::res::ResWindow::pane ( ) const
inline

Check if a window is a pane.

Returns
true if the window is a pane

◆ pane() [2/2]

void tbx::res::ResWindow::pane ( bool  p)
inline

Set if a window is a pane.

Parameters
ptrue if the window is a pane

◆ pointer_shape() [1/3]

const char* tbx::res::ResWindow::pointer_shape ( ) const
inline

Get the name of the sprite to use for the mouse pointer when it is over this window.

Returns
pointer to zero terminated sprite name or 0 if none

◆ pointer_shape() [2/3]

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

Set the name of the sprite to use for the mouse pointer when it is over this window.

Parameters
valuepointer to zero terminated sprite name or 0 if none
max_lengthmaximum length of sprite name the pointer shape will be set to or -1 to use the length of value.

◆ pointer_shape() [3/3]

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

Set the name of the sprite to use for the mouse pointer when it is over this window.

Parameters
valuesprite name
max_lengthmaximum length of sprite name the pointer shape will be set to or -1 to use the length of value.

◆ pointer_x_hot() [1/2]

int tbx::res::ResWindow::pointer_x_hot ( ) const
inline

Get the X position of the hotspot in the pointer.

Returns
X position of hotspot

◆ pointer_x_hot() [2/2]

void tbx::res::ResWindow::pointer_x_hot ( int  value)
inline

Set the X position of the hotspot in the pointer.

Parameters
valueX position of hotspot

◆ pointer_y_hot() [1/2]

int tbx::res::ResWindow::pointer_y_hot ( ) const
inline

Get the Y position of the hotspot in the pointer.

Returns
Y position of hotspot

◆ pointer_y_hot() [2/2]

void tbx::res::ResWindow::pointer_y_hot ( int  value)
inline

Set the Y position of the hotspot in the pointer.

Parameters
valueY position of hotspot

◆ real_colours() [1/2]

bool tbx::res::ResWindow::real_colours ( ) const
inline

Check if window colours are given as gcol numbers.

Returns
true if window colours are given as gcol numbers

◆ real_colours() [2/2]

void tbx::res::ResWindow::real_colours ( bool  real)
inline

Set if window colours are given as gcol numbers.

Parameters
realtrue if window colours are given as gcol numbers

◆ replace_gadget() [1/2]

void tbx::res::ResWindow::replace_gadget ( const ResGadget gadget)

Replace menu gadget with same component id as given gadget.

Parameters
gadgetgadget to replace
Exceptions
ResGadgetNotFoundif a gadget with the same component ID does not exist

◆ replace_gadget() [2/2]

ResWindow::gadget_iterator tbx::res::ResWindow::replace_gadget ( gadget_iterator  pos,
const ResGadget gadget 
)

Replace the gadget at the given iterator position.

Parameters
positerator pointing at gadget to replace
gadgetgadget to use as replacement
Returns
iterator to replacement gadget
Exceptions
ResGadgetExistsif component ID of replacement gadget matches an existing gadget in the window apart from the one replaced.

◆ replace_shortcut() [1/2]

void tbx::res::ResWindow::replace_shortcut ( const ResShortcut shortcut)

Replace menu shortcut with same key_code as given shortcut.

Parameters
shortcutshortcut to replace
Exceptions
ResShortcutNotFoundif shortcut with same key code is not in the window

◆ replace_shortcut() [2/2]

ResWindow::shortcut_iterator tbx::res::ResWindow::replace_shortcut ( shortcut_iterator  pos,
const ResShortcut shortcut 
)

Replace the shortcut at the given iterator position.

Parameters
posposition of shortcut to replace
shortcutreplacement shortcut
Returns
iterator to replacement shortcut
Exceptions
ResShortcutExistsif a shortcut apart from the replaced shortcut exists with the same key code as the replacement shortcut.

◆ scroll_inner() [1/2]

WimpColour tbx::res::ResWindow::scroll_inner ( ) const
inline

Get the scroll bar inner colour.

Returns
WIMP colour

◆ scroll_inner() [2/2]

void tbx::res::ResWindow::scroll_inner ( WimpColour  value)
inline

Set the scroll bar inner colour.

Parameters
valueWIMP colour

◆ scroll_outer() [1/2]

WimpColour tbx::res::ResWindow::scroll_outer ( ) const
inline

Get the work area scroll bar outer colour.

Returns
WIMP colour

◆ scroll_outer() [2/2]

void tbx::res::ResWindow::scroll_outer ( WimpColour  value)
inline

Set the scroll bar outer colour.

Parameters
valueWIMP colour

◆ scroll_x() [1/2]

int tbx::res::ResWindow::scroll_x ( ) const
inline

Get the X scroll offset into the work area.

Returns
X scroll offset in OS units

◆ scroll_x() [2/2]

void tbx::res::ResWindow::scroll_x ( int  value)
inline

Set the X scroll offset into the work area.

Parameters
valueX scroll offset in OS units

◆ scroll_y() [1/2]

int tbx::res::ResWindow::scroll_y ( ) const
inline

Get the Y scroll offset into the work area.

Returns
Y scroll offset in OS units

◆ scroll_y() [2/2]

void tbx::res::ResWindow::scroll_y ( int  value)
inline

Set the Y scroll offset into the work area.

Parameters
valueY scroll offset in OS units

◆ shortcut()

ResShortcut tbx::res::ResWindow::shortcut ( int  key_code) const

Get a copy of shortcut with key_code.

Parameters
key_codeto find
Exceptions
ResShortcutNotFoundif shortcut can't be found

◆ shortcut_at_offset()

ResShortcut tbx::res::ResWindow::shortcut_at_offset ( int  item_offset) const
protected

Get a copy of the shortcut at the given offset.

This is for specialised use only - use shortcut iterators for normal access to the shortcuts in this window

Parameters
item_offsetoffset to shortcut in the window
Returns
copy of shortcut at the given offset.

◆ shortcut_begin() [1/2]

shortcut_iterator tbx::res::ResWindow::shortcut_begin ( )
inline

Get iterator to first shortcut.

Returns
shortcut iterator

◆ shortcut_begin() [2/2]

const_shortcut_iterator tbx::res::ResWindow::shortcut_begin ( ) const
inline

Get constant iterator to first shortcut.

Returns
constant shortcut iterator

◆ shortcut_cbegin()

const_shortcut_iterator tbx::res::ResWindow::shortcut_cbegin ( ) const
inline

Get constant iterator to first shortcut.

Returns
constant shortcut iterator

◆ shortcut_cend()

const_shortcut_iterator tbx::res::ResWindow::shortcut_cend ( ) const
inline

Get constant iterator to end of shortcuts.

Returns
constant shortcut iterator to position after the last shortcut

◆ shortcut_end() [1/2]

shortcut_iterator tbx::res::ResWindow::shortcut_end ( )
inline

Get iterator to end of shortcuts.

Returns
shortcut iterator to position after the last shortcut

◆ shortcut_end() [2/2]

const_shortcut_iterator tbx::res::ResWindow::shortcut_end ( ) const
inline

Get constant iterator to end of shortcuts.

Returns
constant shortcut iterator to position after the last shortcut

◆ shortcut_start()

char* tbx::res::ResWindow::shortcut_start ( ) const
inlineprotected

Get pointer to first short cut in memory.

Returns
pointer to first shortcut in memory or 0 if none

◆ show_event() [1/2]

int tbx::res::ResWindow::show_event ( ) const
inline

Get the event ID of the event generated when the window is shown.

generate_about_to_be_shown must be set for this event to be generated

@returns event ID or -1 for default.

◆ show_event() [2/2]

void tbx::res::ResWindow::show_event ( int  event_id)
inline

Set the event ID of the event generated when the window is shown.

generate_about_to_be_shown must be set for this event to be generated

@param event_id event ID or -1 for default.

◆ sprite_area() [1/2]

OsSpriteAreaPtr tbx::res::ResWindow::sprite_area ( ) const
inline

Get a pointer to the sprite area used for client icons on this window.

Returns
OS Sprite area pointer

◆ sprite_area() [2/2]

void tbx::res::ResWindow::sprite_area ( OsSpriteAreaPtr  value)
inline

Set a pointer to the sprite area used for client icons on this window.

Parameters
valueOS Sprite area pointer

◆ title_back() [1/2]

WimpColour tbx::res::ResWindow::title_back ( ) const
inline

Get the background colour for the title bar.

Returns
WIMP colour

◆ title_back() [2/2]

void tbx::res::ResWindow::title_back ( WimpColour  value)
inline

Set the background colour for the title bar.

Parameters
valueWIMP colour

◆ title_buflen() [1/2]

int tbx::res::ResWindow::title_buflen ( ) const
inline

Get the length of the buffer to hold the title.

Returns
title buffer length

◆ title_buflen() [2/2]

void tbx::res::ResWindow::title_buflen ( int  value)
inline

Set the length of the buffer to hold the title.

Parameters
valuetitle buffer length

◆ title_flags() [1/2]

unsigned int tbx::res::ResWindow::title_flags ( ) const
inline

Get the title flags.

Returns
title flags 32 bit value

◆ title_flags() [2/2]

void tbx::res::ResWindow::title_flags ( unsigned int  value)
inline

Set the title flags.

Parameters
valuetitle flags 32 bit value

◆ title_fore() [1/2]

WimpColour tbx::res::ResWindow::title_fore ( ) const
inline

Get the foreground/text colour for the title bar.

Returns
WIMP colour

◆ title_fore() [2/2]

void tbx::res::ResWindow::title_fore ( WimpColour  value)
inline

Set the foreground/text colour for the title bar.

Parameters
valueWIMP colour

◆ title_inputfocus() [1/2]

WimpColour tbx::res::ResWindow::title_inputfocus ( ) const
inline

Get the background colour for the title bar when it has the input focus.

Returns
WIMP colour

◆ title_inputfocus() [2/2]

void tbx::res::ResWindow::title_inputfocus ( WimpColour  value)
inline

Set the background colour for the title bar when it has the input focus.

Parameters
valueWIMP colour

◆ title_text() [1/3]

const char* tbx::res::ResWindow::title_text ( ) const
inline

Get the text for the title of the window.

Returns
pointer to zero terminated title text

◆ title_text() [2/3]

void tbx::res::ResWindow::title_text ( const char *  value)
inline

Set the text for the title of the window.

Parameters
valuepointer to zero terminated title text

◆ title_text() [3/3]

void tbx::res::ResWindow::title_text ( const std::string &  value)
inline

Set the text for the title of the window.

Parameters
valuetitle text

◆ title_validation() [1/3]

const char* tbx::res::ResWindow::title_validation ( ) const
inline

Get the title validation.

Returns
pointer to zero terminated title validation string or -1 if none.

◆ title_validation() [2/3]

void tbx::res::ResWindow::title_validation ( const char *  value)
inline

Set the title validation.

Parameters
valuepointer to zero terminated title validation string or -1 if none.

◆ title_validation() [3/3]

void tbx::res::ResWindow::title_validation ( const std::string &  value)
inline

Set the title validation.

Parameters
valuetitle validation string

◆ titlebar() [1/2]

bool tbx::res::ResWindow::titlebar ( ) const
inline

Check if window has a title bar.

Returns
true if window has a title bar

◆ titlebar() [2/2]

void tbx::res::ResWindow::titlebar ( bool  has_tb)
inline

Set if window has a title bar.

Parameters
has_tbtrue if window has a title bar

◆ toggle_size_icon() [1/2]

bool tbx::res::ResWindow::toggle_size_icon ( ) const
inline

Check if window has a toggle size icon.

Returns
true if window has a toggle size icon

◆ toggle_size_icon() [2/2]

void tbx::res::ResWindow::toggle_size_icon ( bool  has_icon)
inline

Set if window has a toggle size icon.

Parameters
has_icontrue if window has a toggle size icon

◆ toolbar() [1/2]

bool tbx::res::ResWindow::toolbar ( ) const
inline

Check if this template is for a toolbar.

Returns
true if the template is for a toolbar

◆ toolbar() [2/2]

void tbx::res::ResWindow::toolbar ( bool  value)
inline

Set if this template is for a toolbar.

Parameters
valueset to true if the template is for a toolbar

◆ top_window() [1/2]

bool tbx::res::ResWindow::top_window ( ) const
inline

Check if window can be opened below this.

Returns
true if this is the top window

◆ top_window() [2/2]

void tbx::res::ResWindow::top_window ( bool  tw)
inline

Set if window can be opened below this.

Parameters
twtrue if this is the top window

◆ user_scroll() [1/2]

bool tbx::res::ResWindow::user_scroll ( ) const
inline

Check if a Scroll_Request event if returned with auto-repeat on the arrow icons and no auto-repeat on the outer scroll bar region.

Returns
if user scroll is on

◆ user_scroll() [2/2]

void tbx::res::ResWindow::user_scroll ( bool  scroll)
inline

Set if a Scroll_Request event if returned with auto-repeat on the arrow icons and no auto-repeat on the outer scroll bar region.

Parameters
scrolltrue to turn user scroll on

◆ user_scroll_debounced() [1/2]

bool tbx::res::ResWindow::user_scroll_debounced ( ) const
inline

Check if a Scroll_Request event if returned with no auto-repeat on the arrow icons and no auto-repeat on the outer scroll bar region.

Returns
if user scroll is on

◆ user_scroll_debounced() [2/2]

void tbx::res::ResWindow::user_scroll_debounced ( bool  scroll)
inline

Set if a Scroll_Request event if returned with no auto-repeat on the arrow icons and no auto-repeat on the outer scroll bar region.

Parameters
scrolltrue to turn user scroll on

◆ visible_xmax() [1/2]

int tbx::res::ResWindow::visible_xmax ( ) const
inline

Get the maximum X coordinate of the visible part of the window.

Returns
X coordinate in OS units

◆ visible_xmax() [2/2]

void tbx::res::ResWindow::visible_xmax ( int  value)
inline

Set the maximum X coordinate of the visible part of the window.

Parameters
valueX coordinate in OS units

◆ visible_xmin() [1/2]

int tbx::res::ResWindow::visible_xmin ( ) const
inline

Get the minimum X coordinate of the visible part of the window.

Returns
X coordinate in OS units

◆ visible_xmin() [2/2]

void tbx::res::ResWindow::visible_xmin ( int  value)
inline

Set the minimum X coordinate of the visible part of the window.

Parameters
valueX coordinate in OS units

◆ visible_ymax() [1/2]

int tbx::res::ResWindow::visible_ymax ( ) const
inline

Get the maximum Y coordinate of the visible part of the window.

Returns
Y coordinate in OS units

◆ visible_ymax() [2/2]

void tbx::res::ResWindow::visible_ymax ( int  value)
inline

Set the maximum Y coordinate of the visible part of the window.

Parameters
valueY coordinate in OS units

◆ visible_ymin() [1/2]

int tbx::res::ResWindow::visible_ymin ( ) const
inline

Get the minimum Y coordinate of the visible part of the window.

Returns
Y coordinate in OS units

◆ visible_ymin() [2/2]

void tbx::res::ResWindow::visible_ymin ( int  value)
inline

Set the minimum Y coordinate of the visible part of the window.

Parameters
valueY coordinate in OS units

◆ vscrollbar() [1/2]

bool tbx::res::ResWindow::vscrollbar ( ) const
inline

Check if window has a vertical scroll bar.

Returns
true if window has a vertical scroll bar

◆ vscrollbar() [2/2]

void tbx::res::ResWindow::vscrollbar ( bool  has_vsb)
inline

Set if window has a vertical scroll bar.

Parameters
has_vsbtrue if window has a vertical scroll bar

◆ window_flags() [1/2]

unsigned int tbx::res::ResWindow::window_flags ( ) const
inline

Get the window flags.

This gets all the window flags as one number, use the methods below for a more readable way to interrogate individual window flags

Returns
the window flags

◆ window_flags() [2/2]

void tbx::res::ResWindow::window_flags ( unsigned int  value)
inline

Set the window flags.

This sets all the window flags as one number, use the methods below for a more readble way to set the individual window flags.

Parameters
valuethe new window flags

◆ work_back() [1/2]

WimpColour tbx::res::ResWindow::work_back ( ) const
inline

Get the work area background colour.

Returns
WIMP colour

◆ work_back() [2/2]

void tbx::res::ResWindow::work_back ( WimpColour  value)
inline

Set the work area background colour.

Parameters
valueWIMP colour

◆ work_fore() [1/2]

WimpColour tbx::res::ResWindow::work_fore ( ) const
inline

Get the work area foreground colour.

Returns
WIMP colour

◆ work_fore() [2/2]

void tbx::res::ResWindow::work_fore ( WimpColour  value)
inline

Set the work area foreground colour.

Parameters
valueWIMP colour

◆ work_xmax() [1/2]

int tbx::res::ResWindow::work_xmax ( ) const
inline

Get the maximum X coordinate of the work area extent.

Returns
X coordinate in OS units

◆ work_xmax() [2/2]

void tbx::res::ResWindow::work_xmax ( int  value)
inline

Set the maximum X coordinate of the work area extent.

Parameters
valueX coordinate in OS units

◆ work_xmin() [1/2]

int tbx::res::ResWindow::work_xmin ( ) const
inline

Get the minimum X coordinate of the work area extent.

Returns
X coordinate in OS units

◆ work_xmin() [2/2]

void tbx::res::ResWindow::work_xmin ( int  value)
inline

Set the minimum X coordinate of the work area extent.

Parameters
valueX coordinate in OS units

◆ work_ymax() [1/2]

int tbx::res::ResWindow::work_ymax ( ) const
inline

Get the maximum Y coordinate of the work area extent.

Returns
Y coordinate in OS units

◆ work_ymax() [2/2]

void tbx::res::ResWindow::work_ymax ( int  value)
inline

Set the maximum Y coordinate of the work area extent.

Parameters
valueY coordinate in OS units

◆ work_ymin() [1/2]

int tbx::res::ResWindow::work_ymin ( ) const
inline

Get the minimum Y coordinate of the work area extent.

Returns
Y coordinate in OS units

◆ work_ymin() [2/2]

void tbx::res::ResWindow::work_ymin ( int  value)
inline

Set the minimum Y coordinate of the work area extent.

Parameters
valueY coordinate in OS units

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