Richard Boegli's CnC_Generals_Zero_Hour Fork WIP
This is documentation of Richard Boegil's Zero Hour Fork
 
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
WinInstanceData Class Reference

#include <WinInstanceData.h>

Public Member Functions

 WinInstanceData (void)
 constructor automatically runs init()
 
virtual ~WinInstanceData (void)
 
void init (void)
 initialize default values if desired
 
void setTooltipText (UnicodeString tip)
 set tooltip text
 
void setText (UnicodeString text)
 set instance text text
 
UnicodeString getTooltipText (void)
 get tooltip text
 
UnicodeString getText (void)
 get instance text
 
Int getTextLength (void)
 get number of chars in instance text
 
Int getTooltipTextLength (void)
 get number of chars in tooltip text
 
UnsignedInt getStyle (void)
 return window style
 
UnsignedInt getStatus (void)
 return widnow status
 
UnsignedInt getState (void)
 return window state
 
GameWindow * getOwner (void)
 return window owner
 
GameFont * getFont (void)
 return window font
 
DisplayString * getTextDisplayString (void)
 return the text display string
 
DisplayString * getTooltipDisplayString (void)
 return the tooltip display string
 
void setVideoBuffer (VideoBuffer *videoBuffer)
 set the videobuffer to display a video frame
 

Public Attributes

Int m_id
 
Int m_state
 
UnsignedInt m_style
 
UnsignedInt m_status
 
GameWindow * m_owner
 
WinDrawData m_enabledDrawData [MAX_DRAW_DATA]
 image/color info for enabled state
 
WinDrawData m_disabledDrawData [MAX_DRAW_DATA]
 image/color info for disabled state
 
WinDrawData m_hiliteDrawData [MAX_DRAW_DATA]
 image/color info for hilite state
 
TextDrawData m_enabledText
 enabled text colors
 
TextDrawData m_disabledText
 disabled text colors
 
TextDrawData m_hiliteText
 hilite text colors
 
TextDrawData m_imeCompositeText
 IME composite text colors.
 
ICoord2D m_imageOffset
 
GameFont * m_font
 
AsciiString m_textLabelString
 text label from window file if present
 
AsciiString m_decoratedNameString
 window text name from GUIEdit
 
AsciiString m_tooltipString
 tooltip Label from window file if present
 
AsciiString m_headerTemplateName
 name of the template we're going to base our font off of.
 
Int m_tooltipDelay
 desired delay before showing tooltip
 
DisplayString * m_text
 generic text for any window to display
 
DisplayString * m_tooltip
 tooltip for display
 
VideoBuffer * m_videoBuffer
 Each window can be made to play a video in it.
 

Detailed Description

Definition at line 101 of file WinInstanceData.h.

Constructor & Destructor Documentation

◆ WinInstanceData()

WinInstanceData::WinInstanceData ( void )

constructor automatically runs init()

Definition at line 73 of file WinInstanceData.cpp.

◆ ~WinInstanceData()

WinInstanceData::~WinInstanceData ( void )
virtual

Definition at line 86 of file WinInstanceData.cpp.

Member Function Documentation

◆ getFont()

GameFont * WinInstanceData::getFont ( void )
inline

return window font

Definition at line 189 of file WinInstanceData.h.

◆ getOwner()

GameWindow * WinInstanceData::getOwner ( void )
inline

return window owner

Definition at line 188 of file WinInstanceData.h.

◆ getState()

UnsignedInt WinInstanceData::getState ( void )
inline

return window state

Definition at line 187 of file WinInstanceData.h.

◆ getStatus()

UnsignedInt WinInstanceData::getStatus ( void )
inline

return widnow status

Definition at line 186 of file WinInstanceData.h.

◆ getStyle()

UnsignedInt WinInstanceData::getStyle ( void )
inline

return window style

Definition at line 185 of file WinInstanceData.h.

◆ getText()

UnicodeString WinInstanceData::getText ( void )
inline

get instance text

Definition at line 199 of file WinInstanceData.h.

◆ getTextDisplayString()

DisplayString * WinInstanceData::getTextDisplayString ( void )
inline

return the text display string

Definition at line 190 of file WinInstanceData.h.

◆ getTextLength()

Int WinInstanceData::getTextLength ( void )
inline

get number of chars in instance text

Definition at line 205 of file WinInstanceData.h.

◆ getTooltipDisplayString()

DisplayString * WinInstanceData::getTooltipDisplayString ( void )
inline

return the tooltip display string

Definition at line 191 of file WinInstanceData.h.

◆ getTooltipText()

UnicodeString WinInstanceData::getTooltipText ( void )
inline

get tooltip text

Definition at line 192 of file WinInstanceData.h.

◆ getTooltipTextLength()

Int WinInstanceData::getTooltipTextLength ( void )
inline

get number of chars in tooltip text

Definition at line 211 of file WinInstanceData.h.

◆ init()

void WinInstanceData::init ( void )

initialize default values if desired

Set initial values for instance data if desired

< default value

Definition at line 102 of file WinInstanceData.cpp.

◆ setText()

void WinInstanceData::setText ( UnicodeString text)

set instance text text

Set the text for this window instance data

Definition at line 185 of file WinInstanceData.cpp.

◆ setTooltipText()

void WinInstanceData::setTooltipText ( UnicodeString tip)

set tooltip text

Definition at line 169 of file WinInstanceData.cpp.

◆ setVideoBuffer()

void WinInstanceData::setVideoBuffer ( VideoBuffer * videoBuffer)

set the videobuffer to display a video frame

Set the text for this window instance data

Definition at line 201 of file WinInstanceData.cpp.

Member Data Documentation

◆ m_decoratedNameString

AsciiString WinInstanceData::m_decoratedNameString

window text name from GUIEdit

Definition at line 161 of file WinInstanceData.h.

◆ m_disabledDrawData

WinDrawData WinInstanceData::m_disabledDrawData[MAX_DRAW_DATA]

image/color info for disabled state

Definition at line 148 of file WinInstanceData.h.

◆ m_disabledText

TextDrawData WinInstanceData::m_disabledText

disabled text colors

Definition at line 152 of file WinInstanceData.h.

◆ m_enabledDrawData

WinDrawData WinInstanceData::m_enabledDrawData[MAX_DRAW_DATA]

image/color info for enabled state

Definition at line 147 of file WinInstanceData.h.

◆ m_enabledText

TextDrawData WinInstanceData::m_enabledText

enabled text colors

Definition at line 151 of file WinInstanceData.h.

◆ m_font

GameFont* WinInstanceData::m_font

Definition at line 158 of file WinInstanceData.h.

◆ m_headerTemplateName

AsciiString WinInstanceData::m_headerTemplateName

name of the template we're going to base our font off of.

Definition at line 164 of file WinInstanceData.h.

◆ m_hiliteDrawData

WinDrawData WinInstanceData::m_hiliteDrawData[MAX_DRAW_DATA]

image/color info for hilite state

Definition at line 149 of file WinInstanceData.h.

◆ m_hiliteText

TextDrawData WinInstanceData::m_hiliteText

hilite text colors

Definition at line 153 of file WinInstanceData.h.

◆ m_id

Int WinInstanceData::m_id
Todo
you may want to make these data members protected, they are public because of the legacy of porting all this code in from Nox, but they really should be protected and have the rest of the code use access functions to edit them

Definition at line 141 of file WinInstanceData.h.

◆ m_imageOffset

ICoord2D WinInstanceData::m_imageOffset

Definition at line 156 of file WinInstanceData.h.

◆ m_imeCompositeText

TextDrawData WinInstanceData::m_imeCompositeText

IME composite text colors.

Definition at line 154 of file WinInstanceData.h.

◆ m_owner

GameWindow* WinInstanceData::m_owner

Definition at line 145 of file WinInstanceData.h.

◆ m_state

Int WinInstanceData::m_state

Definition at line 142 of file WinInstanceData.h.

◆ m_status

UnsignedInt WinInstanceData::m_status

Definition at line 144 of file WinInstanceData.h.

◆ m_style

UnsignedInt WinInstanceData::m_style

Definition at line 143 of file WinInstanceData.h.

◆ m_text

DisplayString* WinInstanceData::m_text

generic text for any window to display

Definition at line 168 of file WinInstanceData.h.

◆ m_textLabelString

AsciiString WinInstanceData::m_textLabelString

text label from window file if present

Definition at line 160 of file WinInstanceData.h.

◆ m_tooltip

DisplayString* WinInstanceData::m_tooltip

tooltip for display

Definition at line 169 of file WinInstanceData.h.

◆ m_tooltipDelay

Int WinInstanceData::m_tooltipDelay

desired delay before showing tooltip

Definition at line 166 of file WinInstanceData.h.

◆ m_tooltipString

AsciiString WinInstanceData::m_tooltipString

tooltip Label from window file if present

Definition at line 162 of file WinInstanceData.h.

◆ m_videoBuffer

VideoBuffer* WinInstanceData::m_videoBuffer

Each window can be made to play a video in it.

Definition at line 172 of file WinInstanceData.h.

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