Inheritance diagram for os::ScrollBar:

Classes
class	Private
	internal More...

Public Member Functions
	ScrollBar (const Rect &cFrame, const String &cName, Message *pcMsg, float vMin=0, float vMax=FLT_MAX, int nOrientation=VERTICAL, uint32 nResizeMask=0)
	libSyllable os::ScrollBar More...

	~ScrollBar ()
	libSyllable os::ScrollBar More...

void	SetScrollTarget (View *pcTarget)
	Sets the target that the ScrollBar sends messages to. More...

View *	GetScrollTarget (void)
	Gets the target that the ScrollBar sends messages to. More...

virtual void	PostValueChange (const Variant &cNewValue)

virtual void	LabelChanged (const String &cNewLabel)

virtual void	EnableStatusChanged (bool bIsEnabled)

virtual bool	Invoked (Message *pcMessage)
	Intercept outgoing messages. More...

virtual void	FrameSized (const Point &cDelta)
	Virtual hook called by the system when the view is resized. More...

virtual void	MouseMove (const Point &cNewPos, int nCode, uint32 nButtons, Message *pcData)
	Hook called by the system when the mouse is moved. More...

virtual void	MouseDown (const Point &cPosition, uint32 nButtons)
	Hook called by the system when a mouse button is pressed. More...

virtual void	MouseUp (const Point &cPosition, uint32 nButtons, Message *pcData)
	Hook called by the system when a mouse button is release. More...

virtual void	KeyDown (const char pzString, const char pzRawString, uint32 nQualifiers)
	Hook called by the system when a key is pressed while the view has focus. More...

virtual void	WheelMoved (const Point &cDelta)
	Hook called by the system when the scroll-wheel is rotated. More...

virtual void	Activated (bool bIsActive)
	Hook called when the view gain or loose focus. More...

virtual void	Paint (const Rect &cUpdateRect)
	Called by the system update "damaged" areas of the view. More...

virtual Point	GetPreferredSize (bool bLargest) const

virtual void	TimerTick (int nID)
	Timer dispatch member. More...

void	SetSteps (float vSmall, float vBig)
	Sets the steps... More...

void	GetSteps (float pvSmall, float pvBig) const
	Gets the steps... More...

void	SetMinMax (float vMin, float vMax)
	Sets the minimum/maximum step... More...

void	SetProportion (float vProp)
	Sets the propotion... More...

float	GetProportion () const
	Gets the propotion... More...

Public Member Functions inherited from os::Control
	Control (const Rect &cFrame, const String &cName, const String &cLabel, Message *pcMessage, uint32 nResizeMask, uint32 nFlags=WID_WILL_DRAW\|WID_CLEAR_BACKGROUND)

	~Control ()

virtual void	AttachedToWindow (void)

virtual void	DetachedFromWindow (void)

virtual bool	PreValueChange (Variant *pcNewValue)

virtual void	SetEnable (bool bEnabled)

virtual bool	IsEnabled (void) const

virtual void	SetLabel (const String &cLabel)

virtual String	GetLabel (void) const

virtual void	SetValue (Variant cValue, bool bInvoke=true)

virtual Variant	GetValue () const

virtual void	__CTRL_reserved1__ ()

virtual void	__CTRL_reserved2__ ()

virtual void	__CTRL_reserved3__ ()

virtual void	__CTRL_reserved4__ ()

virtual void	__CTRL_reserved5__ ()

Public Member Functions inherited from os::View
	View (const Rect &cFrame, const String &cTitle, uint32 nResizeMask=CF_FOLLOW_LEFT\|CF_FOLLOW_TOP, uint32 nFlags=WID_WILL_DRAW\|WID_CLEAR_BACKGROUND)
	View constructor. More...

virtual	~View ()
	View destructor. More...

virtual void	AllAttached ()

virtual void	AllDetached ()

virtual void	WindowActivated (bool bIsActive)
	Hook called when the window hosting this view gain or loose focus. More...

virtual void	KeyUp (const char pzString, const char pzRawString, uint32 nQualifiers)
	Hook called by the system when a key is released while the view has focus. More...

virtual void	FrameMoved (const Point &cDelta)
	Virtual hook called by the system when the view is moved within it's parent. More...

virtual void	ViewScrolled (const Point &cDelta)
	Virtual hook called by the system when the view content is scrolled. More...

virtual void	FontChanged (Font *pcNewFont)
	Called to notify the view that the font has changed. More...

virtual Point	GetContentSize () const

virtual void	AddChild (View *pcView, bool bAssignTabOrder=false)

void	RemoveChild (View *pcChild)

void	RemoveThis ()

View *	GetChildAt (const Point &cPos) const

View *	GetChildAt (int nIndex) const

View *	GetParent () const

ScrollBar *	GetVScrollBar () const

ScrollBar *	GetHScrollBar () const

Window *	GetWindow () const

String	GetTitle () const

virtual int	GetTabOrder () const
	Get the keybord manouvering order. More...

virtual void	SetTabOrder (int nOrder=NEXT_TAB_ORDER)
	Set the keyboard manouvering sorting order. More...

virtual const ShortcutKey &	GetShortcut () const

virtual void	SetShortcut (const ShortcutKey &cShortcut)
	Set keyboard shortcut. More...

virtual void	SetShortcutFromLabel (const String &cLabel)
	Set keyboard shortcut from Label. More...

void	SetContextMenu (Menu *pcMenu)
	Set popup menu for a View. More...

Menu *	GetContextMenu () const
	Get popup menu. More...

uint32	GetQualifiers () const

void	GetMouse (Point pcPosition, uint32 pnButtons) const

void	SetMousePos (const Point &cPosition)

void	BeginDrag (Message pcData, const Point &cOffset, const Bitmap pcBitmap, Handler *pcReplyTarget=NULL)
	Start a drag and drop operation. More...

void	BeginDrag (Message pcData, const Point &cOffset, const Rect &cBounds, Handler pcReplyTarget=NULL)
	Start a drag and drop operation. More...

void	SetFlags (uint32 nFlags)

uint32	GetFlags (uint32 nMask=~0L) const

void	SetResizeMask (uint32 nFlags)

uint32	GetResizeMask () const

void	Show (bool bVisible=true)
	Show/hide a view and all it's children. More...

void	Hide ()

bool	IsVisible () const

virtual void	MakeFocus (bool bFocus=true)

virtual bool	HasFocus () const

Rect	GetFrame () const

Rect	GetBounds () const

Rect	GetNormalizedBounds () const

float	Width () const

float	Height () const

Point	GetLeftTop () const

virtual void	SetFrame (const Rect &cRect, bool bNotifyServer=true)
	Set the size and position relative to the parent view. More...

virtual void	MoveBy (const Point &cDelta)
	Move the view within the parent coordinate system. More...

virtual void	MoveBy (float vDeltaX, float vDeltaY)

virtual void	MoveTo (const Point &cPos)
	Set the views position within the parent coordinate system. More...

virtual void	MoveTo (float x, float y)

virtual void	ResizeBy (const Point &cDelta)

virtual void	ResizeBy (float vDeltaW, float vDeltaH)

virtual void	ResizeTo (const Point &cSize)
	Set a new absolute size for the view. More...

virtual void	ResizeTo (float W, float H)
	Set a new absolute size for the view. More...

void	SetDrawingRegion (const Region &cReg)
	Restrict rendering using a clipping region. More...

void	ClearDrawingRegion ()
	Remove any previously assigned drawing region. More...

void	SetShapeRegion (const Region &cReg)
	Define a non-square shape for the view. More...

void	ClearShapeRegion ()
	Remove any previously assigned shape region. More...

virtual int	ToggleDepth ()

Point	ConvertFromParent (const Point &cPoint) const

void	ConvertFromParent (Point *cPoint) const

Rect	ConvertFromParent (const Rect &cRect) const

void	ConvertFromParent (Rect *cRect) const

Point	ConvertToWindow (const Point &cPoint) const

void	ConvertToWindow (Point *cPoint) const

Rect	ConvertToWindow (const Rect &cRect) const

void	ConvertToWindow (Rect *cRect) const

Point	ConvertFromWindow (const Point &cPoint) const

void	ConvertFromWindow (Point *cPoint) const

Rect	ConvertFromWindow (const Rect &cRect) const

void	ConvertFromWindow (Rect *cRect) const

Point	ConvertToScreen (const Point &cPoint) const

void	ConvertToScreen (Point *cPoint) const

Rect	ConvertToScreen (const Rect &cRect) const

void	ConvertToScreen (Rect *cRect) const

Point	ConvertFromScreen (const Point &cPoint) const

void	ConvertFromScreen (Point *cPoint) const

Rect	ConvertFromScreen (const Rect &cRect) const

void	ConvertFromScreen (Rect *cRect) const

void	Invalidate (const Rect &cRect, bool bRecurse=false)
	Add a rectangle to the damage list. More...

void	Invalidate (bool bRecurse=false)
	Invalidate the whole view. More...

void	Flush ()
	Flush the render queue. More...

void	Sync ()
	Flush the render queue. More...

void	SetDrawingMode (drawing_mode nMode)

drawing_mode	GetDrawingMode () const

void	SetFont (Font *pcFont)
	Change the views text font. More...

Font *	GetFont () const

void	SetFgColor (int nRed, int nGreen, int nBlue, int nAlpha=255)

void	SetFgColor (Color32_s sColor)

Color32_s	GetFgColor () const

void	SetBgColor (int nRed, int nGreen, int nBlue, int nAlpha=255)

void	SetBgColor (Color32_s sColor)

Color32_s	GetBgColor () const

void	SetEraseColor (int nRed, int nGreen, int nBlue, int nAlpha=255)

void	SetEraseColor (Color32_s sColor)

Color32_s	GetEraseColor () const

void	MovePenTo (const Point &cPos)

void	MovePenTo (float x, float y)

void	MovePenBy (const Point &cPos)

void	MovePenBy (float x, float y)

Point	GetPenPosition () const
	Get the current pen position. More...

void	DrawLine (const Point &cToPoint)

void	DrawLine (const Point &cFromPnt, const Point &cToPnt)

virtual void	ScrollBy (const Point &cDelta)

virtual void	ScrollBy (float vDeltaX, float vDeltaY)

virtual void	ScrollTo (Point cTopLeft)

virtual void	ScrollTo (float x, float y)

Point	GetScrollOffset () const

void	ScrollRect (const Rect &cSrcRect, const Rect &cDstRect)
	Copy a rectangle from one location to another within the view. More...

void	FillRect (const Rect &cRect)

void	FillRect (const Rect &cRect, Color32_s sColor)

void	DrawBitmap (const Bitmap *pcBitmap, const Rect &cSrcRect, const Rect &cDstRect)
	Render a bitmap into the view. More...

void	EraseRect (const Rect &cRect)

void	DrawFrame (const Rect &cRect, uint32 nFlags)

void	DrawRoundedFrame (const os::Rect &cReizeFrame=os::Rect(1, 4,-1,-4), const os::Color32_s &cColor=get_default_color(COL_SHADOW))

void	DrawRoundedFrame (const os::Rect &cFrame, const os::Rect &cReizeFrame=os::Rect(1, 4,-1,-4), const os::Color32_s &cColor=get_default_color(COL_SHADOW))

void	DrawString (const Point &cPos, const String &cString)

void	DrawString (const String &cString)
	Render a text-string at the current pen position. More...

void	DrawString (const char *pzStr, int Len=-1)

void	DrawText (const Rect &cPos, const String &cString, uint32 nFlags=0)
	Render a text-string in a specified rectangle. More...

void	DrawSelectedText (const Rect &cPos, const String &cString, const IPoint &cSel1, const IPoint &cSel2, uint32 nMode=SEL_CHAR, uint32 nFlags=0)

void	GetSelection (const String &cClipboard="__system_clipboard__")

void	GetTruncatedStrings (const char pazStringArray, int nStringCount, uint32 nMode, float nWidth, char pazResultArray) const

float	GetStringWidth (const String &cString) const

float	GetStringWidth (const char *pzString, int nLen=-1) const

void	GetStringWidths (const char *apzStringArray, const int anLengthArray, int nStringCount, float *avWidthArray) const

Point	GetTextExtent (const String &cString, uint32 nFlags=0, int nTargetWidth=-1) const

int	GetStringLength (const String &cString, float vWidth, bool bIncludeLast=false) const

int	GetStringLength (const char *pzString, int nLen, float vWidth, bool bIncludeLast=false) const

void	GetStringLengths (const char *apzStringArray, const int anLengthArray, int nStringCount, float vWidth, int *anMaxLengthArray, bool bIncludeLast=false) const

void	GetFontHeight (font_height *psHeight) const

void	Ping (int nSize=0) const

void	SetToolTip (const os::String &t)

os::String	GetToolTip () const

Point	ConvertToParent (const Point &cPoint) const
	Translate a os::Point into our parents coordinate system. More...

void	ConvertToParent (Point *cPoint) const
	Translate a os::Point into our parents coordinate system. More...

Rect	ConvertToParent (const Rect &cRect) const

void	ConvertToParent (Rect *cRect) const

Public Member Functions inherited from os::Handler
	Handler (const String &cName)
	Construct a handler. More...

virtual	~Handler ()
	Destructor. More...

virtual void	HandleMessage (Message *pcMessage)
	Handle a message targeted at this handler. More...

String	GetName () const
	Get the handlers name. More...

void	SetName (const String &cName)
	Rename the handler. More...

Looper *	GetLooper () const
	Get a pointer to the looper this handler belongs to. More...

void	SetNextHandler (Handler *pcNextHandler)
	Set a handler that should handle messages this handler is not interrested in. More...

Handler *	GetNextHandler () const
	Get the next handler in a handler chain. More...

void	AddFilter (MessageFilter *pcFilter)

void	RemoveFilter (MessageFilter *pcFilter)

const MsgFilterList &	GetFilterList () const

const uint32	GetToken ()
	Get the handlers token. More...

Public Member Functions inherited from os::Invoker
	Invoker ()
	Default constructor. More...

	Invoker (Message *pcMessage)
	Constructor. More...

	Invoker (Message pcMessage, const Handler pcHandler, const Looper *pcLooper=NULL)
	Constructor. More...

	Invoker (Message *pcMessage, const Messenger &cTarget)
	Constructor. More...

virtual	~Invoker ()
	Destructor. More...

virtual status_t	SetMessage (Message *pcMessage)
	Assign a new message to the invoker. More...

Message *	GetMessage () const
	Get the message currently assigned to the invoker. More...

uint32	GetCode () const
	Get the code field from the currently assigned message. More...

virtual void	TargetChanged (const Messenger &cOldTarget)
	Virtual hook called by the system after the target has been changed. More...

virtual void	MessageChanged (const Message &cOldMsg)
	Virtual hook called by the system after the message has been changed. More...

virtual status_t	SetTarget (const Handler pcHandler, const Looper pcLooper=NULL)
	Set a new message target. More...

virtual status_t	SetTarget (const Messenger &cMessenger)
	Set a new message target. More...

bool	IsTargetLocal () const
	Check if the target lives in our process. More...

Handler *	GetTarget (Looper **ppcLooper=NULL) const
	Get the current target. More...

Messenger	GetMessenger () const
	Get the messenger used to target messages sendt by the invoker. More...

virtual status_t	SetHandlerForReply (Handler *pcHandler)
	Set a reply target for messages sendt by this messenger. More...

Handler *	GetHandlerForReply () const
	Get the current reply target for replies on messages sendt by the invoker. More...

virtual status_t	Invoke (Message *pcMessage=NULL)
	Send the current message to the current target. More...

Detailed Description

Description:: The os::ScrollBar is one object that is used in a lot of other GUI elements. It adds scrolling to an element.

See Also

Author: Kurt Skauen (kurt@.nosp@m.athe.nosp@m.os.cx)

Constructor & Destructor Documentation

ScrollBar::ScrollBar	(	const Rect &	cFrame,
		const String &	cName,
		Message *	pcMsg,
		float	vMin = `0`,
		float	vMax = `FLT_MAX`,
		int	nOrientation = `VERTICAL`,
		uint32	nResizeMask = `0`
	)

Description:: ScrollBar constructor.

Parameters

cFrame	- The size and position of the ScrollBar
cName	- The name of the ScrollBar.
pcMsg	- The message for the ScrollBar. Used to pass messages to your element
vMin	- The minimum tick for the ScrollBar
vMax	- The maximum tick for the ScrollBar
nOrientation	- The position of the ScrollBar(use os::VERTICAL or os::HORIZONTAL)
nResizeMask	- Determines what way the ScrollBar will follow the rest of the window. Default is CF_FOLLOW_LEFT\|CF_FOLLOW_TOP.

Author: Kurt Skauen with modifications by Rick Caudill(rick@.nosp@m.syll.nosp@m.able..nosp@m.org)

References FrameSized(), os::ScrollBar::Private::m_nOrientation, os::ScrollBar::Private::m_vMax, and os::ScrollBar::Private::m_vMin.

ScrollBar::~ScrollBar ( )

Description:: The destructor for the ScrollBar. Just sets the target's scrollbar property to NULL

Author: Kurt Skauen with modifications by Rick Caudill(rick@.nosp@m.syll.nosp@m.able..nosp@m.org)

References HORIZONTAL, os::ScrollBar::Private::m_nOrientation, and os::ScrollBar::Private::m_pcTarget.

Member Function Documentation

void ScrollBar::Activated ( bool bIsActive )

virtual

Description:: This is a callback member that can be overloaded by derived classes to learn when the view is activated and when it is deactivated. The bIsActive parameter tell whether the focus was lost or gained.

: The view has focus when it is the active view in the active window.

Note:: This is a hook function that is called by the system to notify about an event. You should never call this member yourself.

The window is locked when this member is called.

Parameters

bIsActive - true if the view gain and false if it loose focus.

See Also: MakeFocus(), WindowActivated()

Author: Kurt Skauen (kurt@.nosp@m.athe.nosp@m.os.cx)

Reimplemented from os::View.

References os::View::Flush(), and os::View::Invalidate().

void ScrollBar::EnableStatusChanged ( bool bIsEnabled )

virtual

Implements os::Control.

References os::View::Flush(), and os::View::Invalidate().

void ScrollBar::FrameSized ( const Point & cDelta )

virtual

Description:: Overload this member if you need to know when the view is resized.

Note:: This member is called after the view is resized. If you need the old size you can subtract the cDelta calue from the current size.

Parameters

cDelta The distance the bottom/right corner was moved relative to the upper/left corner.

See Also: FrameMoved(), SetFrame, ResizeBy(), ResizeTo()

Author: Kurt Skauen (kurt@.nosp@m.athe.nosp@m.os.cx)

Reimplemented from os::View.

References os::Rect::bottom, os::View::GetBounds(), os::Rect::Height(), HORIZONTAL, os::Rect::left, os::ScrollBar::Private::m_acArrowRects, os::ScrollBar::Private::m_cKnobArea, os::ScrollBar::Private::m_nOrientation, os::Rect::right, os::Rect::top, and os::Rect::Width().

Referenced by ScrollBar().

Point ScrollBar::GetPreferredSize ( bool bLargest ) const

virtual

Reimplemented from os::View.

References HORIZONTAL, and os::ScrollBar::Private::m_nOrientation.

Referenced by os::IconView::IconView().

float ScrollBar::GetProportion ( ) const

Description:: Gets the proportion on how the Scrollbar moves

Author: Kurt Skauen

References os::ScrollBar::Private::m_vProportion.

View * ScrollBar::GetScrollTarget ( void )

Description:: Gets the target that the ScrollBar sends messages to.

Author: Kurt Skauen

References os::ScrollBar::Private::m_pcTarget.

void ScrollBar::GetSteps	(	float *	pvSmall,
		float *	pvBig
	)		const

Description:: Gets the steps on how much/little the Scrollbar moves

Parameters

pvSmall	- pointer to the smallest step
pvBig	- pointer to the bigest step

Author: Kurt Skauen

References os::ScrollBar::Private::m_vBigStep, and os::ScrollBar::Private::m_vSmallStep.

bool ScrollBar::Invoked ( Message * pcMessage )

virtual

Description:: This member is called from Invoke() just before a message is sendt to the target.

: This allow classes that inherits from os::Invoker to add data to or otherwhice modify the message before it is sendt. The message can also be canceled entirely by returning false from this member.

: The message passed to Invoked() is a copy of the internal message or the message passed to Invoke() (if any) so any changes made here will not affect the internal message or the message passed to Invoke(). When this method returns the message will imidiatly be sendt to the target and then discarded (unless false is returned in which case the message is simply discarded).

: The default implementation of this member does nothing and return true.

Parameters

pcMessage Pointer to the message that is about to be sendt. You can do any modification you like to this message (but never delete it).

Returns: Normally you should return true to indicate that the message should be sendt. You can however return false if you for some reason want to cancel the invokation.

See Also: Invoke(), SetMessage(), SetTarget()

Author: Kurt Skauen (kurt@.nosp@m.athe.nosp@m.os.cx)

Reimplemented from os::Control.

References os::Message::AddBool(), HIT_KNOB, os::Control::Invoked(), and os::ScrollBar::Private::m_nHitState.

void ScrollBar::KeyDown	(	const char *	pzString,
		const char *	pzRawString,
		uint32	nQualifiers
	)

virtual

Description:: Overload this member if your view need to handle keyboard input. This member is called to allow the view to handle M_KEY_DOWN messages. The most common members are exctracted from the message and passed as parameters but you might need to obtain the raw message with os::Looper::GetCurrentMessage() and find some members yourself if you the data you needed are not passed in.

: For example if you need the raw key-code for the pressed key you will have to lookup the "_raw_key" member from the message.

Parameters

pzString	String containing a single UTF-8 encoded character. This is the character generated by the pressed key according to the current keymap accounting for any qualifiers that might be pressed.
pzRawString	Same as `pzString` except that the key is converted without accounting for qualifiers. Ie. if 'A' is pressed while pressing <SHIFT> pzString will contain 'A' and pzRawString will contain 'a'.
nQualifiers	Bitmask describing which qualifiers that was active when the key was pressed.

See Also: KeyUp(), os::Looper::GetCurrentMessage()

Author: Kurt Skauen (kurt@.nosp@m.athe.nosp@m.os.cx)

Reimplemented from os::View.

References os::View::GetShortcut(), os::Control::GetValue(), os::Control::IsEnabled(), os::View::KeyDown(), os::ScrollBar::Private::m_vMax, os::ScrollBar::Private::m_vMin, os::ScrollBar::Private::m_vSmallStep, os::View::MakeFocus(), and os::Control::SetValue().

void ScrollBar::LabelChanged ( const String & cNewLabel )

virtual

Reimplemented from os::Control.

void ScrollBar::MouseDown	(	const Point &	cPosition,
		uint32	nButtons
	)

virtual

Description:: This member is called from the window thread whenever a mouse button is clicked above the view. You can overload this member if your view need to know about mouse-down events.

: A view will not automatically take focus when clicked so if you want that behaviour you must call MakeFocus() from an overloaded version of this member.

: The default implementation of this member will call MouseDown() on it's parent view if one exists.

Parameters

cPosition	Mouse position in the views coordinate system at the time the mouse was pressed.
nButtons	Index of the pressed button. Buttons start at 1 for the left button, 2 for the right button, 3 for the middle button. Additional buttons might be supported by the mouse driver and will then be assigned numbers from 4 and up.

See Also: MouseUp(), MouseMove(), WheelMoved()

Author: Kurt Skauen (kurt@.nosp@m.athe.nosp@m.os.cx)

Reimplemented from os::View.

void ScrollBar::MouseMove	(	const Point &	cNewPos,
		int	nCode,
		uint32	nButtons,
		Message *	pcData
	)

virtual

Description:: This member is called from the window thread whenever the mouse is moved above the view or if the view has focus.

: Oveload this member if your view need to handle mouse-move events.

: The default implementation of this member will call MouseMove() on it's parent view if one exists.

Parameters

cNewPos	New mouse position given in the views coordinate system.
nCode	Enter/exit code. This is MOUSE_ENTERED when the mouse first enter the view, MOUSE_EXITED when the mouse leaves the view, MOUSE_INSIDE whenever the mouse move withing the boundary of the view and MOUSE_OUTSIDE when the mouse move outside the view (will only happen if the view has focus).
nButtons	Bitmask telling which buttons that are currently pressed. Bit 0 is button 1 (left), bit 1 is button 2 (right), and bit 2 is button 3 (middle), and so on.
pcData	Pointer to a Message object containing the dragged data if the user is in the middle of a drag and drop operation. Otherwise this pointer is NULL. Look at BeginDrag() for a more detailed description of the drag and drop system.

See Also: MouseDown(), MouseUp(), WheelMoved(), BeginDrag()

Author: Kurt Skauen (kurt@.nosp@m.athe.nosp@m.os.cx)

Reimplemented from os::View.

References os::Looper::AddTimer(), os::Rect::DoIntersect(), os::View::Flush(), os::Handler::GetLooper(), HIT_ARROW, HIT_KNOB, ID_SCROLL_TIMER, os::View::Invalidate(), os::Control::IsEnabled(), os::ScrollBar::Private::m_abArrowStates, os::ScrollBar::Private::m_acArrowRects, os::ScrollBar::Private::m_bFirstTick, os::ScrollBar::Private::m_nHitButton, os::ScrollBar::Private::m_nHitState, os::View::MouseMove(), os::Looper::RemoveTimer(), and os::Control::SetValue().

void ScrollBar::MouseUp	(	const Point &	cPosition,
		uint32	nButtons,
		Message *	pcData
	)

virtual

Description:: This member is called from the window thread whenever a mouse button is released above the view. You can overload this member if your view need to know about mouse-up events or if your view support drag and drop.

: If mouse-up was the result of ending a drag and drop operation the pcData member will point to a Message containing the dragged data. Look at BeginDrag() for a more detailed description of the drag and drop system.

: The default implementation of this member will call MouseDown() on it's parent view if one exists.

Parameters

cPosition	Mouse position in the views coordinate system at the time the mouse was pressed.
nButtons	Index of the pressed button. Buttons start at 1 for the left button, 2 for the right button, 3 for the middle button. Additional buttons might be supported by the mouse driver and will then be assigned numbers from 4 and up.
pcData	Pointer to a Message object containing the dragged data if this mouse-up was the end of a drag and drop operation. If no data was dragged it will be NULL.

See Also: MouseDown(), MouseMove(), WheelMoved()

Author: Kurt Skauen (kurt@.nosp@m.athe.nosp@m.os.cx)

Reimplemented from os::View.

void ScrollBar::Paint ( const Rect & cUpdateRect )

virtual

Description:

Note:

Warning:

Parameters

cUpdateRect A rectangle enclosing all damaged areas. This is just a rough "worst-case", further fine-grained clipping will be performed by the Application Server to avoid updating non-damaged pixels and make the update as fast and flicker-free as possible.

See Also: Invalidate(), Flush()

Author: Kurt Skauen (kurt@.nosp@m.athe.nosp@m.os.cx)

Reimplemented from os::View.

References os::BMID_ARROW_DOWN, os::BMID_ARROW_LEFT, os::BMID_ARROW_RIGHT, os::BMID_ARROW_UP, os::Rect::bottom, os::Rect::Bounds(), os::COL_FOCUS, os::COL_NORMAL, os::COL_SCROLLBAR_BG, os::COL_SCROLLBAR_KNOB, os::COL_SHADOW, os::COL_SHINE, DM_COPY, DM_OVER, os::View::DrawBitmap(), os::View::DrawFrame(), os::View::DrawLine(), os::View::FillRect(), os::FRAME_RAISED, os::FRAME_RECESSED, os::FRAME_THIN, os::get_default_color(), os::get_std_bitmap(), os::View::GetBounds(), os::View::HasFocus(), os::Rect::Height(), HORIZONTAL, os::Control::IsEnabled(), os::Rect::IsValid(), os::Rect::left, os::Rect::LeftTop(), os::ScrollBar::Private::m_abArrowStates, os::ScrollBar::Private::m_acArrowRects, os::ScrollBar::Private::m_cKnobArea, os::ScrollBar::Private::m_nOrientation, os::Rect::Resize(), os::Rect::right, os::View::SetDrawingMode(), os::View::SetEraseColor(), os::View::SetFgColor(), os::Rect::top, and os::Rect::Width().

void ScrollBar::PostValueChange ( const Variant & cNewValue )

virtual

Reimplemented from os::Control.

References os::Variant::AsFloat(), os::View::Flush(), os::View::GetScrollOffset(), HORIZONTAL, os::View::Invalidate(), os::ScrollBar::Private::m_cKnobArea, os::ScrollBar::Private::m_nOrientation, os::ScrollBar::Private::m_pcTarget, os::View::ScrollTo(), os::Point::x, and os::Point::y.

void ScrollBar::SetMinMax	(	float	vMin,
		float	vMax
	)

Description:: Sets the minimum and the maximum step that can be done in one click

Parameters

vMin	- the minimum step
vMax	- the maximum step

Author: Kurt Skauen

References os::ScrollBar::Private::m_vMax, and os::ScrollBar::Private::m_vMin.

Referenced by os::IconView::Private::LayoutIcons(), and os::IconView::Private::LayoutIconsIfNecessary().

void ScrollBar::SetProportion ( float vProp )

Description:: Sets the proportion on how the Scrollbar moves

Parameters

vProp - the new proportion

Author: Kurt Skauen

References os::View::Flush(), os::View::Invalidate(), os::ScrollBar::Private::m_cKnobArea, and os::ScrollBar::Private::m_vProportion.

Referenced by os::IconView::Private::LayoutIcons(), and os::IconView::Private::LayoutIconsIfNecessary().

void ScrollBar::SetScrollTarget ( View * pcTarget )

Description:: Sets the target that the ScrollBar sends messages to.

Parameters

pcTarget - the target os::View

Author: Kurt Skauen

References os::View::GetHScrollBar(), os::View::GetScrollOffset(), os::View::GetVScrollBar(), HORIZONTAL, os::ScrollBar::Private::m_nOrientation, os::ScrollBar::Private::m_pcTarget, os::Control::SetValue(), os::Point::x, and os::Point::y.

Referenced by os::IconView::IconView(), and os::View::~View().

void ScrollBar::SetSteps	(	float	vSmall,
		float	vBig
	)

Description:: Sets the steps on how much/little the Scrollbar moves

Parameters

vSmall	- the new smallest step
vBig	- the new largest step

Author: Kurt Skauen

References os::ScrollBar::Private::m_vBigStep, and os::ScrollBar::Private::m_vSmallStep.

Referenced by os::IconView::IconView().

void ScrollBar::TimerTick ( int nID )

virtual

Description:: This member will be called by the looper thread when a timer targeting this handler expires.

: When a timer created with os::Looper::AddTimer() expires the looper thread will lock the looper and call this member on the target for the expired timer. If more than one timers are created it is possible to distinguish them by the timer ID that is assigned to the timer with os::Looper::AddTimer() and that is passed to TimerTick() through the nID parameter.

Note: Never do any lenthy operations in any hook members that are called from the looper thread if the looper is involved with the GUI (for example if the looper is a os::Window). The looper will not be able to dispatch messages until the hook returns so spending a long time in this members will make the GUI feel unresponsive.

Warning:

Parameters

\return

Error codes:

See Also

Author: Kurt Skauen (kurt@.nosp@m.athe.nosp@m.os.cx)

Reimplemented from os::Handler.

References os::Looper::AddTimer(), os::Handler::GetLooper(), os::Control::GetValue(), ID_SCROLL_TIMER, os::ScrollBar::Private::m_bFirstTick, os::ScrollBar::Private::m_nHitButton, os::ScrollBar::Private::m_vMax, os::ScrollBar::Private::m_vMin, os::ScrollBar::Private::m_vSmallStep, os::Control::SetValue(), and os::Handler::TimerTick().

void ScrollBar::WheelMoved ( const Point & cDelta )

virtual

Description:: This member is called from the window thread whenever the user rotates the scroll wheel with the mouse pointer above this view.

: The default implementation of this member will call WheelMoved() on it's parent view if one exists.

Since: V0.3.7

Parameters

cDelta Delta movement. Normally only the y value is used but it is possible for the mouse driver to also support horizontal scroll wheel functionality. The delta value is normally +/- 1.0 for each "click" on the wheel.

See Also: MouseMove(), MouseDown(), MouseUp()

Author: Kurt Skauen (kurt@.nosp@m.athe.nosp@m.os.cx)

Reimplemented from os::View.

References os::Control::GetValue(), HORIZONTAL, os::Control::IsEnabled(), os::ScrollBar::Private::m_nOrientation, os::ScrollBar::Private::m_vMax, os::ScrollBar::Private::m_vMin, os::ScrollBar::Private::m_vSmallStep, os::Control::SetValue(), VERTICAL, os::View::WheelMoved(), os::Point::x, and os::Point::y.

Referenced by os::TextView::WheelMoved().

Classes

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation