tbx  0.7.3
Public Types | Public Member Functions | List of all members
tbx::ColourMenu Class Reference

Class to show a toolbox ColourMenu object. More...

#include <colourmenu.h>

Inheritance diagram for tbx::ColourMenu:
tbx::ShowPointObject tbx::Object

Public Types

enum  { TOOLBOX_CLASS = 0x82980 }
 

Public Member Functions

 ColourMenu ()
 Construct creates an unassigned ColourMenu. More...
 
 ColourMenu (const ColourMenu &other)
 Construct a ColourMenu from another ColourMenu. More...
 
 ColourMenu (const Object &other)
 Construct a ColourMenu from an Object that refers to a ColourMenu. More...
 
 ColourMenu (const std::string &template_name)
 Create a ColourMenu from the named template. More...
 
 ColourMenu (const res::ResColourMenu &object_template)
 Create a ColourMenu from an in memory template resource. More...
 
ColourMenuoperator= (const ColourMenu &other)
 Assign this ColourMenu from another. More...
 
ColourMenuoperator= (const Object &other)
 Assign this ColourMenu from an Object that refers to a ColourMenu. More...
 
bool operator== (const Object &other) const
 Check if this ColourMenu refers to the same underlying toolbox object as another. More...
 
bool operator!= (const Object &other) const
 Check if this ColourMenu does not refers to the same underlying toolbox object as another. More...
 
void colour (WimpColour colour)
 Set selected colour for menu. More...
 
WimpColour colour ()
 Get selected menu colour.
 
void none_available (bool allow_none)
 Set if "no colour" is available. More...
 
bool none_availble () const
 Get if menu include "no colour" (none) option.
 
void title (std::string msg)
 Set Title. More...
 
std::string title () const
 Return title.
 
int title_length () const
 Return the length of the title.
 
void add_about_to_be_shown_listener (AboutToBeShownListener *listener)
 This event is raised just before the ColourMenu underlying window is about to be shown. More...
 
void remove_about_to_be_shown_listener (AboutToBeShownListener *listener)
 Remove about to be shown listener. More...
 
void add_has_been_hidden_listener (HasBeenHiddenListener *listener)
 This event is raised after the ColourMenu dialog has been completed. More...
 
void remove_has_been_hidden_listener (HasBeenHiddenListener *listener)
 Remove has been hidden listener. More...
 
void add_selection_listener (ColourMenuSelectionListener *listener)
 Add listener to be called when the a colour has been selected from the menu. More...
 
void remove_selection_listener (ColourMenuSelectionListener *listener)
 Remove listener for menu colour selection. More...
 
- Public Member Functions inherited from tbx::ShowPointObject
 ShowPointObject ()
 Constructor with no reference to a Toolbox object. More...
 
 ShowPointObject (ObjectId handle)
 Construct from a Toolbox object id. More...
 
 ShowPointObject (const Object &other)
 Construct as reference to another Toolbox object. More...
 
 ShowPointObject (const std::string &template_name)
 Create a Toolbox object and make this object a reference to it. More...
 
 ShowPointObject (const res::ResObject &object_template)
 Create Toolbox object from a memory template and make this object a reference to it. More...
 
void show (const Object &parent)
 Show object with given parent object.
 
void show (const Component &parent)
 Show object with given parent component.
 
void show (const Point &pos)
 Show object with top left at the given position.
 
void show (const Point &pos, const Object &parent)
 Show object with top left at the given position.
 
void show (const Point &pos, const Component &parent)
 Show object with top left at the given position.
 
void show_as_menu ()
 Show object as a menu at default position.
 
void show_as_menu (const Object &parent)
 Show object as a menu with the given parent.
 
void show_as_menu (const Component &parent)
 Show object as a menu with the given parent.
 
void show_as_menu (const Point &pos)
 Show object as a menu at the given point with the given parent.
 
void show_as_menu (const Point &pos, const Object &parent)
 Show object as a menu at the given point with the given parent.
 
void show_as_menu (const Point &pos, const Component &parent)
 Show object as a menu at the given point with the given parent.
 
void show_as_submenu (const MenuItem &parent)
 Show object as a sub menu from the given menu item.
 
void show_as_submenu (const Point &pos, const MenuItem &parent)
 Show object as a sub menu at the given point from the given menu item.
 
- Public Member Functions inherited from tbx::Object
 Object ()
 Constructs an object unattached to a toolbox object. More...
 
 Object (ObjectId handle)
 Construct an object referencing the given toolbox object. More...
 
 Object (const Object &other)
 Construct an object referencing the same toolbox object as another.
 
 Object (const std::string &template_name)
 Create a toolbox object with the given name in the application resources and assign a reference to it in this object. More...
 
void delete_object ()
 Delete the underlying toolbox object. More...
 
bool null () const
 Check if object has been initialised. More...
 
ObjectId handle () const
 Return the underlying toolbox object id this object references. More...
 
Objectoperator= (const Object &other)
 Assign this object to reference the same toolbox object as another. More...
 
bool operator== (const Object &other) const
 Check if this object references the same toolbox object as another. More...
 
bool operator!= (const Object &other) const
 Check if this object does not reference the same toolbox object as another. More...
 
 operator bool () const
 Operator to check if an object has been initialised. More...
 
int toolbox_class () const
 Get the toolbox class of this object. More...
 
void check_toolbox_class (int class_id) const
 Check if this objects toolbox class is as specified. More...
 
void * client_handle () const
 Return user defined handle stored against this object. More...
 
void client_handle (void *client_handle)
 Set a user defined handle for this object. More...
 
Object parent_object () const
 Get parent object. More...
 
Component parent_component () const
 Get parent component. More...
 
Object ancestor_object () const
 Get ancestor object. More...
 
Component ancestor_component () const
 Get ancestor component. More...
 
void show ()
 Show the object at the default place. More...
 
void hide ()
 Hide the object. More...
 
bool showing () const
 Check if an object is currently showing.
 
void add_command (int command_id, Command *command)
 Add a command to this Object. More...
 
void remove_command (int command_id, Command *command)
 Remove a command from this object. 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 object. More...
 
void add_object_deleted_listener (ObjectDeletedListener *listener)
 Add listener for when the toolbox object referenced by this object has been deleted. More...
 
void remove_object_deleted_listener (ObjectDeletedListener *listener)
 Remove listener for when the toolbox object referenced by this object has been deleted. More...
 
void remove_all_listeners ()
 Remove all listeners and commands from this object. More...
 

Additional Inherited Members

- Protected Member Functions inherited from tbx::Object
 Object (const res::ResObject &object_template)
 Protected constructor to create an object.
 
void add_listener (int action, Listener *listener, RawToolboxEventHandler handler)
 Add a listener for the given toolbox event. More...
 
void remove_listener (int action, Listener *listener)
 Remove listener for toolbox event. More...
 
void set_handler (int action, Listener *listener, RawToolboxEventHandler handler)
 Set handler for an event that should not have more than one listener. More...
 
int int_property (int property_id) const
 Return the value of a property that returns an integer. More...
 
void int_property (int property_id, int value)
 Set the value of a property that requires an integer. More...
 
std::string string_property (int property_id) const
 Return the value of a property that returns text. More...
 
void string_property (int property_id, const std::string &value)
 Set the value of a property that requires a string. More...
 
int string_property_length (int property_id) const
 Gets the size of a string properties buffer. More...
 
bool bool_property (int property_id) const
 Get a boolean property from the toolbox Cobject. More...
 
void bool_property (int property_id, bool value)
 Set a boolean property from the toolbox object. More...
 
- Protected Attributes inherited from tbx::Object
ObjectId _handle
 Handle for toolbox object.
 

Detailed Description

Class to show a toolbox ColourMenu object.

Constructor & Destructor Documentation

tbx::ColourMenu::ColourMenu ( )
inline

Construct creates an unassigned ColourMenu.

It must be assigned to a value before the other methods can be used.

tbx::ColourMenu::ColourMenu ( const ColourMenu other)
inline

Construct a ColourMenu from another ColourMenu.

This class then refers to the same underlying toolbox object as the other ColourMenu

Parameters
otherColourMenu to copy.
tbx::ColourMenu::ColourMenu ( const Object other)
inline

Construct a ColourMenu from an Object that refers to a ColourMenu.

This class then refers to the same underlying toolbox object as the other object

Parameters
otherObject to copy.
Exceptions
ObjectNullExceptionif the other object refers to a null object handle
ObjectClassExceptionif the other object is not a ColourMenu
tbx::ColourMenu::ColourMenu ( const std::string &  template_name)
inline

Create a ColourMenu from the named template.

Parameters
template_nameThe name of the template to create the object from
Exceptions
OsErrorif an object cannot be created from the named template
ObjectClassExceptionif the template is not for a ColourMenu
tbx::ColourMenu::ColourMenu ( const res::ResColourMenu object_template)

Create a ColourMenu from an in memory template resource.

Parameters
object_templateThe template to create the object from
Exceptions
OsErrorif an object cannot be created from the template

Member Function Documentation

void tbx::ColourMenu::add_about_to_be_shown_listener ( AboutToBeShownListener listener)

This event is raised just before the ColourMenu underlying window is about to be shown.

Parameters
listenerabout to be shown listener to add
void tbx::ColourMenu::add_has_been_hidden_listener ( HasBeenHiddenListener listener)

This event is raised after the ColourMenu dialog has been completed.

Parameters
listenerhas been hidden listener to add
void tbx::ColourMenu::add_selection_listener ( ColourMenuSelectionListener listener)

Add listener to be called when the a colour has been selected from the menu.

Parameters
listenercolour selected listener to add
void tbx::ColourMenu::colour ( WimpColour  colour)
inline

Set selected colour for menu.

Parameters
colournew colour for menu
void tbx::ColourMenu::none_available ( bool  allow_none)
inline

Set if "no colour" is available.

Parameters
allow_nonetrue to allow no colour
bool tbx::ColourMenu::operator!= ( const Object other) const
inline

Check if this ColourMenu does not refers to the same underlying toolbox object as another.

Parameters
otherObject to compare to
Returns
true if they do not refer to the same underlying toolbox object
ColourMenu& tbx::ColourMenu::operator= ( const ColourMenu other)
inline

Assign this ColourMenu from another.

Both objects will then refer to the same underlying toolbox object

Parameters
otherColourMenu to copy
Returns
reference to this ColourMenu
ColourMenu& tbx::ColourMenu::operator= ( const Object other)
inline

Assign this ColourMenu from an Object that refers to a ColourMenu.

This class then refers to the same underlying toolbox object as the other object

Parameters
otherObject to copy.
Returns
reference to this ColourMenu
Exceptions
ObjectNullExceptionif the other object refers to a null object handle
ObjectClassExceptionif the other object is not a ColourMenu
bool tbx::ColourMenu::operator== ( const Object other) const
inline

Check if this ColourMenu refers to the same underlying toolbox object as another.

Parameters
otherObject to compare to
Returns
true if they refer to the same underlying toolbox object
void tbx::ColourMenu::remove_about_to_be_shown_listener ( AboutToBeShownListener listener)

Remove about to be shown listener.

Parameters
listenerabout to be shown listener to remove
void tbx::ColourMenu::remove_has_been_hidden_listener ( HasBeenHiddenListener listener)

Remove has been hidden listener.

Parameters
listenerhas been hidden listener to remove
void tbx::ColourMenu::remove_selection_listener ( ColourMenuSelectionListener listener)

Remove listener for menu colour selection.

Parameters
listenercolour selected listener to remove
void tbx::ColourMenu::title ( std::string  msg)
inline

Set Title.

Parameters
msgnew title for the menu

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