WxGUI Class Reference

WxGUI represents a user interface panel composed of WxWidgets. More...

Inheritance diagram for WxGUI:

List of all members.

Public Member Functions
virtual bool	handleEvent (const Event &event)
	Callback function that is implemented by the callee.

---

Detailed Description

WxGUI represents a user interface panel composed of WxWidgets.

Create an .xrc file using, for example DialogBlocks to use in the url field of this node.

Authoring Interface:

        WxGUI {
            field   SFURL       url     ""
            field   SFString    name    ""
            field   SFBoolean   show    true
            field   MFNode      widgets [ ]
            field   SFVec2f     position    -1 -1
            field   SFBoolean   floating true
            eventOut SFDouble   width
            eventOut SFDouble   height
                // from LoadStatusNode
            eventOut SFEnumeration  loadStatus  // not implemented in V0.1
            eventOut SFDouble       loadTime
        }

Parameters:

	url	specifies a .xrc user interface resource file to be loaded and presented in this panel. Default value: ""
	name	is the name of the panel, as it appears in the .xrc file. Default value: ""
	show	specifies whether this panel is visible or not. Default value: true
	widgets	specifies 0 or more WxWidget objects, each of which names a widget contained within the loaded resource file. Any widget objects found handles action events from its UI fixture in this panel. See WxWidget. Default value: [ ]
	position	is desired location of the dialog, in pixels. If floating is true this is relative to the upper left corner of the display. In this case, positions less than zero indicate that the window system should select a suitable position. If floating is false, then non-negative positions place the upper left corner of the dialog relative to the upper left corner of the Emma window. Negative positions place the lower right corner of the dialog relative to the lower right corner of the Emma window. Negative positions are converted to positive offsets using the formula: -1 - x and -1 - y. In other words, offsets of -1 result in an offset of 0 from the right or bottom edge of the window. X and Y offsets can be positive or negative independently. For instance, an offset of (-5,12) places the right edge of the dialog 4 pixels from the right edge of the Emma window and places the top edge of the dialog 12 pixels from the top edge of the Emma window. Default value: -1 -1
	floating	is true to make the dialog float on the display (not constrained to the Emma window) and false to make the Emma window the parent of the dialog. When floating is false, the dialog moves whenever the Emma window moves. See position for information on how to position the dialog within the parent window. Default value: true
	width	is resultant width of the panel created from the .xrc file given in screen coordinates.
	height	is resultant height of the panel created from the .xrc file given in screen coordinates.
	loadStatus	indicates the status of the resource file that is loading. Possible values are "NONE", "REQUESTED", "FAILED", "ABORTED", and "LOADED". See LoadStatusNode.
	loadTime	sends the current time whenever the load succeeds.

Functionality:

See WxGUI.

---

Member Function Documentation

virtual bool handleEvent (  const Event &  event  )  [virtual]

Callback function that is implemented by the callee. Parameters: event  specifies the time of the event. Event time will be the same for events occurring in the same render phase For example, PREUPDATE, POSTUPDATE, PRERENDER and POSTRENDER event callbacks will all pass the same event time for the same frame. Returning stop Emma from calling the rest of the handlers for this event If you return true, Emma will keep on calling rest of the handlers for this event Implements EventHandler.

---