Richard Boegli's CnC_Generals_Zero_Hour Fork WIP
This is documentation of Richard Boegil's Zero Hour Fork
 
Loading...
Searching...
No Matches
LayoutScheme Class Reference

#include <LayoutScheme.h>

Public Member Functions

 LayoutScheme ()
 
 ~LayoutScheme ()
 
void init (void)
 
void openDialog (void)
 open the scheme info and editing dialog
 
char * getSchemeFilename (void)
 get the scheme filename
 
void setSchemeFilename (char *filename)
 set the scheme filename
 
Bool saveScheme (char *filename)
 save the current scheme to file
 
Bool loadScheme (char *filename)
 load the scheme file
 
ImageAndColorInfogetImageAndColor (StateIdentifier id)
 
void storeImageAndColor (StateIdentifier id, const Image *image, Color color, Color borderColor)
 
void setFont (GameFont *font)
 
GameFontgetFont (void)
 
Color getEnabledTextColor (void)
 
Color getEnabledTextBorderColor (void)
 
Color getDisabledTextColor (void)
 
Color getDisabledTextBorderColor (void)
 
Color getHiliteTextColor (void)
 
Color getHiliteTextBorderColor (void)
 
void setEnabledTextColor (Color c)
 
void setEnabledTextBorderColor (Color c)
 
void setDisabledTextColor (Color c)
 
void setDisabledTextBorderColor (Color c)
 
void setHiliteTextColor (Color c)
 
void setHiliteTextBorderColor (Color c)
 
void applyPropertyTablesToWindow (GameWindow *root)
 

Protected Member Functions

ImageAndColorInfofindEntry (StateIdentifier id)
 

Protected Attributes

char m_schemeFilename [_MAX_PATH]
 filename
 
ImageAndColorInfo m_imageAndColorTable [NUM_STATE_IDENTIFIERS]
 
TextDrawData m_enabledText
 default text colors
 
TextDrawData m_disabledText
 default text colors
 
TextDrawData m_hiliteText
 default text colors
 
GameFontm_font
 default font
 

Detailed Description

The layout scheme provides a place for default look of newly created controls and windows

Definition at line 68 of file LayoutScheme.h.

Constructor & Destructor Documentation

◆ LayoutScheme()

LayoutScheme::LayoutScheme ( void )

Definition at line 1481 of file LayoutScheme.cpp.

◆ ~LayoutScheme()

LayoutScheme::~LayoutScheme ( void )

Definition at line 1499 of file LayoutScheme.cpp.

Member Function Documentation

◆ applyPropertyTablesToWindow()

void LayoutScheme::applyPropertyTablesToWindow ( GameWindow * root)

apply the image and color info stored in the state identifer tables used for "property editing" to all appropriate windows currently loaded in the editor

Definition at line 441 of file LayoutScheme.cpp.

◆ findEntry()

ImageAndColorInfo * LayoutScheme::findEntry ( StateIdentifier id)
protected

Find the entry for the state

Definition at line 2172 of file LayoutScheme.cpp.

◆ getDisabledTextBorderColor()

Color LayoutScheme::getDisabledTextBorderColor ( void )
inline

Definition at line 134 of file LayoutScheme.h.

◆ getDisabledTextColor()

Color LayoutScheme::getDisabledTextColor ( void )
inline

Definition at line 133 of file LayoutScheme.h.

◆ getEnabledTextBorderColor()

Color LayoutScheme::getEnabledTextBorderColor ( void )
inline

Definition at line 132 of file LayoutScheme.h.

◆ getEnabledTextColor()

Color LayoutScheme::getEnabledTextColor ( void )
inline

Definition at line 131 of file LayoutScheme.h.

◆ getFont()

GameFont * LayoutScheme::getFont ( void )
inline

Definition at line 144 of file LayoutScheme.h.

◆ getHiliteTextBorderColor()

Color LayoutScheme::getHiliteTextBorderColor ( void )
inline

Definition at line 136 of file LayoutScheme.h.

◆ getHiliteTextColor()

Color LayoutScheme::getHiliteTextColor ( void )
inline

Definition at line 135 of file LayoutScheme.h.

◆ getImageAndColor()

ImageAndColorInfo * LayoutScheme::getImageAndColor ( StateIdentifier id)

Get the color and color info for the state

Definition at line 2201 of file LayoutScheme.cpp.

◆ getSchemeFilename()

char * LayoutScheme::getSchemeFilename ( void )
inline

get the scheme filename

Definition at line 129 of file LayoutScheme.h.

◆ init()

void LayoutScheme::init ( void )

Init

Definition at line 1522 of file LayoutScheme.cpp.

◆ loadScheme()

Bool LayoutScheme::loadScheme ( char * filename)

load the scheme file

Load the layout scheme into this class instance

Definition at line 2334 of file LayoutScheme.cpp.

◆ openDialog()

void LayoutScheme::openDialog ( void )

open the scheme info and editing dialog

Bring up the layout scheme dialog box

Definition at line 2155 of file LayoutScheme.cpp.

◆ saveScheme()

Bool LayoutScheme::saveScheme ( char * filename)

save the current scheme to file

Save the scheme to the filename provided

Definition at line 2252 of file LayoutScheme.cpp.

◆ setDisabledTextBorderColor()

void LayoutScheme::setDisabledTextBorderColor ( Color c)
inline

Definition at line 140 of file LayoutScheme.h.

◆ setDisabledTextColor()

void LayoutScheme::setDisabledTextColor ( Color c)
inline

Definition at line 139 of file LayoutScheme.h.

◆ setEnabledTextBorderColor()

void LayoutScheme::setEnabledTextBorderColor ( Color c)
inline

Definition at line 138 of file LayoutScheme.h.

◆ setEnabledTextColor()

void LayoutScheme::setEnabledTextColor ( Color c)
inline

Definition at line 137 of file LayoutScheme.h.

◆ setFont()

void LayoutScheme::setFont ( GameFont * font)
inline

Definition at line 143 of file LayoutScheme.h.

◆ setHiliteTextBorderColor()

void LayoutScheme::setHiliteTextBorderColor ( Color c)
inline

Definition at line 142 of file LayoutScheme.h.

◆ setHiliteTextColor()

void LayoutScheme::setHiliteTextColor ( Color c)
inline

Definition at line 141 of file LayoutScheme.h.

◆ setSchemeFilename()

void LayoutScheme::setSchemeFilename ( char * filename)
inline

set the scheme filename

Definition at line 130 of file LayoutScheme.h.

◆ storeImageAndColor()

void LayoutScheme::storeImageAndColor ( StateIdentifier id,
const Image * image,
Color color,
Color borderColor )

Store the image and colors of the specific state in our own data array

Definition at line 2222 of file LayoutScheme.cpp.

Member Data Documentation

◆ m_disabledText

TextDrawData LayoutScheme::m_disabledText
protected

default text colors

Definition at line 119 of file LayoutScheme.h.

◆ m_enabledText

TextDrawData LayoutScheme::m_enabledText
protected

default text colors

Definition at line 118 of file LayoutScheme.h.

◆ m_font

GameFont* LayoutScheme::m_font
protected

default font

Definition at line 122 of file LayoutScheme.h.

◆ m_hiliteText

TextDrawData LayoutScheme::m_hiliteText
protected

default text colors

Definition at line 120 of file LayoutScheme.h.

◆ m_imageAndColorTable

ImageAndColorInfo LayoutScheme::m_imageAndColorTable[NUM_STATE_IDENTIFIERS]
protected

Definition at line 117 of file LayoutScheme.h.

◆ m_schemeFilename

char LayoutScheme::m_schemeFilename[_MAX_PATH]
protected

filename

Definition at line 115 of file LayoutScheme.h.


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