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

VCF::Splitter Class Reference

Class Splitter documentation. More...

#include <vcf/ApplicationKit/Splitter.h>

Inheritance diagram for VCF::Splitter:

VCF::CustomControl VCF::Control VCF::UIComponent VCF::AbstractView VCF::Component VCF::View VCF::ObjectWithCallbacks VCF::Object List of all members.

Public Member Functions

 Splitter (const AlignmentType &alignment=AlignLeft)
virtual ~Splitter ()
void init ()
virtual void mouseDown (MouseEvent *e)
 Called when one (or more) of the mouse buttons are held down.
virtual void mouseMove (MouseEvent *e)
 Called when the mouse moves over the control.
virtual void mouseUp (MouseEvent *e)
 Called when one (or more) of the mouse buttons are released.
virtual void mouseDblClick (MouseEvent *e)
 Called when one or mouse buttons are held down and immediately released ( a "mouse double click" ) twice, within some specific time period, as determined on the windowing system.
virtual void paint (GraphicsContext *ctx)
 Paints the control.
bool getDblClickEnabled ()
void setDblClickEnabled (const bool &dblClickEnabled)
void setAlignment (const AlignmentType &alignment)
 sets the alignment of the control
void setMinimumWidth (const double &_minimumWidth)
double getMinimumWidth ()
virtual double getPreferredHeight ()
 returns the preferred height for this control.
virtual double getPreferredWidth ()
 returns the preferred width for this control.

Protected Member Functions

void updateAttachedControl (Point &pt, const bool &shiftAll=false)
 this is the function doing the real job
void updateAttachedControlJump (Point &pt, const bool &shiftAll=false)
 this is the function doing the real job when double clicking with the mouse

Protected Attributes

ControlattachedControl_
Point dragPoint_
Light3DBorder bdr_
ControlattachedControlAlt_
ControloutmostControl_
double deltaRestore_
double deltaRestoreAlt_
double minimumWidth_
bool dblClickEnabled_

Detailed Description

Class Splitter documentation.


Constructor & Destructor Documentation

VCF::Splitter::Splitter const AlignmentType alignment = AlignLeft  ) 
 

virtual VCF::Splitter::~Splitter  )  [virtual]
 


Member Function Documentation

bool VCF::Splitter::getDblClickEnabled  )  [inline]
 

double VCF::Splitter::getMinimumWidth  ) 
 

virtual double VCF::Splitter::getPreferredHeight  )  [virtual]
 

returns the preferred height for this control.

This is used when determing the height of the control when it is first created. Override it to provide a different value that is more acceptable for your control's initial display size.

Reimplemented from VCF::Control.

virtual double VCF::Splitter::getPreferredWidth  )  [virtual]
 

returns the preferred width for this control.

This is used when determing the width of the control when it is first created. Override it to provide a different value that is more acceptable for your control's initial display size.

Reimplemented from VCF::Control.

void VCF::Splitter::init  ) 
 

Reimplemented from VCF::CustomControl.

virtual void VCF::Splitter::mouseDblClick MouseEvent e  )  [virtual]
 

Called when one or mouse buttons are held down and immediately released ( a "mouse double click" ) twice, within some specific time period, as determined on the windowing system.

override this to provide specific behaviours when a mouse double click occurs

Reimplemented from VCF::Control.

virtual void VCF::Splitter::mouseDown MouseEvent e  )  [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::Splitter::mouseMove MouseEvent e  )  [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::Splitter::mouseUp MouseEvent e  )  [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::Splitter::paint GraphicsContext ctx  )  [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::Splitter::setAlignment const AlignmentType alignment  ) 
 

sets the alignment of the control

Reimplemented from VCF::Control.

void VCF::Splitter::setDblClickEnabled const bool &  dblClickEnabled  )  [inline]
 

void VCF::Splitter::setMinimumWidth const double &  _minimumWidth  ) 
 

void VCF::Splitter::updateAttachedControl Point pt,
const bool &  shiftAll = false
[protected]
 

this is the function doing the real job

void VCF::Splitter::updateAttachedControlJump Point pt,
const bool &  shiftAll = false
[protected]
 

this is the function doing the real job when double clicking with the mouse


Member Data Documentation

Control* VCF::Splitter::attachedControl_ [protected]
 

Control* VCF::Splitter::attachedControlAlt_ [protected]
 

Light3DBorder VCF::Splitter::bdr_ [protected]
 

bool VCF::Splitter::dblClickEnabled_ [protected]
 

double VCF::Splitter::deltaRestore_ [protected]
 

double VCF::Splitter::deltaRestoreAlt_ [protected]
 

Point VCF::Splitter::dragPoint_ [protected]
 

double VCF::Splitter::minimumWidth_ [protected]
 

Control* VCF::Splitter::outmostControl_ [protected]
 


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