CIvfWidgetBase Class Reference

#include <ivfwidget/IvfWidgetBase.h>

Inheritance diagram for CIvfWidgetBase:

List of all members.

Public Types
enum	TFunctionKey {   FK_BUTTON, FK_BACKSPACE, FK_TAB, FK_ENTER,   FK_PAUSE, FK_SCROLL_LOCK, FK_ESCAPE, FK_HOME,   FK_LEFT, FK_UP, FK_RIGHT, FK_DOWN,   FK_PAGE_UP, FK_PAGE_DOWN, FK_END, FK_PRINT,   FK_INSERT, FK_MENU, FK_NUM_LOCK, FK_F1,   FK_F2, FK_F3, FK_F4, FK_F5,   FK_F6, FK_F7, FK_F8, FK_F9,   FK_F10, FK_F11, FK_F12, FK_KP0,   FK_KP1, FK_KP2, FK_KP3, FK_KP4,   FK_KP5, FK_KP6, FK_KP7, FK_KP8,   FK_KP9, FK_KP_ENTER, FK_SHIFT_L, FK_SHIFT_R,   FK_CONTROL_L, FK_CONTROL_R, FK_CAPS_LOCK, FK_META_L,   FK_META_R, FK_ALT_L, FK_ALT_R, FK_DELETE }
enum	TModifierType { MT_SHIFT, MT_CTRL, MT_ALT, MT_NONE }
Public Member Functions
void	addMenuItemEvent (CIvfMenuItemEvent *event)
void	addRenderEvent (CIvfRenderEvent *event)
void	addClearEvent (CIvfClearEvent *event)
void	assignAppLoopEvent (CIvfAppLoopEvent *event)
void	addDestroyEvent (CIvfDestroyEvent *event)
void	addFocusEvent (CIvfFocusEvent *event)
void	addFunctionKeyEvent (CIvfFunctionKeyEvent *event)
void	addIdleEvent (CIvfIdleEvent *event)
void	addInitContextEvent (CIvfInitContextEvent *event)
void	addInitEvent (CIvfInitEvent *event)
void	addInitOverlayEvent (CIvfInitOverlayEvent *event)
void	addKeyboardEvent (CIvfKeyboardEvent *event)
void	addModifierDownEvent (CIvfModifierDownEvent *event)
void	addModifierUpEvent (CIvfModifierUpEvent *event)
void	addMouseDownEvent (CIvfMouseDownEvent *event)
void	addMouseEnterEvent (CIvfMouseEnterEvent *event)
void	addMouseEvent (CIvfMouseEvent *event)
void	addMouseLeaveEvent (CIvfMouseLeaveEvent *event)
void	addMouseMoveEvent (CIvfMouseMoveEvent *event)
void	addMouseUpEvent (CIvfMouseUpEvent *event)
void	addOverlayEvent (CIvfOverlayEvent *event)
void	addResizeEvent (CIvfResizeEvent *event)
void	addUnFocusEvent (CIvfUnFocusEvent *event)
void	assignTimeoutEvent (int nbr, CIvfTimeoutEvent *event)
void	removeMenuItemEvent (CIvfMenuItemEvent *event)
void	removeRenderEvent (CIvfRenderEvent *event)
void	removeClearEvent (CIvfClearEvent *event)
void	removeDestroyEvent (CIvfDestroyEvent *event)
void	removeFocusEvent (CIvfFocusEvent *event)
void	removeFunctionKeyEvent (CIvfFunctionKeyEvent *event)
void	removeIdleEvent (CIvfIdleEvent *event)
void	removeInitContextEvent (CIvfInitContextEvent *event)
void	removeInitEvent (CIvfInitEvent *event)
void	removeInitOverlayEvent (CIvfInitOverlayEvent *event)
void	removeKeyboardEvent (CIvfKeyboardEvent *event)
void	removeModifierDownEvent (CIvfModifierDownEvent *event)
void	removeModifierUpEvent (CIvfModifierUpEvent *event)
void	removeMouseDownEvent (CIvfMouseDownEvent *event)
void	removeMouseEnterEvent (CIvfMouseEnterEvent *event)
void	removeMouseEvent (CIvfMouseEvent *event)
void	removeMouseLeaveEvent (CIvfMouseLeaveEvent *event)
void	removeMouseMoveEvent (CIvfMouseMoveEvent *event)
void	removeMouseUpEvent (CIvfMouseUpEvent *event)
void	removeOverlayEvent (CIvfOverlayEvent *event)
void	removeResizeEvent (CIvfResizeEvent *event)
void	removeUnFocusEvent (CIvfUnFocusEvent *event)
void	removeTimeoutEvent (int nbr)
	CIvfWidgetBase ()
virtual	~CIvfWidgetBase ()
	IvfClassInfo ("CIvfWidgetBase", CIvfBase)
void	redraw ()
bool	isInitDone ()
bool	isMiddleButtonDown ()
bool	isRightButtonDown ()
bool	isLeftButtonDown ()
bool	isAnyButtonDown ()
void	disableIdleProcessing ()
void	enableIdleProcessing ()
bool	isIdleProcessing ()
void	enableTimeout (float time, int nbr)
void	disableTimeout (int nbr)
bool	isTimeoutEnabled (int nbr)
float	getTimeout (int number)
TModifierType	getModifierKey ()
double	elapsedTime ()
void	setPosition (int x, int y)
void	setSize (int w, int h)
void	setUseOverlay (bool flag)
bool	getUseOverlay ()
void	clearMouseStatus ()
void	setModifierKey (TModifierType key)
void	setMiddleButtonStatus (bool down)
void	setRightButtonStatus (bool down)
void	setLeftButtonStatus (bool down)
virtual void	onInit (int width, int height)
virtual void	onDestroy ()
virtual void	onInitContext (int width, int height)
virtual void	onOverlay ()
virtual void	onMouse (int x, int y)
virtual void	onMouseDown (int x, int y)
virtual void	onMouseUp (int x, int y)
virtual void	onMouseMove (int x, int y)
virtual void	onMouseLeave (int x, int y)
virtual void	onMouseEnter (int x, int y)
virtual void	onKeyboard (int key, int x, int y)
virtual void	onModifierDown ()
virtual void	onModifierUp ()
virtual void	onInitOverlay (int width, int height)
virtual void	onRender ()
virtual void	onMenuItem (int id)
virtual void	onClear ()
virtual void	onResize (int width, int height)
virtual void	onUnFocus ()
virtual void	onFocus ()
virtual void	onFunctionKey (TFunctionKey key, int x, int y)
virtual void	onIdle ()
virtual bool	onTimeout0 ()
virtual bool	onTimeout1 ()
virtual bool	onTimeout2 ()
virtual bool	onTimeout3 ()
virtual bool	onTimeout4 ()
virtual bool	onTimeout5 ()
virtual bool	onTimeout6 ()
virtual bool	onTimeout7 ()
virtual bool	onTimeout8 ()
virtual bool	onTimeout9 ()
virtual bool	onAppLoop ()
virtual void	doIdle ()
virtual bool	doTimeout0 ()
virtual bool	doTimeout1 ()
virtual bool	doTimeout2 ()
virtual bool	doTimeout3 ()
virtual bool	doTimeout4 ()
virtual bool	doTimeout5 ()
virtual bool	doTimeout6 ()
virtual bool	doTimeout7 ()
virtual bool	doTimeout8 ()
virtual bool	doTimeout9 ()
virtual bool	doAppLoop ()
virtual double	doElapsedTime ()
virtual void	doInitOverlay (int width, int height)
virtual void	doDestroy ()
virtual void	doOverlay ()
virtual void	doInitContext (int width, int height)
virtual void	doClear ()
virtual void	doRender ()
virtual void	doInit (int width, int height)
void	doMenuItem (int id)
virtual void	doDisableIdleProcessing ()
virtual void	doEnableIdleProcessing ()
virtual void	doEnableTimeout (float time, int nbr)
virtual void	doDisableTimeout (int nbr)
virtual void	doRedraw ()
virtual void	doMouseEnter (int x, int y)
virtual void	doUnFocus ()
virtual void	doFocus ()
virtual void	doMouseMove (int x, int y)
virtual void	doMouseUp (int x, int y)
virtual void	doMouseDown (int x, int y)
virtual void	doDraw ()
virtual void	doResize (int width, int height)
virtual void	doMouseLeave (int x, int y)
virtual void	doKeyboard (int key, int x, int y)
virtual void	doModifierDown ()
virtual void	doModifierUp ()
virtual void	doFunctionKey (TFunctionKey key, int x, int y)
virtual void	doSetPosition (int x, int y)
virtual void	doSetSize (int w, int h)

---

Detailed Description

Base class for all Ivf++ widgets

This class implements the standard functionality for handling keyboard, mouse and drawing of a widget. The class should be used in combination with some kind of window/view class. The ivffltk library derives a widget class by combining Fl_Gl_Window with CIvfWidgetBase.

Ivf++ 0.9.x introduces a new event model in the CIvfWidgetBase class. This model uses assignable event classes in addition of the virtual methods previously used. This enables the use of "handler" classes for supporting pluggable user interface functionality. See the IvfEvent.h header file for a description of the supported events in the CIvfWidgetBase class. Events is preferred way of implementing UI functionality in Ivf++ 0.9.x.

When implementing new classes mouse, keyboard and drawing events should be interfaced with the doXXX() methods. These Will in turn call onXXX() methods and asssigned events, from which the user can override the default behavior.

The methods doEnableIdleProcessing(), doDisableIdleProcessing(), doEnableTimeout() and doRedraw() should be overidden and functionality for these implemented.

Author:

Jonas Lindemann

Definition at line 62 of file IvfWidgetBase.h.

---

Member Enumeration Documentation

enum CIvfWidgetBase::TFunctionKey

Function key enumerations Definition at line 65 of file IvfWidgetBase.h.

enum CIvfWidgetBase::TModifierType

Enumerations for modifier status Definition at line 121 of file IvfWidgetBase.h.

---

Constructor & Destructor Documentation

CIvfWidgetBase::CIvfWidgetBase (   )

CIvfWidgetBase constructor

virtual CIvfWidgetBase::~CIvfWidgetBase (   )  [virtual]

CIvfWidgetBase destructor

---

Member Function Documentation

void CIvfWidgetBase::addClearEvent (  CIvfClearEvent *  event  )

Add clear event

void CIvfWidgetBase::addDestroyEvent (  CIvfDestroyEvent *  event  )

Add destroy event

void CIvfWidgetBase::addFocusEvent (  CIvfFocusEvent *  event  )

Add focus event

void CIvfWidgetBase::addFunctionKeyEvent (  CIvfFunctionKeyEvent *  event  )

Add function key event

void CIvfWidgetBase::addIdleEvent (  CIvfIdleEvent *  event  )

Add idle event

void CIvfWidgetBase::addInitContextEvent (  CIvfInitContextEvent *  event  )

Add init context event

void CIvfWidgetBase::addInitEvent (  CIvfInitEvent *  event  )

Add init event

void CIvfWidgetBase::addInitOverlayEvent (  CIvfInitOverlayEvent *  event  )

Add init overlay event

void CIvfWidgetBase::addKeyboardEvent (  CIvfKeyboardEvent *  event  )

Add keyboard event

void CIvfWidgetBase::addMenuItemEvent (  CIvfMenuItemEvent *  event  )

Add menu item event

void CIvfWidgetBase::addModifierDownEvent (  CIvfModifierDownEvent *  event  )

Add modifier down event

void CIvfWidgetBase::addModifierUpEvent (  CIvfModifierUpEvent *  event  )

Add modifier up event

void CIvfWidgetBase::addMouseDownEvent (  CIvfMouseDownEvent *  event  )

Add mouse down event

void CIvfWidgetBase::addMouseEnterEvent (  CIvfMouseEnterEvent *  event  )

Add mouse enter event

void CIvfWidgetBase::addMouseEvent (  CIvfMouseEvent *  event  )

Add mouse event

void CIvfWidgetBase::addMouseLeaveEvent (  CIvfMouseLeaveEvent *  event  )

Add mouse leave event

void CIvfWidgetBase::addMouseMoveEvent (  CIvfMouseMoveEvent *  event  )

Add mouse move event

void CIvfWidgetBase::addMouseUpEvent (  CIvfMouseUpEvent *  event  )

Add mouse up event

void CIvfWidgetBase::addOverlayEvent (  CIvfOverlayEvent *  event  )

Add overlay event

void CIvfWidgetBase::addRenderEvent (  CIvfRenderEvent *  event  )

Add render event

void CIvfWidgetBase::addResizeEvent (  CIvfResizeEvent *  event  )

Add resize event

void CIvfWidgetBase::addUnFocusEvent (  CIvfUnFocusEvent *  event  )

Add unfocus event

void CIvfWidgetBase::assignAppLoopEvent (  CIvfAppLoopEvent *  event  )

Assign application loop event

void CIvfWidgetBase::assignTimeoutEvent (  int  nbr, CIvfTimeoutEvent *  event )

Assign timeout event

void CIvfWidgetBase::clearMouseStatus (   )

Clears mouse status

void CIvfWidgetBase::disableIdleProcessing (   )

Disables idle processing

void CIvfWidgetBase::disableTimeout (  int  nbr  )

Enables timeout Parameters: time  interval in seconds when timeout should occur. nbr  what timeout to enable.

virtual bool CIvfWidgetBase::doAppLoop (   )  [virtual]

doAppLoop event These events handles timer calls. If timeout should be repeated the return value should be true.

virtual void CIvfWidgetBase::doClear (   )  [virtual]

Called by doDraw()

virtual void CIvfWidgetBase::doDestroy (   )  [virtual]

Called by the doDraw() method Reimplemented in CIvfMfcView, CIvfMfcWindow, CIvfWorkspaceWidget, and CIvfWin32Window.

virtual void CIvfWidgetBase::doDisableIdleProcessing (   )  [virtual]

Enable idle processing (to be overidden) Derived widget should override this method to enable idle processing. Idle processing should then call doIdle(). Reimplemented in CIvfFltkBase, CIvfFltkWorkspace, CIvfMfcView, CIvfMfcWindow, and CIvfWin32Window.

virtual void CIvfWidgetBase::doDisableTimeout (  int  nbr  )  [virtual]

Disable timeout callback (to be overidden) Derived widget should override this method to disable specified callback. Reimplemented in CIvfFltkBase, CIvfMfcView, CIvfMfcWindow, and CIvfWin32Window.

virtual void CIvfWidgetBase::doDraw (   )  [virtual]

Draw event handling (called from widget) Derived widget should call this method when widget is to be redrawn.

virtual void CIvfWidgetBase::doEnableIdleProcessing (   )  [virtual]

Disable idle processing (to be overidden) Derived widget should override this method to disable idle processing. Reimplemented in CIvfFltkBase, CIvfFltkWorkspace, CIvfMfcView, CIvfMfcWindow, and CIvfWin32Window.

virtual void CIvfWidgetBase::doEnableTimeout (  float  time, int  nbr )  [virtual]

Enable timeout callback (to be overidden) Derived widget should override this method to enable specified callback. Reimplemented in CIvfFltkBase, CIvfFltkWorkspace, CIvfMfcView, CIvfMfcWindow, and CIvfWin32Window.

virtual void CIvfWidgetBase::doFocus (   )  [virtual]

UnFocus event handling (called from widget) Derived widget should call this method when widget received focus.

virtual void CIvfWidgetBase::doFunctionKey (  TFunctionKey  key, int  x, int  y )  [virtual]

FunctionKey event handling (called from widget) Derived widget should call this method when a function key on the keyboard is pressed.

virtual void CIvfWidgetBase::doIdle (   )  [virtual]

Idle method processing This method should be called from the derived widget when it is in idle processing. doIdle() will call the onIdle method.

virtual void CIvfWidgetBase::doInit (  int  width, int  height )  [virtual]

Called by doResize() Reimplemented in CIvfMfcView, CIvfMfcWindow, and CIvfWorkspaceWidget.

virtual void CIvfWidgetBase::doInitContext (  int  width, int  height )  [virtual]

Called by doResize()

virtual void CIvfWidgetBase::doInitOverlay (  int  width, int  height )  [virtual]

Called by the doDraw() method

virtual void CIvfWidgetBase::doKeyboard (  int  key, int  x, int  y )  [virtual]

Keyboard event handling (called from widget) Derived widget should call this method when a key on the keyboard is pressed. Reimplemented in CIvfWorkspaceWidget.

virtual void CIvfWidgetBase::doModifierDown (   )  [virtual]

A modifer key event handling Derived widgets should call this method when a modifier key is pressed.

virtual void CIvfWidgetBase::doModifierUp (   )  [virtual]

A modifer key event handling Derived widgets should call this method when a modifier key is released.

virtual void CIvfWidgetBase::doMouseDown (  int  x, int  y )  [virtual]

MouseDown event handling (called from widget) Derived widget should call this method when any of the mouse buttons is pressed. Reimplemented in CIvfWindow, CIvfWorkspaceWindow, and CIvfWorkspaceWidget.

virtual void CIvfWidgetBase::doMouseEnter (  int  x, int  y )  [virtual]

MouseEnter event handling (called from widget) Derived widget should call this method when mouse enters the widget.

virtual void CIvfWidgetBase::doMouseLeave (  int  x, int  y )  [virtual]

MouseLeave event handling (called from widget) Derived widget should call this method when the mouse leaves the widget.

virtual void CIvfWidgetBase::doMouseMove (  int  x, int  y )  [virtual]

MouseMove event handling (called from widget) Derived widget should call this method when the mouse is moved. Reimplemented in CIvfWorkspaceWidget.

virtual void CIvfWidgetBase::doMouseUp (  int  x, int  y )  [virtual]

MouseUp event handling (called from widget) Derived widget should call this method when any of the mouse buttons is released. Reimplemented in CIvfWindow, CIvfWorkspaceWindow, and CIvfWorkspaceWidget.

virtual void CIvfWidgetBase::doOverlay (   )  [virtual]

Called by the doDraw() method

virtual void CIvfWidgetBase::doRedraw (   )  [virtual]

Redraw operation (to be overidden) Derived widget should override this method to do a redraw of widget Reimplemented in CIvfFltkBase, CIvfFltkWorkspace, CIvfMfcView, CIvfMfcWindow, and CIvfWin32Window.

virtual void CIvfWidgetBase::doRender (   )  [virtual]

Called by doDraw() Reimplemented in CIvfWorkspaceWidget.

virtual void CIvfWidgetBase::doResize (  int  width, int  height )  [virtual]

Resize event handling (called from widget) Derived widget should call this method when widget is resized. Reimplemented in CIvfWorkspaceWidget.

virtual bool CIvfWidgetBase::doTimeout0 (   )  [virtual]

Timeout processing (called from widget) This method should be called from the derived widget when a timeout event has occured. This method will inturn call onTimeoutX()

virtual bool CIvfWidgetBase::doTimeout1 (   )  [virtual]

Timeout processing (called from widget) This method should be called from the derived widget when a timeout event has occured. This method will inturn call onTimeoutX()

virtual bool CIvfWidgetBase::doTimeout2 (   )  [virtual]

Timeout processing (called from widget) This method should be called from the derived widget when a timeout event has occured. This method will inturn call onTimeoutX()

virtual bool CIvfWidgetBase::doTimeout3 (   )  [virtual]

Timeout processing (called from widget) This method should be called from the derived widget when a timeout event has occured. This method will inturn call onTimeoutX()

virtual bool CIvfWidgetBase::doTimeout4 (   )  [virtual]

Timeout processing (called from widget) This method should be called from the derived widget when a timeout event has occured. This method will inturn call onTimeoutX()

virtual bool CIvfWidgetBase::doTimeout5 (   )  [virtual]

Timeout processing (called from widget) This method should be called from the derived widget when a timeout event has occured. This method will inturn call onTimeoutX()

virtual bool CIvfWidgetBase::doTimeout6 (   )  [virtual]

Timeout processing (called from widget) This method should be called from the derived widget when a timeout event has occured. This method will inturn call onTimeoutX()

virtual bool CIvfWidgetBase::doTimeout7 (   )  [virtual]

Timeout processing (called from widget) This method should be called from the derived widget when a timeout event has occured. This method will inturn call onTimeoutX()

virtual bool CIvfWidgetBase::doTimeout8 (   )  [virtual]

Timeout processing (called from widget) This method should be called from the derived widget when a timeout event has occured. This method will inturn call onTimeoutX()

virtual bool CIvfWidgetBase::doTimeout9 (   )  [virtual]

Timeout processing (called from widget) This method should be called from the derived widget when a timeout event has occured. This method will inturn call onTimeoutX()

virtual void CIvfWidgetBase::doUnFocus (   )  [virtual]

UnFocus event handling (called from widget) Derived widget should call this method when widget looses focus.

double CIvfWidgetBase::elapsedTime (   )

Returns elasped time since onInit event

void CIvfWidgetBase::enableIdleProcessing (   )

Enables idle processing

void CIvfWidgetBase::enableTimeout (  float  time, int  nbr )

Enables timeout Parameters: time  interval in seconds when timeout should occur. nbr  what timeout to enable.

TModifierType CIvfWidgetBase::getModifierKey (   )

Return what modifier key is down

float CIvfWidgetBase::getTimeout (  int  number  )

Return interval of specified timeout

bool CIvfWidgetBase::getUseOverlay (   )

Return overlay status

bool CIvfWidgetBase::isAnyButtonDown (   )

Returns true if any button is down

bool CIvfWidgetBase::isIdleProcessing (   )

Returns true if idle processing is enabled

bool CIvfWidgetBase::isInitDone (   )

Returns true if onInit() has been called

bool CIvfWidgetBase::isLeftButtonDown (   )

Returns true if left button is down

bool CIvfWidgetBase::isMiddleButtonDown (   )

Returns true if middle button is down

bool CIvfWidgetBase::isRightButtonDown (   )

Returns true if right button is down

bool CIvfWidgetBase::isTimeoutEnabled (  int  nbr  )

Returns true if timeout nbr is enabled

virtual bool CIvfWidgetBase::onAppLoop (   )  [virtual]

onAppLoop event These events handles timer calls. If timeout should be repeated the return value should be true.

virtual void CIvfWidgetBase::onClear (   )  [virtual]

onClear event The onClear event is called when the widget needs to be cleared. Typically a glClear() function should be called to clear the widget if overidden. If not overidden, the widget is clear with the color black.

virtual void CIvfWidgetBase::onDestroy (   )  [virtual]

onDestroy event This method is called when the widget is destroyed. Examples: robot.cpp, and textures.cpp.

virtual void CIvfWidgetBase::onFocus (   )  [virtual]

onFocus event The onFocus event occurs when the widget has received focus.

virtual void CIvfWidgetBase::onFunctionKey (  TFunctionKey  key, int  x, int  y )  [virtual]

onFunctionKey event The onFunctionKey event is called when a function key is pressed. See the TFunctionKey enumeration.

virtual void CIvfWidgetBase::onIdle (   )  [virtual]

onIdle event This event handles idle processing if it is turned on using enableIdleProcessing().

virtual void CIvfWidgetBase::onInit (  int  width, int  height )  [virtual]

onInit event onInit is called the first time an OpenGL context is activated. All OpenGL dependent intialization code should be placed here, including Ivf++ code. Examples: ac3dreader.cpp, actionctl.cpp, advgeom.cpp, controllers.cpp, culling.cpp, extrusion.cpp, lighting.cpp, lod.cpp, placement.cpp, robot.cpp, selection.cpp, and textures.cpp.

virtual void CIvfWidgetBase::onInitContext (  int  width, int  height )  [virtual]

onInitContext event This event is called when an OpenGL context is initialized. OpenGL state initialization code should be placed here.

virtual void CIvfWidgetBase::onInitOverlay (  int  width, int  height )  [virtual]

onInitOverlay event The onInitOverlay event is called before the onOverlay event to setup the overlay projection matrices.

virtual void CIvfWidgetBase::onKeyboard (  int  key, int  x, int  y )  [virtual]

onKeyboard event The onKeyboard event is called when a key on the keyboard is pressed Examples: ac3dreader.cpp, actionctl.cpp, controllers.cpp, culling.cpp, lighting.cpp, lod.cpp, robot.cpp, and textures.cpp.

virtual void CIvfWidgetBase::onModifierDown (   )  [virtual]

onModifierDown event The onModifier event is called when a modifier key is pressed (only supported on WIN32 for now)

virtual void CIvfWidgetBase::onModifierUp (   )  [virtual]

onModifierUp event The onModifier event is called when a modifier key is released (only supported on WIN32 for now)

virtual void CIvfWidgetBase::onMouseDown (  int  x, int  y )  [virtual]

onMouseDown event The onMouseDown event is called when any of the mouse buttons are pressed. Examples: ac3dreader.cpp, actionctl.cpp, advgeom.cpp, controllers.cpp, culling.cpp, extrusion.cpp, lighting.cpp, lod.cpp, placement.cpp, selection.cpp, and textures.cpp.

virtual void CIvfWidgetBase::onMouseEnter (  int  x, int  y )  [virtual]

onMouseEnter event The onMouseEnter event is called when the mouse enters the window.

virtual void CIvfWidgetBase::onMouseLeave (  int  x, int  y )  [virtual]

onMouseLeave event The onMouseLeave event is called when the mouse leaves the window.

virtual void CIvfWidgetBase::onMouseMove (  int  x, int  y )  [virtual]

onMouseMove event The onMouseMove event is called whenever the mouse is moved in the window. Examples: ac3dreader.cpp, actionctl.cpp, advgeom.cpp, controllers.cpp, culling.cpp, extrusion.cpp, lighting.cpp, lod.cpp, placement.cpp, and textures.cpp.

virtual void CIvfWidgetBase::onMouseUp (  int  x, int  y )  [virtual]

onMouseUp event The onMouse event is called when the mouse button is released. Examples: ac3dreader.cpp, actionctl.cpp, advgeom.cpp, controllers.cpp, culling.cpp, extrusion.cpp, lighting.cpp, lod.cpp, placement.cpp, and textures.cpp.

virtual void CIvfWidgetBase::onOverlay (   )  [virtual]

onOverlay event This event is called when an overlay is to be drawn. For this method to be called, the UseOverlay property must be set using the setUseOverlay method. The view port is configured for 2D drawing when this method is called.

virtual void CIvfWidgetBase::onRender (   )  [virtual]

onRender event The onRender event is called whenever the widget needs to be redrawn. Examples: ac3dreader.cpp, actionctl.cpp, advgeom.cpp, controllers.cpp, culling.cpp, extrusion.cpp, lighting.cpp, lod.cpp, placement.cpp, robot.cpp, selection.cpp, and textures.cpp.

virtual void CIvfWidgetBase::onResize (  int  width, int  height )  [virtual]

onResize event The onResize event occurs when the widget has changed size. Typically code for initialising the viewport and perspective transformation goes here. Examples: ac3dreader.cpp, actionctl.cpp, advgeom.cpp, controllers.cpp, culling.cpp, extrusion.cpp, lighting.cpp, lod.cpp, placement.cpp, robot.cpp, selection.cpp, and textures.cpp.

virtual bool CIvfWidgetBase::onTimeout0 (   )  [virtual]

onTimeout event These events handles timer calls. If timeout should be repeated the return value should be true. Examples: ac3dreader.cpp, actionctl.cpp, controllers.cpp, and lighting.cpp.

virtual bool CIvfWidgetBase::onTimeout1 (   )  [virtual]

onTimeout event These events handles timer calls. If timeout should be repeated the return value should be true.

virtual bool CIvfWidgetBase::onTimeout2 (   )  [virtual]

onTimeout event These events handles timer calls. If timeout should be repeated the return value should be true.

virtual bool CIvfWidgetBase::onTimeout3 (   )  [virtual]

onTimeout event These events handles timer calls. If timeout should be repeated the return value should be true.

virtual bool CIvfWidgetBase::onTimeout4 (   )  [virtual]

onTimeout event These events handles timer calls. If timeout should be repeated the return value should be true.

virtual bool CIvfWidgetBase::onTimeout5 (   )  [virtual]

onTimeout event These events handles timer calls. If timeout should be repeated the return value should be true.

virtual bool CIvfWidgetBase::onTimeout6 (   )  [virtual]

onTimeout event These events handles timer calls. If timeout should be repeated the return value should be true.

virtual bool CIvfWidgetBase::onTimeout7 (   )  [virtual]

onTimeout event These events handles timer calls. If timeout should be repeated the return value should be true.

virtual bool CIvfWidgetBase::onTimeout8 (   )  [virtual]

onTimeout event These events handles timer calls. If timeout should be repeated the return value should be true.

virtual bool CIvfWidgetBase::onTimeout9 (   )  [virtual]

onTimeout event These events handles timer calls. If timeout should be repeated the return value should be true.

virtual void CIvfWidgetBase::onUnFocus (   )  [virtual]

onUnFocus event The onUnFocus event occurs when the widget has lost focus.

void CIvfWidgetBase::removeClearEvent (  CIvfClearEvent *  event  )

Remove clear event

void CIvfWidgetBase::removeDestroyEvent (  CIvfDestroyEvent *  event  )

Remove destroy event

void CIvfWidgetBase::removeFocusEvent (  CIvfFocusEvent *  event  )

Remove focus event

void CIvfWidgetBase::removeFunctionKeyEvent (  CIvfFunctionKeyEvent *  event  )

Remove function key event

void CIvfWidgetBase::removeIdleEvent (  CIvfIdleEvent *  event  )

Remove idle event

void CIvfWidgetBase::removeInitContextEvent (  CIvfInitContextEvent *  event  )

Remove init context event

void CIvfWidgetBase::removeInitEvent (  CIvfInitEvent *  event  )

Remove init event

void CIvfWidgetBase::removeInitOverlayEvent (  CIvfInitOverlayEvent *  event  )

Remove init overlay event

void CIvfWidgetBase::removeKeyboardEvent (  CIvfKeyboardEvent *  event  )

Remove keyboard event

void CIvfWidgetBase::removeMenuItemEvent (  CIvfMenuItemEvent *  event  )

Remove menu item event

void CIvfWidgetBase::removeModifierDownEvent (  CIvfModifierDownEvent *  event  )

Remove modifier down event

void CIvfWidgetBase::removeModifierUpEvent (  CIvfModifierUpEvent *  event  )

Remove modifier up event

void CIvfWidgetBase::removeMouseDownEvent (  CIvfMouseDownEvent *  event  )

Remove mouse down event

void CIvfWidgetBase::removeMouseEnterEvent (  CIvfMouseEnterEvent *  event  )

Remove mouse enter event

void CIvfWidgetBase::removeMouseEvent (  CIvfMouseEvent *  event  )

Remove mouse event

void CIvfWidgetBase::removeMouseLeaveEvent (  CIvfMouseLeaveEvent *  event  )

Remove mouse leave event

void CIvfWidgetBase::removeMouseMoveEvent (  CIvfMouseMoveEvent *  event  )

Remove mouse move event

void CIvfWidgetBase::removeMouseUpEvent (  CIvfMouseUpEvent *  event  )

Remove mouse up event

void CIvfWidgetBase::removeOverlayEvent (  CIvfOverlayEvent *  event  )

Remove overlay event

void CIvfWidgetBase::removeRenderEvent (  CIvfRenderEvent *  event  )

Remove render event

void CIvfWidgetBase::removeResizeEvent (  CIvfResizeEvent *  event  )

Remove resize event

void CIvfWidgetBase::removeTimeoutEvent (  int  nbr  )

Remove timeout event

void CIvfWidgetBase::removeUnFocusEvent (  CIvfUnFocusEvent *  event  )

Remove unfocus event

void CIvfWidgetBase::setLeftButtonStatus (  bool  down  )

Set left mouse status

void CIvfWidgetBase::setMiddleButtonStatus (  bool  down  )

Set middle mouse status

void CIvfWidgetBase::setModifierKey (  TModifierType  key  )

Sets the modifier key

void CIvfWidgetBase::setPosition (  int  x, int  y )

Set position of widget

void CIvfWidgetBase::setRightButtonStatus (  bool  down  )

Set right mouse status

void CIvfWidgetBase::setSize (  int  w, int  h )

Set size of widget

void CIvfWidgetBase::setUseOverlay (  bool  flag  )

Enable/disable use of overlay When flag is set to true the widget will call the onOverlay event, for drawing the overlay.

---

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

• ivfwidget/IvfWidgetBase.h

---