Main Page | Modules | Namespace List | Class Hierarchy | Class List | Namespace Members | Class Members

VIEW::CompositeMessage Class Reference
[Messages]

CompositeMessage is the base class of all messages concerning the change of one Composite. More...

#include <message.h>

Inheritance diagram for VIEW::CompositeMessage:

VIEW::Message List of all members.

Public Types

enum  CompositeMessageType {
  UNDEFINED = -1, NEW_COMPOSITE, REMOVED_COMPOSITE, CHANGED_COMPOSITE,
  CHANGED_COMPOSITE_HIERARCHY, SELECTED_COMPOSITE, DESELECTED_COMPOSITE, CENTER_CAMERA,
  NEW_MOLECULE
}

Public Member Functions

Constructors and Destructors
 CompositeMessage () throw ()
 Default Constructor.
 CompositeMessage (const Composite &composite, CompositeMessageType type, bool update_representations=true) throw ()
 CompositeMessage (const CompositeMessage &message) throw ()
 Copy constructor.
virtual ~CompositeMessage () throw ()
 Destructor.
Accessors: inspectors and mutators
void setComposite (const Composite &composite) throw ()
 Change the composite.
CompositegetComposite () const throw ()
 Inspection of the composite.
void setCompositeName (const String &name) throw ()
 Change the name of the composite.
const StringgetCompositeName () const throw ()
 Inspection of the name of the composite.
void setType (CompositeMessageType type) throw ()
CompositeMessageType getType () const throw ()
void setUpdateRepresentations (bool state) throw ()
bool updateRepresentations () const throw ()
void setShowSelectionInfos (bool state) throw ()
bool showSelectionInfos () throw ()

Protected Attributes

CompositeMessageType type_
Compositecomposite_
String composite_name_
bool update_representations_
bool show_selection_infos_

Detailed Description

CompositeMessage is the base class of all messages concerning the change of one Composite.

With it ConnectionObject can notify and react to Composite changes.


Member Enumeration Documentation

enum VIEW::CompositeMessage::CompositeMessageType
 

Enumeration values:
UNDEFINED  Undefinded (default) type.
NEW_COMPOSITE  A new composite to be added MolecularStructure will add bonds, normalize names and send a msg with type NEW_MOLECULE afterwards.

REMOVED_COMPOSITE  A Composite to be removed.
CHANGED_COMPOSITE  Update all datas for a Composite (but not in the MolecularControl).
CHANGED_COMPOSITE_HIERARCHY  Update all datas for a composite (also in MolecularControl).
SELECTED_COMPOSITE  selected a composite (e.g. per checkboxes in MolecularControl)
DESELECTED_COMPOSITE  deselected a composite (e.g. per checkboxes in MolecularControl)
CENTER_CAMERA  center the camera on a composite
NEW_MOLECULE  MolecularControl will add the Composite.

DisplayProperties will create a Representation


Constructor & Destructor Documentation

VIEW::CompositeMessage::CompositeMessage  )  throw ()
 

Default Constructor.

The state is set to:

  • composite - set to 0
  • composite name - set to ""


Member Function Documentation

Composite* VIEW::CompositeMessage::getComposite  )  const throw ()
 

Inspection of the composite.

const String& VIEW::CompositeMessage::getCompositeName  )  const throw ()
 

Inspection of the name of the composite.

void VIEW::CompositeMessage::setComposite const Composite composite  )  throw ()
 

Change the composite.

void VIEW::CompositeMessage::setCompositeName const String name  )  throw ()
 

Change the name of the composite.

Parameters:
name the new name of the composite of this compositeMessage