Recent Changes - Search:

Documentation

Help

Tutorials

RoadMap

Help Docs for wiki writers:

PmWiki

edit SideBar

CreateTextBox

textBox * CreateTextBox(
std::string _Name,
int _x,
int _y,
int _z,
std::string _TextBoxMessage,
std::string _AddtoCurrentRenderlist,
unsigned int _height,
unsigned int _width,
std::string _Font,
int _FontPoint,
unsigned int _red,
unsigned int _blue,
unsigned int _green,
std::string _FontPath
)

Public function of the Epee Engine Class

Description:
Creates a textbox and adds it to the rendable list _AddtoCurrentRenderlist

Arguments:

Required:

std::string _Name
Name of textbox

int _x
x location of the text box

int _y
y location of the text box

int _z
z location of the text box

Optional:

std::string _TextBoxMessage
text to display in the text box
defaults to " "

std::string _AddtoCurrentRenderlist
render list to add the textbox to
defaults to "Current" the current active render list

unsigned int _height
the clipping height of the textbox
defaults to -1 the height is set to the height of _TextBoxMessage

unsigned int _width
the clipping width of the textbox
defaults to -1 the width is set to the width of _TextBoxMessage

std::string _Font
file name of the true type font
defaults to True_Type_Font_Defalut
True_Type_Font_Defalut:
Windows
"ARIAL.TTF"
Macintosh
"Chalkboard.ttf"
Linux
currently not defined. This will change once I get my Linux box up

int _FontPoint
font size for _Font
defaults to 18

unsigned int _red
foreground red color
defaults to 255

unsigned int _blue
foreground blue color
defaults to 255

unsigned int _green
foreground green color
defaults to 255

std::string _FontPath
location of _Font
defaults to True_Type_Font_Location
True_Type_Font_Location:
Windows:
"C:\\WINDOWS\\Fonts\\"
Macintosh:
"/Library/Fonts/"
Linux:
currently not defined. This will change once I get my Linux box up

Return Value:
if successful returns a pointer to the newly created textbox, otherwise returns a NULL pointer

Edit - History - Print - Recent Changes - Search
Page last modified on April 09, 2007, at 01:26 PM