os::IconView::MainView Class Reference

Inheritance diagram for os::IconView::MainView:

List of all members.

Public Member Functions
	MainView (os::Rect cFrame, IconView::Private *pcPrivate)
	~MainView ()
void	Paint (const os::Rect &cUpdateRect)
	Called by the system update "damaged" areas of the view.
void	WindowActivated (bool bFocus)
	Hook called when the window hosting this view gain or loose focus.
void	MouseDown (const os::Point &cPosition, uint32 nButtons)
	Hook called by the system when a mouse button is pressed.
void	MouseMove (const os::Point &cPosition, int nCode, uint32 nButtons, os::Message *pcData)
	Hook called by the system when the mouse is moved.
void	MouseUp (const os::Point &cPosition, uint32 nButtons, os::Message *pcData)
	Hook called by the system when a mouse button is release.
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.
void	FrameSized (const os::Point &cDelta)
	Virtual hook called by the system when the view is resized.
void	WheelMoved (const os::Point &cDelta)
	Hook called by the system when the scroll-wheel is rotated.
void	TimerTick (int nID)
	Timer dispatch member.

---

Constructor & Destructor Documentation

os::IconView::MainView::MainView	(	os::Rect	cFrame,
		IconView::Private *	pcPrivate
	)			[inline]

os::IconView::MainView::~MainView

(

)

[inline]

---

Member Function Documentation

void os::IconView::MainView::Paint

(

const os::Rect &

cUpdateRect

)

[inline, 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 ([email protected])

Reimplemented from os::View.

void os::IconView::MainView::WindowActivated

(

bool

bFocus

)

[inline, virtual]

Description:

This is a callback member that can be overloaded by derived classes to learn when the window that this view is hosted by is activated and when it is deactivated. The bIsActive parameter tell whether the focus was lost or gained. This member is called whenever the window changes focus independent of whether the view is active or not.

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 window gain and false if it loose focus.

See also:

MakeFocus(), Activated()

Author:

Kurt Skauen ([email protected])

Reimplemented from os::View.

void os::IconView::MainView::MouseDown	(	const os::Point &	cPosition,
		uint32	nButtons
	)			[inline, 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 ([email protected])

Reimplemented from os::View.

void os::IconView::MainView::MouseMove	(	const os::Point &	cPosition,
		int	nCode,
		uint32	nButtons,
		os::Message *	pcData
	)			[inline, 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 ([email protected])

Reimplemented from os::View.

void os::IconView::MainView::MouseUp	(	const os::Point &	cPosition,
		uint32	nButtons,
		os::Message *	pcData
	)			[inline, 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 ([email protected])

Reimplemented from os::View.

void os::IconView::MainView::KeyDown	(	const char *	pzString,
		const char *	pzRawString,
		uint32	nQualifiers
	)			[inline, 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 ([email protected])

Reimplemented from os::View.

void os::IconView::MainView::FrameSized

(

const os::Point &

cDelta

)

[inline, 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 ([email protected])

Reimplemented from os::View.

void os::IconView::MainView::WheelMoved

(

const os::Point &

cDelta

)

[inline, 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 ([email protected])

Reimplemented from os::View.

void os::IconView::MainView::TimerTick

(

int

nID

)

[inline, 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 ([email protected])

Reimplemented from os::Handler.

---