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

Class to show a toolbox DCS object that gives the user an option to Discard, Cancel or Save a file. More...

#include <dcs.h>

Inheritance diagram for tbx::DCS:
tbx::ShowFullObject tbx::ShowPointObject tbx::Object

Public Types

enum  { TOOLBOX_CLASS = 0x82a80 }
 

Public Member Functions

 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...
 
DCSoperator= (const DCS &other)
 Assign this DCS from another. More...
 
DCSoperator= (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...
 
- Public Member Functions inherited from tbx::ShowFullObject
 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.
 
- 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.
 
void show ()
 Show the object at the default place. More...
 
- 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 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

- 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 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.

Constructor & Destructor Documentation

◆ DCS() [1/5]

tbx::DCS::DCS ( )
inline

Construct creates an unassigned DCS.

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

◆ DCS() [2/5]

tbx::DCS::DCS ( const DCS other)
inline

Construct a DCS from another DCS.

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

Parameters
otherDCS to copy.

◆ DCS() [3/5]

tbx::DCS::DCS ( const Object other)
inline

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

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 DCS

◆ DCS() [4/5]

tbx::DCS::DCS ( const std::string &  template_name)
inline

Create a DCS 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 DCS

◆ DCS() [5/5]

tbx::DCS::DCS ( const res::ResDCS object_template)

Create a DCS 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

◆ add_about_to_be_shown_listener()

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

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

Parameters
listenerabout to be shown listener to add

◆ add_cancel_listener()

void tbx::DCS::add_cancel_listener ( DCSCancelListener listener)

Add listener to be called when cancel is selected from the dialogue.

Parameters
listenercancel selected listener to add

◆ add_discard_listener()

void tbx::DCS::add_discard_listener ( DCSDiscardListener listener)

Add listener to be called when discard is selected from the dialogue.

Parameters
listenerdiscard selected listener to add

◆ add_has_been_hidden_listener()

void tbx::DCS::add_has_been_hidden_listener ( HasBeenHiddenListener listener)

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

Parameters
listenerhas been hidden listener to add

◆ add_save_listener()

void tbx::DCS::add_save_listener ( DCSSaveListener listener)

Add listener to be called when save is selected from the dialogue.

Parameters
listenersave selected listener to add

◆ operator!=()

bool tbx::DCS::operator!= ( const Object other) const
inline

Check if this DCS 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

◆ operator=() [1/2]

DCS& tbx::DCS::operator= ( const DCS other)
inline

Assign this DCS from another.

Both objects will then refer to the same underlying toolbox object

Parameters
otherDCS to copy
Returns
reference to this DCS

◆ operator=() [2/2]

DCS& tbx::DCS::operator= ( const Object other)
inline

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

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

Parameters
otherObject to copy.
Returns
reference to this DCS
Exceptions
ObjectNullExceptionif the other object refers to a null object handle
ObjectClassExceptionif the other object is not a DCS

◆ operator==()

bool tbx::DCS::operator== ( const Object other) const
inline

Check if this DCS 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

◆ remove_about_to_be_shown_listener()

void tbx::DCS::remove_about_to_be_shown_listener ( AboutToBeShownListener listener)

Remove about to be shown listener.

Parameters
listenerabout to be shown listener to remove

◆ remove_cancel_listener()

void tbx::DCS::remove_cancel_listener ( DCSCancelListener listener)

Remove listener to be called when cancel is selected from the dialogue.

Parameters
listenercancel selected listener to remove

◆ remove_discard_listener()

void tbx::DCS::remove_discard_listener ( DCSDiscardListener listener)

Remove listener to be called when discard is selected from the dialogue.

Parameters
listenerdiscard selected listener to remove

◆ remove_has_been_hidden_listener()

void tbx::DCS::remove_has_been_hidden_listener ( HasBeenHiddenListener listener)

Remove has been hidden listener.

Parameters
listenerhas been hidden listener to remove

◆ remove_save_listener()

void tbx::DCS::remove_save_listener ( DCSSaveListener listener)

Remove listener to be called when save is selected from the dialogue.

Parameters
listenersave selected listener to remove

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