nw::lyt::TextBox Class

Syntax

class TextBox : public nw::lyt::Pane

Description

Pane for displaying text.

typedef Definitions

TagProcessor Definition of the tag processor used by the TextBox.

Member Variables

NW_UT_RUNTIME_TYPEINFO Runtime type information.

Member Functions

Constructors and Destructors
TextBox Constructor.
V ~TextBox Destructor.
String Operations
GetString Gets the text string being stored.
GetStringBuffer Gets the text buffer.
GetStringLength Gets the number of characters in the text string being stored.
GetStringBufferLength Gets the number of characters that can be stored within the text buffer.
V AllocStringBuffer Allocates the text buffer.
V FreeStringBuffer Deallocates the text buffer.
V SetString Stores a text string in the text buffer.
Set/Get
GetTextColor Gets the text display color.
SetTextColor Sets the text display color.
GetFont Gets the text font.
SetFont Sets the text font.
GetFontSize Gets the text font size.
SetFontSize Sets the text font size.
GetLineSpace Gets the text line spacing.
SetLineSpace Sets the text line spacing.
GetCharSpace Gets the character spacing.
SetCharSpace Sets the text character spacing.
GetTextPositionH Gets the horizontal position specification for the standard text display position settings.
SetTextPositionH Sets the horizontal position specification for the text display standard position settings.
GetTextPositionV Gets the vertical position specification for the standard text display position settings.
SetTextPositionV Sets the vertical position specification for the text display standard position settings.
GetTextAlignment Gets the alignment specification.
SetTextAlignment Sets the alignment specification.
GetTagProcessor Gets the tag processor.
SetTagProcessor Sets the tag processor.
V GetVtxColor Gets the text display (vertex) color.
V SetVtxColor Sets the text display (vertex) color.
V GetVtxColorElement Gets text display color (vertex color) components.
V SetVtxColorElement Sets text display (vertex) color components.
UpdateDrawCharData Creates data for drawing text.(For the Drawer::Draw function.)
GetTextDrawRect Gets the rectangle in which text will be rendered.
V GetMaterialNum Gets the number of materials held by the pane.
V GetMaterial Gets the pane's material.
SetMaterial Sets a material.
Set/Get
GetName Gets the name of the pane.(Inherited from Pane.)
SetName Sets the name of the pane.(Inherited from Pane.)
GetUserData Gets the user information.(Inherited from Pane.)
SetUserData Sets the user information.(Inherited from Pane.)
IsInfluencedAlpha Determines whether changes to the parent alpha impact the child.(Inherited from Pane.)
SetInfluencedAlpha Sets whether changes to the parent alpha value impact the child.(Inherited from Pane.)
IsLocationAdjust Determines whether position adjustment processing is applied to the pane.(Inherited from Pane.)
SetLocationAdjust Sets whether position adjustment processing is applied.(Inherited from Pane.)
GetTranslate Gets the pane's display position.(Inherited from Pane.)
SetTranslate Sets the pane's display position.(Inherited from Pane.)
GetRotate Gets the pane's rotation.(Inherited from Pane.)
SetRotate Sets the pane's rotation.(Inherited from Pane.)
GetScale Gets the pane's scale ratio.(Inherited from Pane.)
SetScale Sets the pane's scale ratio.(Inherited from Pane.)
GetSize Gets the size of the pane.(Inherited from Pane.)
SetSize Sets the size of the pane.(Inherited from Pane.)
GetBasePositionH Gets the horizontal position specification for the pane standard position settings.(Inherited from Pane.)
SetBasePositionH Sets the horizontal position specification for the pane standard position settings.(Inherited from Pane.)
GetBasePositionV Gets the vertical position specification for the pane standard position settings.(Inherited from Pane.)
SetBasePositionV Sets the vertical position specification for the pane standard position settings.(Inherited from Pane.)
GetMtx Gets the pane's SRT matrix.(Inherited from Pane.)
SetMtx Sets the pane's SRT matrix.(Inherited from Pane.)
IsUserMtx Checks if the pane SRT matrix has been set by the user.(Inherited from Pane.)
ResetMtx Cancels the SRT matrix settings.(Inherited from Pane.)
GetGlobalMtx Gets the SRT matrix after calculation in the hierarchy.(Inherited from Pane.)
SetGlobalMtx Sets the global matrix.(Inherited from Pane.)
IsUserGlobalMtx Checks if the global matrix has been set by the user.(Inherited from Pane.)
ResetGlobalMtx Cancels the global matrix settings.(Inherited from Pane.)
GetPaneRect Gets a rectangle in the pane's local coordinates.(Inherited from Pane.)
GetAlpha Gets the pane's alpha value.(Inherited from Pane.)
SetAlpha Sets the pane's alpha value.(Inherited from Pane.)
GetGlobalAlpha Gets the pane's global alpha value.(Inherited from Pane.)
SetGlobalAlpha Sets the pane's global alpha value.(Inherited from Pane.)
GetSRTElement Specifies an index to get a pane's SRT elements.(Inherited from Pane.)
SetSRTElement Specifies an index to set a pane's SRT elements.(Inherited from Pane.)
V GetColorElement Gets the pane's alpha value or vertex color components.
V SetColorElement Sets the pane's alpha value or vertex color components.
GetMaterial Gets the pane's material.
GetExtUserDataNum Gets the amount of extended user data.(Inherited from Pane.)
GetExtUserDataArray Gets the extended user data array.(Inherited from Pane.)
FindExtUserDataByName Searches for extended user data by name.(Inherited from Pane.)
Parent-Child Relationships
GetParent Gets the parent pane.(Inherited from Pane.)
GetChildList Gets a list of child panes.(Inherited from Pane.)
AppendChild Adds a pane to the end of the child pane list.(Inherited from Pane.)
PrependChild Adds a pane to the start of the child pane list.(Inherited from Pane.)
InsertChild Inserts a child pane at the specified position.(Inherited from Pane.)
RemoveChild Removes a pane from the child pane list.(Inherited from Pane.)
Search
V FindPaneByName Searches for panes by name.
V FindMaterialByName Searches for materials by name.
Animation
V Animate Calculates animation results for both self and for the children.
V AnimateSelf Calculates the animation result for self.
GetAnimationList Gets a list of bound animations.(Inherited from Pane.)
V BindAnimation Binds animations.
V UnbindAnimation Clears a bound animation.
V UnbindAllAnimation Clears all bound animations.
V UnbindAnimationSelf Unbinds the animations bound to the local item.
AddAnimationLink Adds animation link information.(Inherited from Pane.)
V FindAnimationLinkSelf Searches for animation link information.
V SetAnimationEnable Sets the animation enable/disable state.
Rendering
IsVisible Determines whether a pane is displayed.(Inherited from Pane.)
SetVisible Toggles pane display.(Inherited from Pane.)
V CalculateMtx Calculates the matrix for rendering.
Other
IsUserAllocated Determines whether the user constructed the pane.(Inherited from Pane.)
SetUserAllocated Declares that the pane was constructed by the user.(Inherited from Pane.)
SetExtUserDataList Sets the extended user data list.(Inherited from Pane.)
V Draw Draws its own pane and child panes.
SetMtxDirty Requests SRT matrix recalculation.(Inherited from Pane.)
protected V DrawSelf Performs the self-rendering process.
protected V LoadMtx Calculates a model view matrix and sets it in GraphicsResource.
protected GetVtxPos Gets the pane's upper left coordinate.(Inherited from Pane.)
protected GetMtxCondition Gets the local matrix status.(Inherited from Pane.)
protected SetMtxCondition Sets the local matrix status.(Inherited from Pane.)

Class Hierarchy

nw::lyt::internal::PaneBase
  nw::lyt::Pane
    nw::lyt::TextBox

Revision History

2009/09/18
Initial version.

CONFIDENTIAL