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

Class for Rick Griffins Tabs Gadget. More...

#include <tabs.h>

Inheritance diagram for tbx::ext::Tabs:
tbx::Gadget tbx::Component

Public Types

enum  { TOOLBOX_CLASS = 0x402c }
 

Public Member Functions

 Tabs ()
 Construct an uninitialised Tabs gadget.
 
 ~Tabs ()
 Destroy a Tabs gadget. More...
 
 Tabs (const Tabs &other)
 Construct a Tabs gadget from another Tabs gadget. More...
 
 Tabs (const Gadget &other)
 Construct a Tabs gadget from another gadget. More...
 
 Tabs (const tbx::Component &other)
 Construct a Tabs gadget from a gadget. More...
 
Tabsoperator= (const Tabs &other)
 Assign a Tabs gadget to refer to the same underlying toolbox gadget as another.
 
Tabsoperator= (const tbx::Gadget &other)
 Assign a Tabs gadget to refer to the same underlying toolbox gadget as an existing Gadget. More...
 
Tabsoperator= (const tbx::Component &other)
 Assign a Tabs gadget to refer to the same underlying toolbox component as an existing Gadget. More...
 
bool operator== (const tbx::Gadget &other) const
 Check if this Tabs gadget refers to the same underlying toolbox gadget as another gadget. More...
 
bool operator!= (const tbx::Gadget &other) const
 Check if this Tabs gadget refers to the same underlying toolbox gadget as another gadget. More...
 
void state (int value)
 Set the state.
 
int state () const
 Get the state of the Tabs gadget.
 
void selected (int index)
 Set selected tab. More...
 
int selected () const
 Get selected tab. More...
 
int tab_from_window (const tbx::Window &window)
 Get tab index from Window. More...
 
tbx::Window window_from_tab (int index)
 Get Window from tab index. More...
 
void label (int index, const std::string &text)
 Set the label for the tab. More...
 
std::string label (int index) const
 Returns the label for a specified index.
 
void hide_tab (int index, bool hide)
 Hide or show a tab. More...
 
void add_selection_listener (TabsSelectionListener *listener)
 
void remove_selection_listener (TabsSelectionListener *listener)
 
- Public Member Functions inherited from tbx::Gadget
 Gadget ()
 Construct an uninitialised gadget. More...
 
 Gadget (const Gadget &other)
 Construct a gadget as a copy of another gadget object. More...
 
 Gadget (const Component &other)
 Construct a gadget as a copy of another component object. More...
 
Window window ()
 Get the window that contains this gadget.
 
Window window () const
 Get the window that contains this gadget.
 
Gadgetoperator= (const Gadget &other)
 Assign this gadget to refer to the same underlying toolbox gadget as another gadget.
 
Gadgetoperator= (const Component &other)
 Assign this gadget to refer to the same underlying toolbox gadget as the specified Component. More...
 
bool operator== (const Component &other) const
 Check if this gadget refers to the same underlying toolbox component as the given Component. More...
 
bool operator!= (const Component &other) const
 Check if this gadget refers to the same underlying toolbox component as the given Component. More...
 
bool operator== (const Gadget &other) const
 Check if this gadget refers to the same underlying toolbox component as the given Gadget. More...
 
bool operator!= (const Gadget &other) const
 Check if this gadget refers to the same underlying toolbox component as the given Gadget. More...
 
void check_toolbox_class (int class_id) const
 Check the underlying gadget class for this object has the given class id. More...
 
int toolbox_class () const
 Get the toolbox class for a gadget. More...
 
int toolbox_class_and_size () const
 Get the toolbox class and size for a gadget. More...
 
unsigned int flags () const
 Return the gadget flags. More...
 
void set_flag (unsigned int set)
 Sets bits in the gadgets flags. More...
 
void clear_flag (unsigned int clear)
 Clear bits in the gadget flags. More...
 
void fade ()
 Fade the gadget.
 
void unfade ()
 Clear the gadgets fade state.
 
void fade (bool fade)
 Fade/unfade the gadget. More...
 
bool faded () const
 Check if the gadget is faded. More...
 
void focus ()
 Set input focus to the gadget. More...
 
std::vector< IconHandleicon_list ()
 Get list of icons used in this gadget. More...
 
BBox bounds () const
 Get the bounding box of the gadget.
 
void bounds (const BBox &bounds)
 Set the bounds of the gadget. More...
 
Point bottom_left () const
 Get the bottom left location of gadget. More...
 
Point top_left () const
 Get the top left location of gadget. More...
 
void move_to (const Point &pos)
 Move gadget (without resizing) More...
 
void move_to (int x, int y)
 Move gadget without resizing. More...
 
void move_by (int bx, int by)
 Move gadget relative to it's current position without resizing. More...
 
Size size () const
 Return the size of the gadget. More...
 
void size (const Size &sz)
 Set size of gadget without moving it. More...
 
void add_loader (Loader *loader, int file_type=-2)
 Add a file loader. More...
 
void remove_loader (Loader *loader, int file_type=-2)
 Remove a file loader. More...
 
- Public Member Functions inherited from tbx::Component
 Component ()
 Construct an uninitialised component. More...
 
 Component (Object obj, ComponentId id)
 Construct a component from an object and component id. More...
 
 Component (ObjectId handle, ComponentId id)
 Construct a component from an object handle and component id. More...
 
bool null () const
 Check if this component is in an uninitialised state. More...
 
Object object ()
 Return the object his component belongs to.
 
Object object () const
 Return the object his component belongs to.
 
ObjectId handle () const
 Return the object handle for his component.
 
ComponentId id () const
 Get the component ID of this component. More...
 
Componentoperator= (const Component &other)
 Assign the Component to refer to the same underlying toolbox component.
 
bool operator== (const Component &other) const
 Check if this component refers to the same underlying toolbox component. More...
 
bool operator!= (const Component &other) const
 Check if this component refers to the same underlying toolbox gadget. More...
 
 operator bool () const
 Operator to check if this component has been initialised. More...
 
void add_command (int command_id, Command *command)
 Add a command to this Component. More...
 
void remove_command (int command_id, Command *command)
 Remove a command from this component. More...
 
void add_user_event_listener (int event_id, UserEventListener *listener)
 Add a user event listener. More...
 
void remove_user_event_listener (int event_id, UserEventListener *listener)
 Remove a user event listener from this component. More...
 
void remove_all_listeners ()
 Remove all the listeners on this component. More...
 

Additional Inherited Members

- Protected Member Functions inherited from tbx::Component
void add_listener (int action, Listener *listener, RawToolboxEventHandler handler)
 Helper function to add listeners to this component. More...
 
void remove_listener (int action, Listener *listener)
 Helper function to remove listeners from this component.
 
void add_window_listener (int event_code, Listener *listener)
 Helper function to add a listener for a WIMP window event.
 
void remove_window_listener (int event_code, Listener *listener)
 Helper function to remove a listener for a WIMP window event.
 
int int_property (int property_id) const
 Get an integer property from the toolbox Component. More...
 
void int_property (int property_id, int value)
 Set an integer property from the toolbox object. More...
 
bool bool_property (int property_id) const
 Get a boolean property from the toolbox Component. More...
 
void bool_property (int property_id, bool value)
 Set a boolean property from the toolbox object. More...
 
std::string string_property (int property_id) const
 Get a string property from the toolbox object. More...
 
int string_property_length (int property_id) const
 Get a the length of a string property from the toolbox object. More...
 
void string_property (int property_id, const std::string &value)
 Set a string property in the toolbox object. More...
 
bool flag_property (int property_id, int flag) const
 Check if a particular flag is set in a property. More...
 
void flag_property (int property_id, int flag, bool value)
 Set a particular flag in a property. More...
 
- Protected Attributes inherited from tbx::Component
ObjectId _handle
 Underlying toolbox handle.
 
int _id
 Underlying toolbox component id.
 

Detailed Description

Class for Rick Griffins Tabs Gadget.

Constructor & Destructor Documentation

◆ ~Tabs()

tbx::ext::Tabs::~Tabs ( )
inline

Destroy a Tabs gadget.

This does not delete the underlying toolbox gadget.

◆ Tabs() [1/3]

tbx::ext::Tabs::Tabs ( const Tabs other)
inline

Construct a Tabs gadget from another Tabs gadget.

Both Tabs will refer to the same underlying toolbox gadget.

◆ Tabs() [2/3]

tbx::ext::Tabs::Tabs ( const Gadget other)
inline

Construct a Tabs gadget from another gadget.

The Tabs and the Gadget will refer to the same underlying toolbox gadget.

Exceptions
GadgetClassErrorif the underlying toolbox gadget isn't a Tabs gadget

◆ Tabs() [3/3]

tbx::ext::Tabs::Tabs ( const tbx::Component other)
inline

Construct a Tabs gadget from a gadget.

The Tabs and the Component will refer to the same underlying toolbox component.

Member Function Documentation

◆ hide_tab()

void tbx::ext::Tabs::hide_tab ( int  index,
bool  hide 
)

Hide or show a tab.

Parameters
indexindex of tab to hide/show
hidetrue to hide the tab, false to show it

◆ label()

void tbx::ext::Tabs::label ( int  index,
const std::string &  text 
)

Set the label for the tab.

By default the tab has the label of the window title.

◆ operator!=()

bool tbx::ext::Tabs::operator!= ( const tbx::Gadget other) const
inline

Check if this Tabs gadget refers to the same underlying toolbox gadget as another gadget.

Returns
true if they do not refer to the same underlying toolbox gadget.

◆ operator=() [1/2]

Tabs& tbx::ext::Tabs::operator= ( const tbx::Component other)
inline

Assign a Tabs gadget to refer to the same underlying toolbox component as an existing Gadget.

Exceptions
ObjectClassErrorif the component is not in a window.
GadgetClassErrorif the underlying toolbox gadget isn't a Tabs gadget

◆ operator=() [2/2]

Tabs& tbx::ext::Tabs::operator= ( const tbx::Gadget other)
inline

Assign a Tabs gadget to refer to the same underlying toolbox gadget as an existing Gadget.

Exceptions
GadgetClassErrorif the underlying toolbox gadget isn't a Tabs gadget

◆ operator==()

bool tbx::ext::Tabs::operator== ( const tbx::Gadget other) const
inline

Check if this Tabs gadget refers to the same underlying toolbox gadget as another gadget.

Returns
true if they refer to the same underlying toolbox gadget.

◆ selected() [1/2]

int tbx::ext::Tabs::selected ( ) const
inline

Get selected tab.

Returns
0 based index of selected tab

◆ selected() [2/2]

void tbx::ext::Tabs::selected ( int  index)
inline

Set selected tab.

Parameters
index0 based index to tab to select

◆ tab_from_window()

int tbx::ext::Tabs::tab_from_window ( const tbx::Window window)

Get tab index from Window.

Returns
index of supplied window or -1 if window not on tabs

◆ window_from_tab()

Window tbx::ext::Tabs::window_from_tab ( int  index)

Get Window from tab index.

Exceptions
OsExceptionif index invalid

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