gccv::ItemClient Class Reference

the base class for objects associated with a canvas item. More...

#include <item-client.h>

Inheritance diagram for gccv::ItemClient:

gccv::TextClient gcp::Arrow gcp::Atom gcp::Bond gcp::Electron gcp::MechanismArrow gcp::ReactionOperator gcp::TextObject gcp::MesomeryArrow gcp::ReactionArrow gcp::FragmentAtom gcp::Fragment gcp::Text gcp::FragmentResidue

List of all members.

Public Member Functions

 ItemClient ()
virtual ~ItemClient ()
virtual void AddItem ()
virtual void UpdateItem ()
virtual void SetSelected (int state)
ItemGetItem (void)

Protected Attributes

Itemm_Item


Detailed Description

the base class for objects associated with a canvas item.

The ItemClient class is a base class used to associate document objects to items in the canvas. The associated item might be a Group, and the client might be registered for all group children. If several items are associated to the same object, the m_Item member should be the toplevel group. Destroying an ItemClient instance will destroy the item.

Definition at line 44 of file item-client.h.


Constructor & Destructor Documentation

gccv::ItemClient::ItemClient (  ) 

The constructor.

virtual gccv::ItemClient::~ItemClient (  )  [virtual]

The destructor. Deletes the associated item if any.


Member Function Documentation

virtual void gccv::ItemClient::AddItem (  )  [virtual]

Used to add a representation of the Object in the view. This method might be overloaded for displayable Object classes unless the application uses another mechanism.

Reimplemented in gcp::Atom, gcp::Bond, gcp::Electron, gcp::FragmentAtom, gcp::Fragment, gcp::MechanismArrow, gcp::MesomeryArrow, gcp::ReactionArrow, gcp::ReactionOperator, and gcp::Text.

gccv::ItemClient::GetItem ( void   )  [inline]

Returns:
the associated item.

Definition at line 81 of file item-client.h.

virtual void gccv::ItemClient::SetSelected ( int  state  )  [virtual]

Parameters:
state the selection state of the Object.
Used to set the selection state of the Object inside the widget. The values of state are application dependant and have no default value.

Reimplemented in gcp::Arrow, gcp::Atom, gcp::Bond, gcp::Electron, gcp::FragmentAtom, gcp::Fragment, gcp::MechanismArrow, gcp::ReactionArrow, gcp::ReactionOperator, and gcp::Text.

virtual void gccv::ItemClient::UpdateItem (  )  [virtual]

Used to update the representation of the Object in the view. This method might be overloaded for displayable Object classes unless the application uses another mechanism.

Reimplemented in gcp::Bond, gcp::FragmentAtom, gcp::Fragment, gcp::MesomeryArrow, gcp::ReactionArrow, and gcp::Text.


Member Data Documentation

The associated item. Being protected, it can be set only from derived classes.

Definition at line 81 of file item-client.h.


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

Generated on Fri Sep 24 15:58:43 2010 for The Gnome Chemistry Utils by  doxygen 1.5.9