#include <Edit.h>

Inheritance diagram for SallyAPI::GUI::CEdit:

Public Member Functions
	CEdit (SallyAPI::GUI::CGUIBaseObject *parent, int x, int y, int width, int controlId=0)
	Constructor.
virtual	~CEdit ()
	Destructor.
virtual void	SetText (const std::string &text)
	Sets a text.
void	SetInfoText (const std::string &text)
	Sets an information text.
std::string	GetInfoText ()
	Gets the information text.
void	SetImageLeft ()
	Sets the image left.
void	SetImageRight ()
	Sets the image right.
void	SetImageId (int image)
	Sets an image identifier.
void	SetNumberOnly (bool value)
	Sets a number only.
bool	GetNumberOnly ()
	Gets the number only.
void	SetPassword (bool value)
	Sets a password.
bool	GetPassword ()
	Gets the password.
void	SetEnableKeyboardBrainHistory (bool value)
	Sets an enable keyboard brain history.
bool	GetEnableKeyboardBrainHistory ()
	Gets the enable keyboard brain history.
void	SetEnableKeyboardBrainWordList (bool value)
	Sets an enable keyboard brain word list.
bool	GetEnableKeyboardBrainWordList ()
	Gets the enable keyboard brain word list.
void	SetEnableKeyboardWordRequest (bool value)
	Sets an enable enable keyboard word request.
bool	GetEnableKeyboardWordRequest ()
	Gets the enable enable keyboard word request.
void	SetKeyboardInputEnabled (bool value)
	Sets a keyboard input enabled.
bool	GetKeyboardInputEnabled ()
	Gets the keyboard input enabled.
void	SetMaxCharacterInputLength (int value)
	Sets a maximum character input length.
int	GetMaxCharacterInputLength ()
	Gets the maximum character input length.
void	SetCharacterInputType (EditCharacterInputType value)
	Sets a character input type.
EditCharacterInputType	GetCharacterInputType ()
	Gets the character input type.
Protected Member Functions
virtual void	RenderControl ()
	Renders a control.
virtual bool	ProcessMouseUp (int x, int y)
	Process a mouse up.
Protected Attributes
int	m_iImage
int	m_iImageSize
bool	m_bImageLeft
bool	m_bNumberOnly
bool	m_bPassword
bool	m_bKeyboardInputEnabled
int	m_iMaxCharacterInputLength
bool	m_bEnableKeyboardBrainHistory
bool	m_bEnableKeyboardBrainWordList
bool	m_bEnableKeyboardWordRequest
EditCharacterInputType	m_eCharacterInputType
std::string	m_strInfoText

Detailed Description

Edit.

Author:: Christian Knobloch

Date:: 19.04.2010

Constructor & Destructor Documentation

CEdit::CEdit	(	SallyAPI::GUI::CGUIBaseObject *	parent,
		int	x,
		int	y,
		int	width,
		int	controlId = `0`
	)

Constructor.

m_iImage(NULL), m_iImageSize(16), m_bImageLeft(true), m_bNumberOnly(false), m_bPassword(false), m_bKeyboardInputEnabled(true), m_iMaxCharacterInputLength(-1), m_eCharacterInputType(EDIT_CHARACTER_INPUT_TYPE_NONE), m_bEnableKeyboardBrainWordList(true), m_bEnableKeyboardBrainHistory(true), m_bEnableKeyboardWordRequest(false)

Author:: Christian Knobloch

Date:: 08.07.2011

Parameters:

[in,out]	parent	If non-null, the parent.
	x	The x coordinate.
	y	The y coordinate.
	width	The width.
	controlId	Identifier for the control.

CEdit::~CEdit ( ) [virtual]

Destructor.

Author:: Christian Knobloch

Date:: 19.04.2010

Member Function Documentation

EditCharacterInputType CEdit::GetCharacterInputType ( )

Gets the character input type.

Author:: Christian Knobloch

Date:: 19.04.2010

Returns:: The character input type.

bool CEdit::GetEnableKeyboardBrainHistory ( )

Gets the enable keyboard brain history.

Author:: Christian Knobloch

Date:: 08.07.2011

Returns:: true if it succeeds, false if it fails.

bool CEdit::GetEnableKeyboardBrainWordList ( )

Gets the enable keyboard brain word list.

Author:: Christian Knobloch

Date:: 08.07.2011

Returns:: true if it succeeds, false if it fails.

bool CEdit::GetEnableKeyboardWordRequest ( )

Gets the enable enable keyboard word request.

Author:: Christian Knobloch

Date:: 08.07.2011

Returns:: true if it succeeds, false if it fails.

std::string CEdit::GetInfoText ( )

Gets the information text.

Author:: Christian Knobloch

Date:: 19.04.2010

Returns:: The information text.

bool CEdit::GetKeyboardInputEnabled ( )

Gets the keyboard input enabled.

Author:: Christian Knobloch

Date:: 19.04.2010

Returns:: true if it succeeds, false if it fails.

int CEdit::GetMaxCharacterInputLength ( )

Gets the maximum character input length.

Author:: Christian Knobloch

Date:: 19.04.2010

Returns:: The maximum character input length.

bool CEdit::GetNumberOnly ( )

Gets the number only.

Author:: Christian Knobloch

Date:: 19.04.2010

Returns:: true if it succeeds, false if it fails.

bool CEdit::GetPassword ( )

Gets the password.

Author:: Christian Knobloch

Date:: 19.04.2010

Returns:: true if it succeeds, false if it fails.

bool CEdit::ProcessMouseUp	(	int	x,
		int	y
	)		`[protected, virtual]`

Process a mouse up.

Author:: Christian Knobloch

Date:: 19.04.2010

Parameters:

x	The x coordinate.
y	The y coordinate.

Returns:: true if it succeeds, false if it fails.

Reimplemented from SallyAPI::GUI::CControl.

void CEdit::RenderControl ( ) [protected, virtual]

Renders a control.

Author:: Christian Knobloch

Date:: 19.04.2010

Implements SallyAPI::GUI::CGUIBaseObject.

void CEdit::SetCharacterInputType ( EditCharacterInputType value )

Sets a character input type.

Author:: Christian Knobloch

Date:: 19.04.2010

Parameters:

value The value.

void CEdit::SetEnableKeyboardBrainHistory ( bool value )

Sets an enable keyboard brain history.

Author:: Christian Knobloch

Date:: 08.07.2011

Parameters:

value true to value.

void CEdit::SetEnableKeyboardBrainWordList ( bool value )

Sets an enable keyboard brain word list.

Author:: Christian Knobloch

Date:: 08.07.2011

Parameters:

value true to value.

void CEdit::SetEnableKeyboardWordRequest ( bool value )

Sets an enable enable keyboard word request.

Author:: Christian Knobloch

Date:: 08.07.2011

Parameters:

value true to value.

void CEdit::SetImageId ( int image )

Sets an image identifier.

Author:: Christian Knobloch

Date:: 19.04.2010

Parameters:

image The image.

void CEdit::SetImageLeft ( )

Sets the image left.

Author:: Christian Knobloch

Date:: 19.04.2010

void CEdit::SetImageRight ( )

Sets the image right.

Author:: Christian Knobloch

Date:: 19.04.2010

void CEdit::SetInfoText ( const std::string & text )

Sets an information text.

Author:: Christian Knobloch

Date:: 19.04.2010

Parameters:

text The text.

void CEdit::SetKeyboardInputEnabled ( bool value )

Sets a keyboard input enabled.

Author:: Christian Knobloch

Date:: 19.04.2010

Parameters:

value true to value.

void CEdit::SetMaxCharacterInputLength ( int value )

Sets a maximum character input length.

Author:: Christian Knobloch

Date:: 19.04.2010

Parameters:

value The value.

void CEdit::SetNumberOnly ( bool value )

Sets a number only.

Author:: Christian Knobloch

Date:: 19.04.2010

Parameters:

value true to value.

void CEdit::SetPassword ( bool value )

Sets a password.

Author:: Christian Knobloch

Date:: 19.04.2010

Parameters:

value true to value.

void CEdit::SetText ( const std::string & text ) [virtual]

Sets a text.

Author:: Christian Knobloch

Date:: 19.04.2010

Parameters:

text The text.

Reimplemented from SallyAPI::GUI::CControl.

Member Data Documentation

bool SallyAPI::GUI::CEdit::m_bEnableKeyboardBrainHistory [protected]

bool SallyAPI::GUI::CEdit::m_bEnableKeyboardBrainWordList [protected]

bool SallyAPI::GUI::CEdit::m_bEnableKeyboardWordRequest [protected]

bool SallyAPI::GUI::CEdit::m_bImageLeft [protected]

bool SallyAPI::GUI::CEdit::m_bKeyboardInputEnabled [protected]

bool SallyAPI::GUI::CEdit::m_bNumberOnly [protected]

bool SallyAPI::GUI::CEdit::m_bPassword [protected]

EditCharacterInputType SallyAPI::GUI::CEdit::m_eCharacterInputType [protected]

int SallyAPI::GUI::CEdit::m_iImage [protected]

int SallyAPI::GUI::CEdit::m_iImageSize [protected]

int SallyAPI::GUI::CEdit::m_iMaxCharacterInputLength [protected]

std::string SallyAPI::GUI::CEdit::m_strInfoText [protected]

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

D:/source/c++/Programme/sally/sally/sallyAPI/Edit.h
D:/source/c++/Programme/sally/sally/sallyAPI/Edit.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation