Inheritance diagram for os::TabView:

Classes
class	Private

Public Member Functions
	TabView (const Rect &cFrame, const String &cTitle, uint32 nResizeMask=CF_FOLLOW_LEFT\|CF_FOLLOW_TOP, uint32 nFlags=WID_WILL_DRAW\|WID_FULL_UPDATE_ON_RESIZE)
	Contruct the TabView. More...

	~TabView ()

int	AppendTab (const String &cTitle, View *pcView=NULL)
	Add a tab at the end of the list. More...

int	InsertTab (uint nIndex, const String &cTitle, View *pcView=NULL)
	Insert tabs at a given position. More...

int	AppendTab (TabViewTab pcTab, View pcView=NULL)

int	InsertTab (uint nIndex, TabViewTab pcTab, View pcView=NULL)

View *	DeleteTab (uint nIndex)
	Delete a given tab. More...

View *	GetTabView (uint nIndex) const
	Get the View associated with a given tab. More...

int	GetTabCount () const
	Get number of tabs currently added to the view. More...

int	SetTabTitle (uint nIndex, const String &cTitle)

const String &	GetTabTitle (uint nIndex) const
	Get the title of a given tab. More...

uint	GetSelection () const
	Get the current selection. More...

void	SetSelection (uint nIndex, bool bNotify=true)
	Select a tab, and optionally notify the target. 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 Point	GetPreferredSize (bool bLargest) const

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

virtual void	AllAttached ()

void	SetCloseable (bool bClose)

bool	Closeable ()

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	AttachedToWindow ()

virtual void	DetachedFromWindow ()

virtual void	AllDetached ()

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

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	WheelMoved (const Point &cDelta)
	Hook called by the system when the scroll-wheel is rotated. More...

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	TimerTick (int nID)
	Timer dispatch member. 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 bool	Invoked (Message *pcMessage)
	Intercept outgoing messages. 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...

Friends
class	TabView::TopView

Detailed Description

Description:

See Also

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

Constructor & Destructor Documentation

TabView::TabView	(	const Rect &	cFrame,
		const String &	cName,
		uint32	nResizeMask = `CF_FOLLOW_LEFT \| CF_FOLLOW_TOP`,
		uint32	nFlags = `WID_WILL_DRAW \| WID_FULL_UPDATE_ON_RESIZE`
	)

Description:: Not much happens here. All paramaters are sendt ot the View() constructor

Note:

Warning:

Parameters

\return

See Also

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

References os::View::AddChild(), os::font_height::ascender, os::font_height::descender, os::View::GetFontHeight(), os::font_height::line_gap, os::TabView::Private::m_pcTopView, os::TabView::Private::m_sFontHeight, os::TabView::Private::m_vGlyphHeight, os::TabView::Private::m_vTabHeight, os::TabView::Private::m_vTotalWidth, and os::Rect::Width().

TabView::~TabView ( )

Member Function Documentation

void TabView::AllAttached ( void )

virtual

Description:: TabView overloades AllAttached to set the window as it's message target.

See Also: Invoker::SetTarget(), Invoker::SetMessage(), View::AllAttached()

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

Reimplemented from os::View.

References os::View::AllAttached(), os::View::GetWindow(), and os::Invoker::SetTarget().

int TabView::AppendTab	(	const String &	cTitle,
		View *	pcView = `NULL`
	)

Description:: Add a new tab to the TabView. The new tab will be appended to the list and will appear rightmost. Each tab is associated with title that is printed inside it, and a View that will be made visible when the tab is selected or hidden when the tab is inactive. If you want to use the TabView to something else than flipping between views, you can pass a NULL pointer, or you can pass the same ViewPointer for all tabs. Then you can associate a message with the TabView that will be sendt to it's target everytime the selection change.

Note:: Views associated with tabs should NOT be attached to any other view when or after the tab is created. It will automatically be a child of the TabView when added to a tab.

Views associated with tabs MUST have the CF_FOLLOW_ALL flag set to be properly resized when the TabView is resized.

When a view is associated with a tab, the view will be resized to fit the interiour of the TabView.

Parameters

pcTitle	- The string that should appear inside the tab.
pcView	- The View to be accosiated with the tab, or NULL.

Returns: The zero based index of the new tab.

See Also: InsertTab(), DeleteTab(), Invoker::SetMessage(), Invoker::SetTarget()

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

References InsertTab(), and os::TabView::Private::m_cTabList.

int TabView::AppendTab	(	TabViewTab *	pcTab,
		View *	pcView = `NULL`
	)

References InsertTab(), and os::TabView::Private::m_cTabList.

bool os::TabView::Closeable ( )

View * TabView::DeleteTab ( uint nIndex )

Description:: The tab at position nIndex is deleted, and the associated view is removed from the child list unless it is still associated with any of the remaining tabs. The view associated with the deleted tab is returned, and must be deleted by the caller if it is no longer needed.

Parameters

nIndex - The zero based index of the tab to delete.

Returns: Pointer to the view associated with the deleted tab.

See Also: AppendTab(), InsertTab(), GetTabView(), GetTabTitle()

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

References os::Message::AddInt32(), os::Rect::Floor(), os::Invoker::GetMessage(), os::View::GetNormalizedBounds(), os::TabViewTab::GetSize(), os::TabViewTab::GetView(), os::View::Hide(), os::View::Invalidate(), os::Invoker::Invoke(), os::TabView::Private::m_cTabList, os::TabView::Private::m_nSelectedTab, os::TabView::Private::m_pcTopView, os::TabView::Private::m_vTabHeight, os::TabView::Private::m_vTotalWidth, os::View::MakeFocus(), os::View::RemoveChild(), os::Rect::Resize(), os::View::SetFrame(), os::View::Show(), and os::Point::x.

void TabView::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::Rect::Floor(), os::View::Flush(), os::View::GetBounds(), os::View::Invalidate(), os::Rect::left, os::TabView::Private::m_cTabList, os::TabView::Private::m_nSelectedTab, os::TabView::Private::m_pcTopView, os::TabView::Private::m_vScrollOffset, os::TabView::Private::m_vTabHeight, os::TabView::Private::m_vTotalWidth, os::Rect::Resize(), os::Rect::right, os::View::SetFrame(), os::Rect::top, os::Rect::Width(), os::Point::x, and os::Point::y.

Point TabView::GetPreferredSize ( bool bLargest ) const

virtual

Description:: TabView overloads GetPreferredSize() and return the largest size returned by any of the views associated with the different tabs.

Returns: The largest preffered size returned by it's childs.

See Also: View::GetPreferredSize()

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

Reimplemented from os::View.

References os::TabView::Private::m_cTabList, os::TabView::Private::m_vTabHeight, os::TabView::Private::m_vTotalWidth, os::Point::x, and os::Point::y.

uint TabView::GetSelection ( ) const

Description:: Returns the zero based index of the selected tab.

Note:: This index is also added to the notification sendt when the selection change. The selection is then added under the name "selection".

Returns: The zero based index of the selected tab.

See Also: SetSelection(), Invoker::SetMessage(), Invoker::SetTarget()

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

References os::TabView::Private::m_nSelectedTab.

Referenced by os::TabViewTab::Paint().

int TabView::GetTabCount ( void ) const

Returns: Tab count

See Also: AppendTab(), InsertTab(), DeleteTab()

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

References os::TabView::Private::m_cTabList.

const String & TabView::GetTabTitle ( uint nIndex ) const

Parameters

nIndex - The zero based index of the tab.

Returns: const reference to a STL string containing the title.

See Also: GetTabView(), AppendTab(), InsertTab()

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

References os::TabView::Private::m_cTabList.

View * TabView::GetTabView ( uint nIndex ) const

Parameters

nIndex - The zero based index of the tab.

Returns: Pointer to the View associated with the tab.

See Also: GetTabTitle(), AppendTab(), InsertTab()

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

References os::TabView::Private::m_cTabList.

int TabView::InsertTab	(	uint	nIndex,
		const String &	cTitle,
		View *	pcView = `NULL`
	)

Description:: Same as AppendTab() except that InsertTab() accept a zero based index at which the tab will be inserted. Look at AppendTab() to get the full thruth.

Note:: If the rightmost tab is selected, the selection will be moved to the previous tab, and a notification message (if any) is sendt.

Warning:: The index MUST be between 0 and the current number of tabs!

Parameters

nIndex	- The zero based position where the tab is inserted.
pcTitle	- The string that should appear inside the tab.
pcView	- The View to be accosiated with the tab, or NULL.

Returns: The zero based index of the new tab (Same as nIndex).

See Also: AppendTab(), DeleteTab(), Invoker::SetMessage(), Invoker::SetTarget()

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

Referenced by AppendTab().

int TabView::InsertTab	(	uint	nIndex,
		TabViewTab *	pcTab,
		View *	pcView = `NULL`
	)

References os::View::AddChild(), os::Rect::Floor(), os::View::GetBounds(), os::View::GetNormalizedBounds(), os::View::GetParent(), os::TabView::Private::m_cTabList, os::TabView::Private::m_nSelectedTab, os::TabView::Private::m_pcTopView, os::TabView::Private::m_vTabHeight, os::TabView::Private::m_vTotalWidth, os::Rect::Resize(), os::View::SetFrame(), os::TabViewTab::SetOwner(), os::TabViewTab::SetView(), and os::View::Show().

void TabView::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::KeyDown(), os::TabView::Private::m_cTabList, os::TabView::Private::m_nSelectedTab, SetSelection(), VK_LEFT_ARROW, and VK_RIGHT_ARROW.

void TabView::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.

References os::TabView::Private::m_bMouseClicked, os::TabView::Private::m_cHitPos, os::TabView::Private::m_cTabList, os::TabView::Private::m_vScrollOffset, os::TabView::Private::m_vTabHeight, os::View::MouseDown(), SetSelection(), os::Point::x, and os::Point::y.

void TabView::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::View::Flush(), os::View::GetBounds(), os::View::GetQualifiers(), os::View::Invalidate(), os::Rect::left, os::TabView::Private::m_bMouseClicked, os::TabView::Private::m_cHitPos, os::TabView::Private::m_pcTopView, os::TabView::Private::m_vScrollOffset, os::TabView::Private::m_vTabHeight, os::TabView::Private::m_vTotalWidth, QUAL_SHIFT, os::Rect::right, os::View::Width(), and os::Point::x.

void TabView::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.

References os::TabView::Private::m_bMouseClicked.

void TabView::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::Rect::bottom, os::COL_NORMAL, os::COL_SHADOW, os::COL_SHINE, os::View::DrawLine(), os::View::FillRect(), os::Rect::Floor(), os::get_default_color(), os::View::GetBounds(), os::Rect::left, os::TabView::Private::m_cTabList, os::TabView::Private::m_nSelectedTab, os::TabView::Private::m_vScrollOffset, os::TabView::Private::m_vTabHeight, os::TabView::Private::m_vTotalWidth, os::Rect::Resize(), os::Rect::right, os::View::SetFgColor(), os::Rect::top, and os::Rect::Width().

void os::TabView::SetCloseable ( bool bClose )

void TabView::SetSelection	(	uint	nIndex,
		bool	bNotify = `true`
	)

Description:: Selects the given tab. If bNotify is true, and a messages has been assigned through Invoker::SetMessage() the message will be sendt to the target.

Parameters

nIndex	- The zero based index of the tab to select.
bNotify	- Set to true if Invoker::Invoke() should be called.

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

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

References os::Message::AddInt32(), os::Rect::Floor(), os::View::GetBounds(), os::Invoker::GetMessage(), os::View::GetNormalizedBounds(), os::View::Invalidate(), os::Invoker::Invoke(), os::TabView::Private::m_cTabList, os::TabView::Private::m_nSelectedTab, os::TabView::Private::m_pcTopView, os::TabView::Private::m_vTabHeight, os::View::MakeFocus(), os::Rect::Resize(), os::View::SetFrame(), and os::View::Show().

Referenced by KeyDown(), and MouseDown().

int TabView::SetTabTitle	(	uint	nIndex,
		const String &	cTitle
	)

References os::View::GetBounds(), os::View::Invalidate(), os::TabView::Private::m_cTabList, os::TabView::Private::m_pcTopView, and os::TabView::Private::m_vTotalWidth.

Friends And Related Function Documentation

friend class TabView::TopView

friend

Classes

Public Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation