tbx
0.7.6
|
Class to show a toolbox ColourMenu object. More...
#include <colourmenu.h>
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... | |
ColourMenu & | operator= (const ColourMenu &other) |
Assign this ColourMenu from another. More... | |
ColourMenu & | operator= (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... | |
![]() | |
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. | |
void | show () |
Show the object at the default place. More... | |
![]() | |
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... | |
Object & | operator= (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 | show_centred () |
Show the object in the centre of the screen. More... | |
void | show_at_pointer () |
Show the object at the current mouse position. 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 | |
![]() | |
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... | |
![]() | |
ObjectId | _handle |
Handle for toolbox object. | |
Class to show a toolbox ColourMenu object.
|
inline |
Construct creates an unassigned ColourMenu.
It must be assigned to a value before the other methods can be used.
|
inline |
Construct a ColourMenu from another ColourMenu.
This class then refers to the same underlying toolbox object as the other ColourMenu
other | ColourMenu to copy. |
|
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
other | Object to copy. |
ObjectNullException | if the other object refers to a null object handle |
ObjectClassException | if the other object is not a ColourMenu |
|
inline |
Create a ColourMenu from the named template.
template_name | The name of the template to create the object from |
OsError | if an object cannot be created from the named template |
ObjectClassException | if the template is not for a ColourMenu |
tbx::ColourMenu::ColourMenu | ( | const res::ResColourMenu & | object_template | ) |
Create a ColourMenu from an in memory template resource.
object_template | The template to create the object from |
OsError | if an object cannot be created from the template |
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.
listener | about 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.
listener | has 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.
listener | colour selected listener to add |
|
inline |
Set selected colour for menu.
colour | new colour for menu |
|
inline |
Set if "no colour" is available.
allow_none | true to allow no colour |
|
inline |
Check if this ColourMenu does not refers to the same underlying toolbox object as another.
other | Object to compare to |
|
inline |
Assign this ColourMenu from another.
Both objects will then refer to the same underlying toolbox object
other | ColourMenu to copy |
|
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
other | Object to copy. |
ObjectNullException | if the other object refers to a null object handle |
ObjectClassException | if the other object is not a ColourMenu |
|
inline |
Check if this ColourMenu refers to the same underlying toolbox object as another.
other | Object to compare to |
void tbx::ColourMenu::remove_about_to_be_shown_listener | ( | AboutToBeShownListener * | listener | ) |
Remove about to be shown listener.
listener | about to be shown listener to remove |
void tbx::ColourMenu::remove_has_been_hidden_listener | ( | HasBeenHiddenListener * | listener | ) |
Remove has been hidden listener.
listener | has been hidden listener to remove |
void tbx::ColourMenu::remove_selection_listener | ( | ColourMenuSelectionListener * | listener | ) |
Remove listener for menu colour selection.
listener | colour selected listener to remove |
|
inline |
Set Title.
msg | new title for the menu |