|
| DCS () |
| Construct creates an unassigned DCS. More...
|
|
| DCS (const DCS &other) |
| Construct a DCS from another DCS. More...
|
|
| DCS (const Object &other) |
| Construct a DCS from an Object that refers to a DCS. More...
|
|
| DCS (const std::string &template_name) |
| Create a DCS from the named template. More...
|
|
| DCS (const res::ResDCS &object_template) |
| Create a DCS from an in memory template resource. More...
|
|
DCS & | operator= (const DCS &other) |
| Assign this DCS from another. More...
|
|
DCS & | operator= (const Object &other) |
| Assign this DCS from an Object that refers to a DCS. More...
|
|
bool | operator== (const Object &other) const |
| Check if this DCS refers to the same underlying toolbox object as another. More...
|
|
bool | operator!= (const Object &other) const |
| Check if this DCS does not refers to the same underlying toolbox object as another. More...
|
|
Window | window () const |
| Return the underlying toolbox window used to implement the DCS object.
|
|
void | message (std::string msg) |
| Set message to display in window.
|
|
std::string | message () const |
| Return message.
|
|
int | message_length () const |
| Return length of message.
|
|
void | title (std::string msg) |
| Set title of window.
|
|
std::string | title () const |
| Return title.
|
|
int | title_length () const |
| Return length of title.
|
|
void | add_about_to_be_shown_listener (AboutToBeShownListener *listener) |
| This event is raised just before the DCS 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 DCS dialog has been completed. More...
|
|
void | remove_has_been_hidden_listener (HasBeenHiddenListener *listener) |
| Remove has been hidden listener. More...
|
|
void | add_discard_listener (DCSDiscardListener *listener) |
| Add listener to be called when discard is selected from the dialogue. More...
|
|
void | remove_discard_listener (DCSDiscardListener *listener) |
| Remove listener to be called when discard is selected from the dialogue. More...
|
|
void | add_save_listener (DCSSaveListener *listener) |
| Add listener to be called when save is selected from the dialogue. More...
|
|
void | remove_save_listener (DCSSaveListener *listener) |
| Remove listener to be called when save is selected from the dialogue. More...
|
|
void | add_cancel_listener (DCSCancelListener *listener) |
| Add listener to be called when cancel is selected from the dialogue. More...
|
|
void | remove_cancel_listener (DCSCancelListener *listener) |
| Remove listener to be called when cancel is selected from the dialogue. More...
|
|
| ShowFullObject () |
| Constructor with no reference to a Toolbox object. More...
|
|
| ShowFullObject (ObjectId handle) |
| Construct from a Toolbox object id. More...
|
|
| ShowFullObject (const Object &other) |
| Construct as reference to another Toolbox object. More...
|
|
| ShowFullObject (const std::string &template_name) |
| Create a Toolbox object and make this object a reference to it. More...
|
|
| ShowFullObject (const res::ResObject &object_template) |
| Create Toolbox object from a memory template and make this object a reference to it. More...
|
|
void | show (const ShowFullSpec &full_spec) |
| Show object with full position specified.
|
|
void | show (const ShowFullSpec &full_spec, const Object &parent) |
| Show object with full position specified.
|
|
void | show (const ShowFullSpec &full_spec, const Component &parent) |
| Show object with full position specified.
|
|
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.
|
|
| 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...
|
|
Class to show a toolbox DCS object that gives the user an option to Discard, Cancel or Save a file.
This is usually used when someone tries to close a document that has been modified, but not saved.