tbx
0.7.3
|
Object that can be shown at a specific position as well as its default place. More...
#include <showpointobject.h>
Public Member Functions | |
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. | |
![]() | |
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 | 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. | |
Object that can be shown at a specific position as well as its default place.
|
inline |
Constructor with no reference to a Toolbox object.
The object should be assigned to another object that contains a valid Toolbox object reference before it is used.
|
inline |
Construct from a Toolbox object id.
handle | Toolbox object id for an object supports the show with full details |
|
inline |
Construct as reference to another Toolbox object.
other | object to copy Toolbox object reference from |
|
inline |
Create a Toolbox object and make this object a reference to it.
template_name | name of template in the application resources |
OsError | Unable to create the Toolbox object |
|
inline |
Create Toolbox object from a memory template and make this object a reference to it.
object_template | in memory resource template |
OsError | Unable to create the Toolbox object |