JRAD at 12:05, 21 November 2007

2007-11-21T12:05:35Z

New page

__NOEDITSECTION__
== Class Tree ==
* [[:UIObject]]
** [[:UIObject_Drawable]]
*** [[:UIWindow]]

== Overview ==
The most common window type can be used to draw text or materials within its rectangle.

In many places it is also used just for managing other windows, handling events and timelines.

This class may be used in the GUIs. It will inherit all properties, flags, functions and events from [[UIObject_Drawable]].

Window type:
type window;

'''Example:'''
// Define properties required to display the warmup text at the center of the screen.
windowDef warmupLabel {
_big_text_props // Template: Sets the font size.
properties {
rect rect = 0, CENTER_Y - 28, SCREEN_WIDTH, 16;
wstring text = player.matchStatus; // The text we're displaying
float visible = gui.respawnLabel.visible == false && player.warmup && player.commandmapstate == 0 && player.commandmapstate == 0 && player.scoreboardActive == false && globals.gameHud.hideCrosshairCounter == 0;
float flags = immediate( flags ) | WF_DROPSHADOW;
}
}

== Properties ==
{{:UIWindow Properties}}

== Flags ==
{{:UIWindow Flags}}

== Functions ==
=== General Functions ===
[[UIWindow:attachRenderCallback|attachRenderCallback]] Attach a render callback to the drawing of the window.
[[UIWindow:attachInputHandler|attachInputHandler]] Attach an input handler for the window.
[[UIWindow:drawMaterial|drawMaterial]] Draw a material.
[[UIWindow:drawRenderCallback|drawRenderCallback]] Call the draw render callback for the given render callback handle.
[[UIWindow:drawCachedMaterial|drawCachedMaterial]] Draw cached material.
[[UIWindow:getCachedMaterialDimensions|getCachedMaterialDimensions]] Get the width and height of the material.
[[UIWindow:drawMaterialInfo|drawMaterialInfo]] Draw material. Get data from the material info.
[[UIWindow:drawMaterialArc|drawMaterialArc]] Draw an arc.
[[UIWindow:drawTimer|drawTimer]] Draw a timer, used by the grenade indicator and progress indicators by the crosshair.
[[UIWindow:drawText|drawText]] Draw text.
[[UIWindow:measureText|measureText]] Measure the text.
[[UIWindow:measureLocalizedText|measureLocalizedText]] Measure the text.
[[UIWindow:drawTiledMaterial|drawTiledMaterial]] Draw a tiled material.
[[UIWindow:drawLocalizedText|drawLocalizedText]] Text to be drawn.
[[UIWindow:drawLine|drawLine]] Draw a line.
[[UIWindow:requestLayout|requestLayout]] Request the window layout to be calculated again.
[[UIWindow:drawRect|drawRect]] Draw a rectangle.
[[UIWindow:nextTabStop|nextTabStop]] Get the next tab stop for the specified window.
[[UIWindow:prevTabStop|prevTabStop]] Get the previous tab stop for the specified window.
[[UIWindow:setTabStop|setTabStop]] Focuses the nth tab stop.
[[UIWindow:containsPoint|containsPoint]] Checks if the (world-based) point is in the client rectangle.
[[UIWindow:cacheRenderCallback|cacheRenderCallback]] Return a reference to a render callback.
[[UIWindow:clipToRect|clipToRect]] Clip subsequent drawing to the clipping rectangle. Must be ended with unclipRect after clipped drawing is finished.
[[UIWindow:unclipRect|unclipRect]] Remove clipping to rectangle specified in clipToRect.
[[UIWindow:pushColor|pushColor]] Push a color on the GUI's color stack.
[[UIWindow:pushColorComponents|pushColorComponents]] Push a color on the GUI's color stack.
[[UIWindow:popColor|popColor]] Pop a color from the GUI's color stack.
[[UIWindow:drawShaderParm|drawShaderParm]] Set a shader parm value.
[[UIWindow:isVisible|isVisible]] Check if self is visible.

== Events ==
[[UIWindow:onPreDraw|onPreDraw]] Called before the window is about to draw. The event is often used for doing custom text and material drawing instead of the default drawing.
[[UIWindow:onPostDraw|onPostDraw]] Called after gamecode has finished drawing.
[[UIWindow:onPostChildDraw|onPostChildDraw]] Called after all descendants have finished drawing.
[[UIWindow:onMouseMove|onMouseMove]] Called when the mouse moves.
[[UIWindow:onMouseEnter|onMouseEnter]] Called when the mouse enters the window.
[[UIWindow:onMouseExit|onMouseExit]] Called when the mouse exits the window.
[[UIWindow:onKeyUp|onKeyUp]] Called when a key is depressed.
[[UIWindow:onKeyDown|onKeyDown]] Called when a key is pressed.
[[UIWindow:onKeyUpBind|onKeyUpBind]] Called when keys using the bind is depressed.
[[UIWindow:onKeyDownBind|onKeyDownBind]] Called when keys usng the bind is pressed
[[UIWindow:onShow|onShow]] When the visible property is changed to true.
[[UIWindow:onHide|onHide]] When The hide property is changed to false.
[[UIWindow:onGainFocus|onGainFocus]] The window has gained focus.
[[UIWindow:onLoseFocus|onLoseFocus]] The window has lost focus
[[UIWindow:onDoubleClick|onDoubleClick]] Mouse is double clicked within the window's rectangle.
[[UIWindow:onActivate|onActivate]] This happens when the GUI is activated.
[[UIWindow:onQueryToolTip|onQueryToolTip]] Used to set a tooltip which will be shown when the mouse os hovering over the window.
[[UIWindow:onNavForward|onNavForward]] Called when any key bound to the _menuNavForward is pressed
[[UIWindow:onNavBackward|onNavBackward]] Called when any key bound to the _menuNavBackward is pressed
[[UIWindow:onAccept|onAccept]] Called when any key bound to the _menuAccept is pressed
[[UIWindow:onCancel|onCancel]] Called when any key bound to the _menuCancel is pressed

[[Category:GUIs]]

UIWindow - Revision history

JRAD at 12:05, 21 November 2007