Sourceforge.net - The VCF's Project Host
   The VCF Website Home   |   Online Discussion Forums   |   Sourceforge.net Project Page   

VCF::ToolbarDock Class Reference

A toolbar dock represents a rectangular child window that may hold o or more toolbars. More...

#include <ToolbarDock.h>

Inheritance diagram for VCF::ToolbarDock:

VCF::CustomControl VCF::DelegatedContainer< ToolbarDock > VCF::Control VCF::UIComponent VCF::AbstractView VCF::Component VCF::View VCF::ObjectWithCallbacks VCF::Object List of all members.

Public Member Functions

 ToolbarDock ()
virtual ~ToolbarDock ()
ToolbarDockSide getDockSide ()
void setDockSide (const ToolbarDockSide &dockSide)
ImagegetBackground ()
void setBackground (Image *background)
ToolbarBackgroundStyle getBackgroundStyle ()
void setBackgroundStyle (const ToolbarBackgroundStyle &backgroundStyle)
bool isUsingBackground ()
void setUsingBackground (const bool &usingBackground)
bool allowsDragging ()
void setAllowsDragging (const bool &allowsDrag)
virtual void paint (GraphicsContext *context)
 Paints the control.
virtual void mouseDown (MouseEvent *event)
 Called when one (or more) of the mouse buttons are held down.
virtual void mouseMove (MouseEvent *event)
 Called when the mouse moves over the control.
virtual void mouseUp (MouseEvent *event)
 Called when one (or more) of the mouse buttons are released.
void addToolbar (Toolbar *toolbar)

Protected Member Functions

virtual void add (Control *child)
 add overriden to prevent the adding of non-Toolbar Controls - this is the only type if control the ToolbarDock will allow - anythign will cause an exception to be thrown
virtual void add (Control *child, const AlignmentType &alignment)
virtual void remove (Control *child)
ToolbarfindToolbar (Point *pt)
void recalcToolbarLayout ()

Protected Attributes

ToolbarDockSide dockSide_
ToolbarBackgroundStyle backgroundStyle_
ImagebackgroundImage_
bool isUsingBackground_
bool allowsDockDragging_
std::vector< Toolbar * > toolbars_
double originalHeightWidth_

Detailed Description

A toolbar dock represents a rectangular child window that may hold o or more toolbars.

These toolbars may be attached to any of the four sides of the parent Window that holds them.


Constructor & Destructor Documentation

VCF::ToolbarDock::ToolbarDock  ) 
 

virtual VCF::ToolbarDock::~ToolbarDock  )  [virtual]
 


Member Function Documentation

virtual void VCF::ToolbarDock::add Control child,
const AlignmentType alignment
[protected, virtual]
 

Reimplemented from VCF::DelegatedContainer< ToolbarDock >.

virtual void VCF::ToolbarDock::add Control child  )  [protected, virtual]
 

add overriden to prevent the adding of non-Toolbar Controls - this is the only type if control the ToolbarDock will allow - anythign will cause an exception to be thrown

Reimplemented from VCF::DelegatedContainer< ToolbarDock >.

void VCF::ToolbarDock::addToolbar Toolbar toolbar  ) 
 

bool VCF::ToolbarDock::allowsDragging  ) 
 

Toolbar* VCF::ToolbarDock::findToolbar Point pt  )  [protected]
 

Image* VCF::ToolbarDock::getBackground  ) 
 

ToolbarBackgroundStyle VCF::ToolbarDock::getBackgroundStyle  ) 
 

ToolbarDockSide VCF::ToolbarDock::getDockSide  ) 
 

bool VCF::ToolbarDock::isUsingBackground  ) 
 

virtual void VCF::ToolbarDock::mouseDown MouseEvent event  )  [virtual]
 

Called when one (or more) of the mouse buttons are held down.

override this to provide specific behaviours when the mouse buttons are held down

Reimplemented from VCF::Control.

virtual void VCF::ToolbarDock::mouseMove MouseEvent event  )  [virtual]
 

Called when the mouse moves over the control.

override this to provide specific behaviours when the mouse moves over the control.

Reimplemented from VCF::Control.

virtual void VCF::ToolbarDock::mouseUp MouseEvent event  )  [virtual]
 

Called when one (or more) of the mouse buttons are released.

override this to provide specific behaviours when the mouse buttons are released.

Reimplemented from VCF::Control.

virtual void VCF::ToolbarDock::paint GraphicsContext context  )  [virtual]
 

Paints the control.

Called by the underlying windowing system whenever the control needs to be painted. Note that in some cases the GraphicsContext passed in to this method may not be the same pointer as the GraphicsContext that the control holds itself. During the paint() method you should only use the context value for all your drawing and not the one returned in getContext(). The value returned by getContext() should be used for drawing that takes place outside of the paint() method.

If the control allows paint notification, then the framework will fire an event to the BeforeControlPainted delegate prior to calling the control's paint() method. After the paint() method has returned, if the control allows paint notification, the framework will fire an event to the AfterControlPainted delegate. This allows outside observers to take part in the paint cycle, but beware that this does come at a bit of a cost, so use this feature sparingly.

Note: This should NEVER be called by programmers using the VCF, it will be called for you during the course of your applications native event loop, and is only here for providing custom drawing routines for controls. In other words: you implement it, you never call it yourself.

See also:
getAllowPaintNotification

Reimplemented from VCF::CustomControl.

void VCF::ToolbarDock::recalcToolbarLayout  )  [protected]
 

virtual void VCF::ToolbarDock::remove Control child  )  [protected, virtual]
 

Reimplemented from VCF::DelegatedContainer< ToolbarDock >.

void VCF::ToolbarDock::setAllowsDragging const bool &  allowsDrag  ) 
 

void VCF::ToolbarDock::setBackground Image background  ) 
 

void VCF::ToolbarDock::setBackgroundStyle const ToolbarBackgroundStyle backgroundStyle  ) 
 

void VCF::ToolbarDock::setDockSide const ToolbarDockSide dockSide  ) 
 

void VCF::ToolbarDock::setUsingBackground const bool &  usingBackground  ) 
 


Member Data Documentation

bool VCF::ToolbarDock::allowsDockDragging_ [protected]
 

Image* VCF::ToolbarDock::backgroundImage_ [protected]
 

ToolbarBackgroundStyle VCF::ToolbarDock::backgroundStyle_ [protected]
 

ToolbarDockSide VCF::ToolbarDock::dockSide_ [protected]
 

bool VCF::ToolbarDock::isUsingBackground_ [protected]
 

double VCF::ToolbarDock::originalHeightWidth_ [protected]
 

std::vector<Toolbar*> VCF::ToolbarDock::toolbars_ [protected]
 


The documentation for this class was generated from the following file:
   Comments or Suggestions?    License Information