Digital Spaces Portal
Wiki
Forum
Bug Tracker

DigitalSpaces::DICEGUIScrollablePane Struct Reference
[CEGUI]

#include <CEGUIInterfaces.h>

Inherits DigitalSpaces::DIObjectBase.


Public Member Functions

bool isVertScrollbarAlwaysShown ()
 Returns a pointer to the window holding the pane contents.
void setShowVertScrollbar (bool setting)
 Set whether the vertical scroll bar should always be shown.
bool isHorzScrollbarAlwaysShown ()
 Return whether the horizontal scroll bar is always shown.
void setShowHorzScrollbar (bool setting)
 Set whether the horizontal scroll bar should always be shown.
bool isContentPaneAutoSized ()
 Return whether the content pane is auto sized.
void setContentPaneAutoSized (bool setting)
 Set whether the content pane should be auto-sized.
void getContentPaneArea (out_Vector4f *area)
 Return the current content pane area for the ScrollablePane.
void setContentPaneArea (in_Vector4f *area)
 Set the current content pane area for the ScrollablePane.
float getHorizontalStepSize ()
 Returns the horizontal scrollbar step size as a fraction of one complete view page.
void setHorizontalStepSize (float step)
 Sets the horizontal scrollbar step size as a fraction of one complete view page.
float getHorizontalOverlapSize ()
 Returns the horizontal scrollbar overlap size as a fraction of one complete view page.
void setHorizontalOverlapSize (float overlap)
 Sets the horizontal scrollbar overlap size as a fraction of one complete view page.
float getHorizontalScrollPosition ()
 Returns the horizontal scroll position as a fraction of the complete scrollable width.
void setHorizontalScrollPosition (float position)
 Sets the horizontal scroll position as a fraction of the complete scrollable width.
float getVerticalStepSize ()
 Returns the vertical scrollbar step size as a fraction of one complete view page.
void setVerticalStepSize (float step)
 Sets the vertical scrollbar step size as a fraction of one complete view page.
float getVerticalOverlapSize ()
 Returns the vertical scrollbar overlap size as a fraction of one complete view page.
void setVerticalOverlapSize (float overlap)
 Sets the vertical scrollbar overlap size as a fraction of one complete view page.
float getVerticalScrollPosition ()
 Returns the vertical scroll position as a fraction of the complete scrollable height.
void setVerticalScrollPosition (float position)
 Sets the vertical scroll position as a fraction of the complete scrollable height.
void getViewableArea (out_Vector4f *area)
 Return a Rect that described the pane's viewable area, relative to this Window, in pixels.
DICEGUIScrollbar * getVertScrollbar ()
 Return a pointer to the vertical scrollbar component widget for this ScrollablePane.
DICEGUIScrollbar * getHorzScrollbar ()
 Return a pointer to the horizontal scrollbar component widget for this ScrollablePane.

Member Function Documentation

bool DigitalSpaces::DICEGUIScrollablePane::isVertScrollbarAlwaysShown (  ) 

Returns a pointer to the window holding the pane contents.

The purpose of this is so that attached windows may be inspected, client code may not modify the returned window in any way.

Returns:
Pointer to the ScrolledContainer that is acting as the container for the scrollable pane content. The returned window is const, client code should not modify the ScrolledContainer settings directly.
Return whether the vertical scroll bar is always shown.
Returns:
  • true if the scroll bar will always be shown even if it is not required.
  • false if the scroll bar will only be shown when it is required.

void DigitalSpaces::DICEGUIScrollablePane::setShowVertScrollbar ( bool  setting  ) 

Set whether the vertical scroll bar should always be shown.

Parameters:
setting 
  • true if the vertical scroll bar should be shown even when it is not required.
  • false if the vertical scroll bar should only be shown when it is required.
Returns:
Nothing.

bool DigitalSpaces::DICEGUIScrollablePane::isHorzScrollbarAlwaysShown (  ) 

Return whether the horizontal scroll bar is always shown.

Returns:
  • true if the scroll bar will always be shown even if it is not required.
  • false if the scroll bar will only be shown when it is required.

void DigitalSpaces::DICEGUIScrollablePane::setShowHorzScrollbar ( bool  setting  ) 

Set whether the horizontal scroll bar should always be shown.

Parameters:
setting 
  • true if the horizontal scroll bar should be shown even when it is not required.
  • false if the horizontal scroll bar should only be shown when it is required.
Returns:
Nothing.

bool DigitalSpaces::DICEGUIScrollablePane::isContentPaneAutoSized (  ) 

Return whether the content pane is auto sized.

Returns:
  • true to indicate the content pane will automatically resize itself.
  • false to indicate the content pane will not automatically resize itself.

void DigitalSpaces::DICEGUIScrollablePane::setContentPaneAutoSized ( bool  setting  ) 

Set whether the content pane should be auto-sized.

Parameters:
setting 
  • true to indicate the content pane should automatically resize itself.
  • false to indicate the content pane should not automatically resize itself.
Returns:
Nothing.

void DigitalSpaces::DICEGUIScrollablePane::getContentPaneArea ( out_Vector4f *  area  ) 

Return the current content pane area for the ScrollablePane.

Returns:
Rect object that details the current pixel extents of the content pane attached to this ScrollablePane.

void DigitalSpaces::DICEGUIScrollablePane::setContentPaneArea ( in_Vector4f *  area  ) 

Set the current content pane area for the ScrollablePane.

Note:
If the ScrollablePane is configured to auto-size the content pane this call will have no effect.
Parameters:
area Rect object that details the pixel extents to use for the content pane attached to this ScrollablePane.
Returns:
Nothing.

float DigitalSpaces::DICEGUIScrollablePane::getHorizontalStepSize (  ) 

Returns the horizontal scrollbar step size as a fraction of one complete view page.

Returns:
float value specifying the step size where 1.0f would be the width of the viewing area.

void DigitalSpaces::DICEGUIScrollablePane::setHorizontalStepSize ( float  step  ) 

Sets the horizontal scrollbar step size as a fraction of one complete view page.

Parameters:
step float value specifying the step size, where 1.0f would be the width of the viewing area.
Returns:
Nothing.

float DigitalSpaces::DICEGUIScrollablePane::getHorizontalOverlapSize (  ) 

Returns the horizontal scrollbar overlap size as a fraction of one complete view page.

Returns:
float value specifying the overlap size where 1.0f would be the width of the viewing area.

void DigitalSpaces::DICEGUIScrollablePane::setHorizontalOverlapSize ( float  overlap  ) 

Sets the horizontal scrollbar overlap size as a fraction of one complete view page.

Parameters:
overlap float value specifying the overlap size, where 1.0f would be the width of the viewing area.
Returns:
Nothing.

float DigitalSpaces::DICEGUIScrollablePane::getHorizontalScrollPosition (  ) 

Returns the horizontal scroll position as a fraction of the complete scrollable width.

Returns:
float value specifying the scroll position.

void DigitalSpaces::DICEGUIScrollablePane::setHorizontalScrollPosition ( float  position  ) 

Sets the horizontal scroll position as a fraction of the complete scrollable width.

Parameters:
position float value specifying the new scroll position.
Returns:
Nothing.

float DigitalSpaces::DICEGUIScrollablePane::getVerticalStepSize (  ) 

Returns the vertical scrollbar step size as a fraction of one complete view page.

Returns:
float value specifying the step size where 1.0f would be the height of the viewing area.

void DigitalSpaces::DICEGUIScrollablePane::setVerticalStepSize ( float  step  ) 

Sets the vertical scrollbar step size as a fraction of one complete view page.

Parameters:
step float value specifying the step size, where 1.0f would be the height of the viewing area.
Returns:
Nothing.

float DigitalSpaces::DICEGUIScrollablePane::getVerticalOverlapSize (  ) 

Returns the vertical scrollbar overlap size as a fraction of one complete view page.

Returns:
float value specifying the overlap size where 1.0f would be the height of the viewing area.

void DigitalSpaces::DICEGUIScrollablePane::setVerticalOverlapSize ( float  overlap  ) 

Sets the vertical scrollbar overlap size as a fraction of one complete view page.

Parameters:
overlap float value specifying the overlap size, where 1.0f would be the height of the viewing area.
Returns:
Nothing.

float DigitalSpaces::DICEGUIScrollablePane::getVerticalScrollPosition (  ) 

Returns the vertical scroll position as a fraction of the complete scrollable height.

Returns:
float value specifying the scroll position.

void DigitalSpaces::DICEGUIScrollablePane::setVerticalScrollPosition ( float  position  ) 

Sets the vertical scroll position as a fraction of the complete scrollable height.

Parameters:
position float value specifying the new scroll position.
Returns:
Nothing.

void DigitalSpaces::DICEGUIScrollablePane::getViewableArea ( out_Vector4f *  area  ) 

Return a Rect that described the pane's viewable area, relative to this Window, in pixels.

Returns:
Rect object describing the ScrollablePane's viewable area.

DICEGUIScrollbar* DigitalSpaces::DICEGUIScrollablePane::getVertScrollbar (  ) 

Return a pointer to the vertical scrollbar component widget for this ScrollablePane.

Returns:
Pointer to a Scrollbar object.
Exceptions:
UnknownObjectException Thrown if the vertical Scrollbar component does not exist.

DICEGUIScrollbar* DigitalSpaces::DICEGUIScrollablePane::getHorzScrollbar (  ) 

Return a pointer to the horizontal scrollbar component widget for this ScrollablePane.

Returns:
Pointer to a Scrollbar object.
Exceptions:
UnknownObjectException Thrown if the horizontal Scrollbar component does not exist.

The documentation for this struct was generated from the following file:
Generated on Sun Aug 31 17:46:30 2008 for Digital Spaces by  doxygen 1.5.6