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

VCF::TabbedPages Class Reference

#include <vcf/ApplicationKit/TabbedPages.h>

Inheritance diagram for VCF::TabbedPages:

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

Public Member Functions

 TabbedPages ()
virtual ~TabbedPages ()
void init ()
virtual void paint (GraphicsContext *context)
 Paints the control.
TabModelgetTabModel ()
void setTabModel (TabModel *model)
virtual void modelChanged (Model *oldModel, Model *newModel)
TabPageaddNewPage (const String &caption)
virtual Rect getClientBounds (const bool &includeBorder=true)
 Returns the bounds in terms of the control's coordinates.
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.
double getBorderWidth ()
void setBorderWidth (const double &borderWidth)
double getTabHeight ()
void setTabHeight (const double &tabHeight)
TabPagegetTabPage (const uint32 &index)
void setTabPage (const uint32 &index, TabPage *page)
TabPagegetPageFromPageName (const String &pageName)
TabPagegetSelectedPage ()
void setSelectedPage (TabPage *page)
void setSelectedPageByIndex (const uint32 &index)
TabSheetgetSelectedSheet ()
void setSelectedSheet (TabSheet *sheet)
bool isFirstPage (TabPage *page)
bool isLastPage (TabPage *page)
TabPagenextPage (TabPage *page)
TabPagepreviousPage (TabPage *page)
Enumerator< TabPage * > * getPages ()
virtual void handleEvent (Event *e)
 This gets called by the ControlPeer for any windowing system mouse events, as well as for any windowing system keyboard events and for any windowing system events like size changes, position changes, etc.

Protected Member Functions

double getTabPageWidth (TabPage *page, GraphicsContext *ctx=NULL)
void onScrollButtonClicked (ButtonEvent *e)
void onTabPageAdded (ListModelEvent *event)
void onTabPageRemoved (ListModelEvent *event)
void onTabPageSelected (TabModelEvent *event)

Protected Attributes

Rect tabAreaBounds_
Basic3DBorder activePageBorder_
double borderWidth_
double tabHeight_
double tabViewOffset_
Array< TabPage * > tabPages_
TabPageselectedPage_
bool internalTabChange_

Classes

class  ScrollButton

Constructor & Destructor Documentation

VCF::TabbedPages::TabbedPages  ) 
 

virtual VCF::TabbedPages::~TabbedPages  )  [virtual]
 


Member Function Documentation

TabPage* VCF::TabbedPages::addNewPage const String caption  ) 
 

double VCF::TabbedPages::getBorderWidth  ) 
 

virtual Rect VCF::TabbedPages::getClientBounds const bool &  includeBorder = true  )  [virtual]
 

Returns the bounds in terms of the control's coordinates.

Thus the top and left will typically be 0.0, 0.0, and the right and bottom of the bounds will typically equal the width and height of the control.

Reimplemented from VCF::Control.

TabPage* VCF::TabbedPages::getPageFromPageName const String pageName  ) 
 

Enumerator<TabPage*>* VCF::TabbedPages::getPages  ) 
 

TabPage* VCF::TabbedPages::getSelectedPage  ) 
 

TabSheet* VCF::TabbedPages::getSelectedSheet  ) 
 

double VCF::TabbedPages::getTabHeight  ) 
 

TabModel* VCF::TabbedPages::getTabModel  ) 
 

TabPage* VCF::TabbedPages::getTabPage const uint32 index  ) 
 

double VCF::TabbedPages::getTabPageWidth TabPage page,
GraphicsContext ctx = NULL
[protected]
 

virtual void VCF::TabbedPages::handleEvent Event e  )  [virtual]
 

This gets called by the ControlPeer for any windowing system mouse events, as well as for any windowing system keyboard events and for any windowing system events like size changes, position changes, etc.

Once inside the event the Control determines the type, and behaves accordingly, as well as notifying any appropriate listeners.

Reimplemented from VCF::Control.

void VCF::TabbedPages::init  ) 
 

Reimplemented from VCF::CustomControl.

bool VCF::TabbedPages::isFirstPage TabPage page  ) 
 

bool VCF::TabbedPages::isLastPage TabPage page  ) 
 

virtual void VCF::TabbedPages::modelChanged Model oldModel,
Model newModel
[virtual]
 

Reimplemented from VCF::Control.

virtual void VCF::TabbedPages::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::TabbedPages::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::TabbedPages::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.

TabPage* VCF::TabbedPages::nextPage TabPage page  ) 
 

void VCF::TabbedPages::onScrollButtonClicked ButtonEvent e  )  [protected]
 

void VCF::TabbedPages::onTabPageAdded ListModelEvent event  )  [protected]
 

void VCF::TabbedPages::onTabPageRemoved ListModelEvent event  )  [protected]
 

void VCF::TabbedPages::onTabPageSelected TabModelEvent event  )  [protected]
 

virtual void VCF::TabbedPages::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.

TabPage* VCF::TabbedPages::previousPage TabPage page  ) 
 

void VCF::TabbedPages::setBorderWidth const double &  borderWidth  ) 
 

void VCF::TabbedPages::setSelectedPage TabPage page  ) 
 

void VCF::TabbedPages::setSelectedPageByIndex const uint32 index  ) 
 

void VCF::TabbedPages::setSelectedSheet TabSheet sheet  ) 
 

void VCF::TabbedPages::setTabHeight const double &  tabHeight  ) 
 

void VCF::TabbedPages::setTabModel TabModel model  ) 
 

void VCF::TabbedPages::setTabPage const uint32 index,
TabPage page
 


Member Data Documentation

Basic3DBorder VCF::TabbedPages::activePageBorder_ [protected]
 

double VCF::TabbedPages::borderWidth_ [protected]
 

bool VCF::TabbedPages::internalTabChange_ [protected]
 

TabPage* VCF::TabbedPages::selectedPage_ [protected]
 

Rect VCF::TabbedPages::tabAreaBounds_ [protected]
 

double VCF::TabbedPages::tabHeight_ [protected]
 

Array<TabPage*> VCF::TabbedPages::tabPages_ [protected]
 

double VCF::TabbedPages::tabViewOffset_ [protected]
 


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