gcn::ScrollArea Class Reference

#include <scrollarea.h>

Inheritance diagram for gcn::ScrollArea:

Public Types
enum	{ SHOW_ALWAYS, SHOW_NEVER, SHOW_AUTO }

Public Member Functions
	ScrollArea ()
	ScrollArea (Widget *content)
	ScrollArea (Widget *content, unsigned int hPolicy, unsigned int vPolicy)
virtual	~ScrollArea ()
virtual void	setContent (Widget *widget)
virtual Widget *	getContent ()
virtual void	setHorizontalScrollPolicy (unsigned int hPolicy)
virtual unsigned int	getHorizontalScrollPolicy ()
virtual void	setVerticalScrollPolicy (unsigned int vPolicy)
virtual unsigned int	getVerticalScrollPolicy ()
virtual void	setScrollPolicy (unsigned int hPolicy, unsigned int vPolicy)
virtual void	scrollToBottom ()
virtual void	scrollToTop ()
virtual void	setVerticalScrollAmount (int vScroll)
virtual int	getVerticalScrollAmount ()
virtual void	setHorizontalScrollAmount (int hScroll)
virtual int	getHorizontalScrollAmount ()
virtual void	setScrollAmount (int hScroll, int vScroll)
virtual int	getHorizontalMaxScroll ()
virtual int	getVerticalMaxScroll ()
virtual void	setScrollbarWidth (int width)
virtual int	getScrollbarWidth ()
virtual void	scrollToRectangle (const Rectangle &rectangle)
virtual void	draw (Graphics *graphics)
virtual void	drawBorder (Graphics *graphics)
virtual void	logic ()
virtual void	_mouseInputMessage (const MouseInput &mouseInput)
virtual void	_mouseOutMessage ()
virtual void	_setFocusHandler (FocusHandler *focusHandler)
virtual void	_announceDeath (Widget *widget)
virtual void	getDrawSize (int &width, int &height, Widget *widget)
virtual void	moveToBottom (Widget *widget)
virtual void	moveToTop (Widget *widget)
virtual void	mousePress (int x, int y, int button)
virtual void	mouseRelease (int x, int y, int button)
virtual void	mouseMotion (int x, int y)
virtual void	mouseWheelUp (int x, int y)
virtual void	mouseWheelDown (int x, int y)
Public Member Functions inherited from gcn::BasicContainer
virtual	~BasicContainer ()
bool	isParentOfWidget (Widget *widget)
Public Member Functions inherited from gcn::Widget
	Widget ()
virtual	~Widget ()
virtual BasicContainer *	getParent () const
virtual void	setWidth (int width)
virtual int	getWidth () const
virtual void	setHeight (int height)
virtual int	getHeight () const
virtual void	setSize (int width, int height)
virtual void	setX (int x)
virtual int	getX () const
virtual void	setY (int y)
virtual int	getY () const
virtual void	setPosition (int x, int y)
virtual void	setDimension (const Rectangle &dimension)
virtual void	setBorderSize (unsigned int borderSize)
virtual unsigned int	getBorderSize () const
virtual const Rectangle &	getDimension () const
virtual void	setFocusable (bool focusable)
virtual bool	isFocusable () const
virtual bool	hasFocus () const
virtual void	setEnabled (bool enabled)
virtual bool	isEnabled () const
virtual void	lostFocus ()
virtual void	gotFocus ()
virtual bool	hasMouse () const
virtual void	setVisible (bool visible)
virtual bool	isVisible () const
virtual void	setBaseColor (const Color &color)
virtual const Color &	getBaseColor () const
virtual void	setForegroundColor (const Color &color)
virtual const Color &	getForegroundColor () const
virtual void	setBackgroundColor (const Color &color)
virtual const Color &	getBackgroundColor () const
virtual void	setDisabledColor (const Color &color)
virtual const Color &	getDisabledColor () const
virtual bool	_keyInputMessage (const KeyInput &keyInput)
virtual void	hotKeyPress ()
virtual void	hotKeyRelease ()
virtual void	_mouseInMessage ()
virtual void	requestFocus ()
virtual void	requestMoveToTop ()
virtual void	requestMoveToBottom ()
virtual FocusHandler *	_getFocusHandler ()
virtual void	addActionListener (ActionListener *actionListener)
virtual void	removeActionListener (ActionListener *actionListener)
virtual void	addMouseListener (MouseListener *mouseListener)
virtual void	removeMouseListener (MouseListener *mouseListener)
virtual void	addKeyListener (KeyListener *keyListener)
virtual void	removeKeyListener (KeyListener *keyListener)
virtual void	setEventId (const std::string &eventId)
virtual const std::string &	getEventId () const
virtual void	getAbsolutePosition (int &x, int &y) const
virtual void	_setParent (BasicContainer *parent)
Font *	getFont () const
virtual void	setFont (Font *font)
virtual void	fontChanged ()
virtual int	getHotKey () const
virtual void	setHotKey (const int key)
virtual void	setHotKey (const char *key)
virtual bool	isTabInEnabled () const
virtual void	setTabInEnabled (bool enabled)
virtual bool	isTabOutEnabled () const
virtual void	setTabOutEnabled (bool enabled)
virtual bool	isDragged () const
virtual void	requestModalFocus ()
virtual void	releaseModalFocus ()
virtual bool	hasModalFocus () const
virtual void	setDirty (bool dirty)
virtual bool	getDirty () const
Public Member Functions inherited from gcn::MouseListener
virtual	~MouseListener ()
virtual void	mouseIn ()
virtual void	mouseOut ()
virtual void	mouseClick (int, int, int, int)

Protected Member Functions
virtual void	drawUpButton (Graphics *graphics)
virtual void	drawDownButton (Graphics *graphics)
virtual void	drawLeftButton (Graphics *graphics)
virtual void	drawRightButton (Graphics *graphics)
virtual void	drawContent (Graphics *graphics)
virtual void	drawVBar (Graphics *graphics)
virtual void	drawHBar (Graphics *graphics)
virtual void	drawVMarker (Graphics *graphics)
virtual void	drawHMarker (Graphics *graphics)
virtual void	checkPolicies ()
virtual Rectangle	getUpButtonDimension ()
virtual Rectangle	getDownButtonDimension ()
virtual Rectangle	getLeftButtonDimension ()
virtual Rectangle	getRightButtonDimension ()
virtual Rectangle	getContentDimension ()
virtual Rectangle	getVerticalBarDimension ()
virtual Rectangle	getHorizontalBarDimension ()
virtual Rectangle	getVerticalMarkerDimension ()
virtual Rectangle	getHorizontalMarkerDimension ()
Protected Member Functions inherited from gcn::Widget
void	generateAction ()
Protected Member Functions inherited from gcn::MouseListener
	MouseListener ()

Protected Attributes
Widget *	mContent
int	mVScroll
int	mHScroll
int	mScrollbarWidth
unsigned int	mHPolicy
unsigned int	mVPolicy
bool	mVBarVisible
bool	mHBarVisible
bool	mUpButtonPressed
bool	mDownButtonPressed
bool	mLeftButtonPressed
bool	mRightButtonPressed
bool	mVerticalMarkerPressed
int	mVerticalMarkerMousePosition
bool	mHorizontalMarkerPressed
int	mHorizontalMarkerMousePosition
Protected Attributes inherited from gcn::Widget
MouseListenerList	mMouseListeners
KeyListenerList	mKeyListeners
ActionListenerList	mActionListeners
Color	mForegroundColor
Color	mBackgroundColor
Color	mBaseColor
Color	mDisabledColor
FocusHandler *	mFocusHandler
BasicContainer *	mParent
Rectangle	mDimension
unsigned int	mBorderSize
std::string	mEventId
int	mClickTimeStamp
int	mClickCount
int	mClickButton
bool	mHasMouse
bool	mFocusable
bool	mVisible
bool	mTabIn
bool	mTabOut
bool	mEnabled
Font *	mCurrentFont
int	mHotKey
bool	mDirty

Additional Inherited Members
Static Public Member Functions inherited from gcn::Widget
static void	setGlobalFont (Font *font)
static bool	widgetExists (const Widget *widget)
Protected Types inherited from gcn::Widget
typedef std::list< MouseListener * >	MouseListenerList
typedef MouseListenerList::iterator	MouseListenerIterator
typedef std::list< KeyListener * >	KeyListenerList
typedef KeyListenerList::iterator	KeyListenerIterator
typedef std::list< ActionListener * >	ActionListenerList
typedef ActionListenerList::iterator	ActionListenerIterator
Static Protected Attributes inherited from gcn::Widget
static DefaultFont	mDefaultFont
static Font *	mGlobalFont = NULL
static std::list< Widget * >	mWidgets

Detailed Description

A ScrollArea in which another Widget can be added. It the other Widget is bigger then the ScrollArea, the ScrollArea will only display the part of the Widget that fits the ScrollArea and make it possible to scroll to the other areas of the Widget.

NOTE: A TextBox or a ListBox looks really ugly unless they exist in a ScrollArea.

Member Enumeration Documentation

anonymous enum

anonymous enum

Scrollpolicies for the horizontal and vertical scrollbar. The policies are:

SHOW_ALWAYS - Always show the scrollbars no matter what. SHOW_NEVER - Never show the scrollbars no matter waht. SHOW_AUTO - Show the scrollbars only when needed. That is if the content grows larger then the ScrollArea.

Enumerator
SHOW_ALWAYS
SHOW_NEVER
SHOW_AUTO

Constructor & Destructor Documentation

ScrollArea() [1/3]

gcn::ScrollArea::ScrollArea

(

)

Constructor.

ScrollArea() [2/3]

gcn::ScrollArea::ScrollArea

(

Widget *

content

)

Constructor.

Parameters

content

the content of the ScrollArea.

ScrollArea() [3/3]

gcn::ScrollArea::ScrollArea	(	Widget *	content,
		unsigned int	hPolicy,
		unsigned int	vPolicy
	)

Constructor.

Parameters

content	the content of the ScrollArea.
hPolicy	the policy for the horizontal scrollbar. See enum with policies.
vPolicy	the policy for the vertical scrollbar. See enum with policies.

~ScrollArea()

gcn::ScrollArea::~ScrollArea ( )

virtual

Destructor.

Member Function Documentation

_announceDeath()

void gcn::ScrollArea::_announceDeath ( Widget *  widget )

virtual

Called when a child of the BasicContainer gets destroyed.

Parameters

widget

the destroyed Widget.

Implements gcn::BasicContainer.

_mouseInputMessage()

void gcn::ScrollArea::_mouseInputMessage ( const MouseInput &  mouseInput )

virtual

Called when a Widget recieves a MouseInput.

WARNING: This function is used internally to handle all mouse messages. Don't call or overload it unless you know what you are doing.

Parameters

mouseInput

the MouseInput message.

Reimplemented from gcn::Widget.

_mouseOutMessage()

void gcn::ScrollArea::_mouseOutMessage ( )

virtual

Called when the mouse leaves the Widget area.

WARNING: This function is used internally be to handle mouse out messages. Don't call or overload this function unless you know what you are doing.

Reimplemented from gcn::Widget.

_setFocusHandler()

void gcn::ScrollArea::_setFocusHandler ( FocusHandler *  focusHandler )

virtual

Sets the FocusHandler to be used.

WARNING: This function is used internally and should not be called or overloaded unless you know what you are doing.

Parameters

focusHandler

the FocusHandler to use.

Reimplemented from gcn::Widget.

checkPolicies()

void gcn::ScrollArea::checkPolicies ( )

protectedvirtual

Checks the policies for the scrollbars.

draw()

void gcn::ScrollArea::draw ( Graphics *  graphics )

virtual

Draws the Widget. It is called by the parent widget when it is time for the Widget to draw itself. The graphics object is set up so that all drawing is relative to the Widget, i.e coordinate (0,0) is the top-left corner of the Widget. It is not possible to draw outside of a Widgets dimension.

Parameters

graphics

a Graphics object to draw with.

Implements gcn::Widget.

Reimplemented in ImageListBoxWidget.

drawBorder()

void gcn::ScrollArea::drawBorder ( Graphics *  )

virtual

Draws a the Widget border. A border is drawn around a Widget. The width and height of the border is therefore the Widgets height+2*bordersize. Think of a painting that has a certain size, the border surrounds the painting.

Parameters

graphics

a Graphics object to draw with.

Reimplemented from gcn::Widget.

Reimplemented in ImageListBoxWidget.

drawContent()

void gcn::ScrollArea::drawContent ( Graphics *  graphics )

protectedvirtual

Draws the content in the ScrollArea.

Parameters

graphics

a Graphics object to draw with.

drawDownButton()

void gcn::ScrollArea::drawDownButton ( Graphics *  graphics )

protectedvirtual

Draws the down button.

Parameters

graphics

a Graphics object to draw with.

drawHBar()

void gcn::ScrollArea::drawHBar ( Graphics *  graphics )

protectedvirtual

Draws the horizontal scrollbar.

Parameters

graphics

a Graphics object to draw with.

drawHMarker()

void gcn::ScrollArea::drawHMarker ( Graphics *  graphics )

protectedvirtual

Draws the horizontal marker.

Parameters

graphics

a Graphics object to draw with.

drawLeftButton()

void gcn::ScrollArea::drawLeftButton ( Graphics *  graphics )

protectedvirtual

Draws the left button.

Parameters

graphics

a Graphics object to draw with.

drawRightButton()

void gcn::ScrollArea::drawRightButton ( Graphics *  graphics )

protectedvirtual

Draws the right button.

Parameters

graphics

a Graphics object to draw with.

drawUpButton()

void gcn::ScrollArea::drawUpButton ( Graphics *  graphics )

protectedvirtual

Draws the up button.

Parameters

graphics

a Graphics object to draw with.

drawVBar()

void gcn::ScrollArea::drawVBar ( Graphics *  graphics )

protectedvirtual

Draws the vertical scrollbar.

Parameters

graphics

a Graphics object to draw with.

drawVMarker()

void gcn::ScrollArea::drawVMarker ( Graphics *  graphics )

protectedvirtual

Draws the vertical marker.

Parameters

graphics

a Graphics object to draw with.

getContent()

Widget * gcn::ScrollArea::getContent ( )

virtual

Gets the content.

Returns

the content of the ScrollArea.

getContentDimension()

Rectangle gcn::ScrollArea::getContentDimension ( )

protectedvirtual

Gets the content dimension.

Returns

the dimension of the content.

getDownButtonDimension()

Rectangle gcn::ScrollArea::getDownButtonDimension ( )

protectedvirtual

Gets the down button dimension.

Returns

the dimension of the down button.

getDrawSize()

void gcn::ScrollArea::getDrawSize ( int &  width, int &  height, Widget *  widget  )

virtual

Gets the drawing space size a Widget has in the BasicContainer. It may not be the same size as the Widgets width and height.

NOTE: Size is not checked recursively all the way back to the top Widget. If the BasicContainer itself is clipped, the size may be inaccurate.

Parameters

width	the width the Widget's draw space has.
height	the height the Widget's draw space has.
widget	the Widget calling the function.

Implements gcn::BasicContainer.

getHorizontalBarDimension()

Rectangle gcn::ScrollArea::getHorizontalBarDimension ( )

protectedvirtual

Gets the horizontal scrollbar dimension.

Returns

the dimension of the horizontal scrollbar.

getHorizontalMarkerDimension()

Rectangle gcn::ScrollArea::getHorizontalMarkerDimension ( )

protectedvirtual

Gets the horizontal marker dimension.

Returns

the dimension of the horizontal marker.

Reimplemented in ImageListBoxWidget.

getHorizontalMaxScroll()

int gcn::ScrollArea::getHorizontalMaxScroll ( )

virtual

Gets the maximum amount of horizontal scroll.

Returns

the horizontal max scroll.

getHorizontalScrollAmount()

int gcn::ScrollArea::getHorizontalScrollAmount ( )

virtual

Gets the amount that is scrolled horizontaly.

Returns

the scroll amount on horizontal scroll.

getHorizontalScrollPolicy()

unsigned int gcn::ScrollArea::getHorizontalScrollPolicy ( )

virtual

Gets the horizontal scrollbar policy. See enum with policies.

Returns

the policy for the horizontal scrollbar policy. See enum with policies.

getLeftButtonDimension()

Rectangle gcn::ScrollArea::getLeftButtonDimension ( )

protectedvirtual

Gets the left button dimension.

Returns

the dimension of the left button.

getRightButtonDimension()

Rectangle gcn::ScrollArea::getRightButtonDimension ( )

protectedvirtual

Gets the right button dimension.

Returns

the dimension of the right button.

getScrollbarWidth()

int gcn::ScrollArea::getScrollbarWidth ( )

virtual

Gets the width.

Returns

the width of the ScrollBar.

getUpButtonDimension()

Rectangle gcn::ScrollArea::getUpButtonDimension ( )

protectedvirtual

Gets the up button dimension.

Returns

the dimension of the up button.

getVerticalBarDimension()

Rectangle gcn::ScrollArea::getVerticalBarDimension ( )

protectedvirtual

Gets the vertical scrollbar dimension.

Returns

the dimension of the vertical scrollbar.

getVerticalMarkerDimension()

Rectangle gcn::ScrollArea::getVerticalMarkerDimension ( )

protectedvirtual

Gets the vertical marker dimension.

Returns

the dimension of the vertical marker.

Reimplemented in ImageListBoxWidget.

getVerticalMaxScroll()

int gcn::ScrollArea::getVerticalMaxScroll ( )

virtual

Gets the maximum amount of vertical scroll.

Returns

the vertical max scroll.

getVerticalScrollAmount()

int gcn::ScrollArea::getVerticalScrollAmount ( )

virtual

Gets the amount that is scrolled verticaly.

Returns

the scroll amount on vertical scroll.

getVerticalScrollPolicy()

unsigned int gcn::ScrollArea::getVerticalScrollPolicy ( )

virtual

Gets the vertical scrollbar policy. See enum with policies.

Returns

the policy for the vertical scrollbar. See enum with policies.

logic()

void gcn::ScrollArea::logic ( )

virtual

Called for all Widgets in the gui each time Gui::logic is called. You can do logic stuff here like playing an animation.

See also

Gui

Reimplemented from gcn::Widget.

mouseMotion()

void gcn::ScrollArea::mouseMotion ( int  , int    )

virtual

Called when the mouse moves and the mouse is in the Widget area or if the Widget has focus.

Parameters

x	the x coordinate of the mouse relative to the Widget itself.
y	the y coordinate of the mouse relative to the Widget itself.

Reimplemented from gcn::MouseListener.

mousePress()

void gcn::ScrollArea::mousePress ( int  , int  , int    )

virtual

Called when a mouse button is pressed when the mouse is in the Widget area or if the Widget has focus.

NOTE: A mouse press is NOT equal to a mouse click. Use mouseClickMessage to check for mouse clicks.

Parameters

x	the x coordinate of the mouse relative to the Widget itself.
y	the y coordinate of the mouse relative to the Widget itself.
button	the button pressed.

Reimplemented from gcn::MouseListener.

mouseRelease()

void gcn::ScrollArea::mouseRelease ( int  , int  , int    )

virtual

Called when a mouse button is released when the mouse is in the Widget area or if the Widget has focus.

Parameters

x	the x coordinate of the mouse relative to the Widget itself.
y	the y coordinate of the mouse relative to the Widget itself.
button	the button released.

Reimplemented from gcn::MouseListener.

mouseWheelDown()

void gcn::ScrollArea::mouseWheelDown ( int  , int    )

virtual

Called on a mouse wheel down when the mouse is in the Widget area or if the Widget has focus.

Parameters

x	the x coordinate of the mouse relative to the Widget itself.
y	the y coordinate of the mouse relative to the Widget itself.

Reimplemented from gcn::MouseListener.

mouseWheelUp()

void gcn::ScrollArea::mouseWheelUp ( int  , int    )

virtual

Called on a mouse wheel up when the mouse is in the Widget area or if the Widget has focus.

Parameters

x	the x coordinate of the mouse relative to the Widget itself.
y	the y coordinate of the mouse relative to the Widget itself.

Reimplemented from gcn::MouseListener.

moveToBottom()

void gcn::ScrollArea::moveToBottom ( Widget *  widget )

virtual

Moves a widget to the bottom of the BasicContainer. The Widget will be drawn below all other Widgets in the BasicContainer.

Parameters

widget

the Widget to move.

Implements gcn::BasicContainer.

moveToTop()

void gcn::ScrollArea::moveToTop ( Widget *  widget )

virtual

Moves a Widget to the top of the BasicContainer. The widget will be drawn above all other Widgets in the BasicContainer.

Parameters

widget

the Widget to move.

Implements gcn::BasicContainer.

scrollToBottom()

void gcn::ScrollArea::scrollToBottom ( )

virtual

scrollToRectangle()

void gcn::ScrollArea::scrollToRectangle ( const Rectangle &  rectangle )

virtual

Tries to scroll to a specific rectangle. If the rectangle is to large to be visible as much as possibly, begining in the rectangles upper corner, will be visible.

Parameters

rectangle

the Rectangle to scroll to.

scrollToTop()

void gcn::ScrollArea::scrollToTop ( )

virtual

setContent()

void gcn::ScrollArea::setContent ( Widget *  widget )

virtual

Sets the content.

Parameters

widget

the content of the ScrollArea.

setHorizontalScrollAmount()

void gcn::ScrollArea::setHorizontalScrollAmount ( int  hScroll )

virtual

Sets the amount to scroll horizontaly.

Parameters

hScroll

the amount to scroll.

setHorizontalScrollPolicy()

void gcn::ScrollArea::setHorizontalScrollPolicy ( unsigned int  hPolicy )

virtual

Sets the horizontal scrollbar policy. See enum with policies.

Parameters

hPolicy

the policy for the horizontal scrollbar. See enum with policies.

setScrollAmount()

void gcn::ScrollArea::setScrollAmount ( int  hScroll, int  vScroll  )

virtual

Sets the amount to scroll horizontaly and verticaly.

Parameters

hScroll	the amount to scroll on horizontal scroll.
vScroll	the amount to scroll on vertical scroll.

setScrollbarWidth()

void gcn::ScrollArea::setScrollbarWidth ( int  width )

virtual

Sets the width.

Parameters

width

the width of the ScrollBar.

setScrollPolicy()

void gcn::ScrollArea::setScrollPolicy ( unsigned int  hPolicy, unsigned int  vPolicy  )

virtual

Sets the horizontal and vertical scrollbar policy. See enum with policies.

Parameters

hPolicy	the policy for the horizontal scrollbar. See enum with policies.
vPolicy	the policy for the vertical scrollbar. See enum with policies.

setVerticalScrollAmount()

void gcn::ScrollArea::setVerticalScrollAmount ( int  vScroll )

virtual

Sets the amount to scroll verticaly.

Parameters

vScroll

the amount to scroll.

setVerticalScrollPolicy()

void gcn::ScrollArea::setVerticalScrollPolicy ( unsigned int  vPolicy )

virtual

Sets the vertical scrollbar policy. See enum with policies.

Parameters

vPolicy

the policy for the vertical scrollbar. See enum with policies.

Member Data Documentation

mContent

Widget* gcn::ScrollArea::mContent

protected

mDownButtonPressed

bool gcn::ScrollArea::mDownButtonPressed

protected

mHBarVisible

bool gcn::ScrollArea::mHBarVisible

protected

mHorizontalMarkerMousePosition

int gcn::ScrollArea::mHorizontalMarkerMousePosition

protected

mHorizontalMarkerPressed

bool gcn::ScrollArea::mHorizontalMarkerPressed

protected

mHPolicy

unsigned int gcn::ScrollArea::mHPolicy

protected

mHScroll

int gcn::ScrollArea::mHScroll

protected

mLeftButtonPressed

bool gcn::ScrollArea::mLeftButtonPressed

protected

mRightButtonPressed

bool gcn::ScrollArea::mRightButtonPressed

protected

mScrollbarWidth

int gcn::ScrollArea::mScrollbarWidth

protected

mUpButtonPressed

bool gcn::ScrollArea::mUpButtonPressed

protected

mVBarVisible

bool gcn::ScrollArea::mVBarVisible

protected

mVerticalMarkerMousePosition

int gcn::ScrollArea::mVerticalMarkerMousePosition

protected

mVerticalMarkerPressed

bool gcn::ScrollArea::mVerticalMarkerPressed

protected

mVPolicy

unsigned int gcn::ScrollArea::mVPolicy

protected

mVScroll

int gcn::ScrollArea::mVScroll

protected

---

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

• src/guichan/include/guichan/widgets/scrollarea.h
• src/guichan/widgets/scrollarea.cpp