Eaagles::BasicGL::LcField Class Reference

Inherits Eaagles::BasicGL::LcGraphic.

Inheritance diagram for Eaagles::BasicGL::LcField:

[legend]Collaboration diagram for Eaagles::BasicGL::LcField:

[legend]List of all members.

Public Types
enum	Mode {   display, input, INACTIVE, ACTIVE,   KILLED, CRASHED, DETONATED, LAUNCHED,   PRERELEASE, DELETE_REQUEST }
enum	{   highlight = 0x0001, underline = 0x0002, reversed = 0x0004, special = 0x0008,   vertical = 0x0010, brackets = 0x0020, highlight1 = 0x1001, underline1 = 0x1002,   reversed1 = 0x1004, special1 = 0x1008, vertical1 = 0x1010, brackets1 = 0x1020 }
Public Member Functions
	LcField ()
	operator char * ()
	operator const char * () const
virtual int	line (const int ll)
virtual int	line () const
virtual int	column (const int cc)
virtual int	column () const
size_t	width () const
size_t	width (const size_t t)
Mode	getMode () const
Mode	setMode (const Mode newMode)
bool	isHighLighted () const
bool	isUnderlined () const
bool	isReversed () const
bool	isSpecial () const
bool	isVertical () const
bool	areBracketsOn () const
bool	isDisplayMode (const int t) const
void	setDisplayMode (const int t)
void	clearDisplayMode (const int t)
void	clearAllDisplayModes ()
Basic::LcString::Justify	justification () const
Basic::LcString::Justify	justification (const Basic::LcString::Justify t)
virtual bool	setPosition (const Basic::LcList *const spobj)
virtual bool	withinField (const int ln, const int cp) const
virtual void	setText (const char newString[])
virtual int	setExample (const char *const example)
virtual char	getChar ()
virtual void	setChar (const char c)
virtual void	backSpace (const int ns=1)
virtual void	advanceSpace (const int ns=1)
virtual bool	onForwardSpace ()
virtual bool	onBackSpace ()
virtual char	filterInputEvent (const int event, const int tc)
virtual bool	isValidInputPosition (const int tc)
virtual LCreal	getInputValue () const
virtual bool	isInputValueValid () const
int	getInputCharacterPosition () const
bool	isLinked () const
void	setLinked (const bool f)
bool	isInheritColor () const
bool	setInheritColor (const bool i)
virtual bool	cursor (int *ln, int *cp) const
virtual bool	onSetLine (const Basic::LcNumber *const oslobj)
virtual bool	onSetColumn (const Basic::LcNumber *const oscobj)
virtual void	drawFunc ()
virtual bool	event (const int event, LcObject *const obj=0)
virtual void	updateData (const LCreal dt=0.0)
Protected Member Functions
virtual bool	setSlotWidth (const Basic::LcNumber *const swobj)
virtual bool	setSlotHighlight (const Basic::LcNumber *const shobj)
virtual bool	setSlotUnderline (const Basic::LcNumber *const suobj)
virtual bool	setSlotReversed (const Basic::LcNumber *const srobj)
virtual bool	setSlotJustification (const Basic::LcString *const sjobj)
virtual bool	setSlotSpecial (const Basic::LcNumber *const ssobj)
virtual bool	setSlotVertical (const Basic::LcNumber *const ssobj)
virtual bool	setSlotBrackets (const Basic::LcNumber *const obj)
virtual bool	setSlotLinked (const Basic::LcNumber *const msg)
virtual bool	setSlotInheritColor (const Basic::LcNumber *const ic)
Protected Attributes
Basic::LcString	origStr
Basic::LcString	inputExample
Basic::LcString	str
Mode	mode
int	icp
int	inpDspMode
bool	inpModeHold
Private Member Functions
void	adjust ()
Private Attributes
int	ln
int	cp
size_t	w
bool	linked
int	dmode
Basic::LcString::Justify	jmode
bool	inheritColor

---

Detailed Description

 Abstract Field class (not in the formFunc())

    Form name: Field
    Slots:
         position       


position ( Line Column )
         width          <Number> Field width
         highLight      <Number> Highlight text flag
         underline      <Number> Underlined text flag
         reversed       <Number> Reversed video flag
         special        <Number> Special character set flag
         justification  <String> "none", "left", "center", or "right"
         vertical       <Number> vertical field flag (text displayed vertically)
         brackets       <Number> Bracket the field with a character just left and right of this field. (see also LcDisplay)
         linked         <Number> Linked flag (auto step to next input field)
         inheritColor   <Number> inherit color of our container
    

---

Member Enumeration Documentation

enum Eaagles::BasicGL::LcField::Mode

Enumerator:

display
input
INACTIVE	Player is not being updated or sent to the networks.
ACTIVE	Player is being updated and sent to the networks.
KILLED	Player was killed (One of the dead conditions, which are still sent to the networks).
CRASHED	Player crashed (One of the dead conditions, which are still sent to the networks).
DETONATED	Flyout weapon player has detonated (Weapons only) (One of the dead conditions, which are still sent to the networks).
LAUNCHED	Template weapon has been launched (Weapons only) (not updated or sent to the networks).
PRERELEASE	Flyout weapon is being released (Weapons only) (not updated or sent to the networks).
DELETE_REQUEST	Request player removal from active list.

anonymous enum

Enumerator:

highlight	display modes
underline
reversed
special
vertical
brackets
highlight1	Internal use: display mode was set by the setSlotXXXX().
underline1
reversed1
special1
vertical1
brackets1

---

Constructor & Destructor Documentation

Eaagles::BasicGL::LcField::LcField

(

)

Constructor. Initializes the line this field is on, the starting character position of the field, width etc.

---

Member Function Documentation

Eaagles::BasicGL::LcField::operator char *

(

)

[inline]

Conversion function to allow str to be returned as a char*.

Eaagles::BasicGL::LcField::operator const char *

(

)

const [inline]

Conversion function to allow str to be returned as a char*.

int Eaagles::BasicGL::LcField::line

(

const int

ll

)

[virtual]

Sets the line number to ll.

int Eaagles::BasicGL::LcField::line

(

)

const [virtual]

Returns the current line number.

int Eaagles::BasicGL::LcField::column

(

const int

cc

)

[virtual]

Sets the column number to cc.

int Eaagles::BasicGL::LcField::column

(

)

const [virtual]

Returns the current column number.

size_t Eaagles::BasicGL::LcField::width

(

)

const [inline]

Returns the field width.

size_t Eaagles::BasicGL::LcField::width

(

const size_t

t

)

[inline]

Sets and returns the field width to size t.

Mode Eaagles::BasicGL::LcField::getMode

(

)

const [inline]

Returns the mode of the field.

LcField::Mode Eaagles::BasicGL::LcField::setMode

(

const Mode

newMode

)

Sets the mode to newMode and returns it.

bool Eaagles::BasicGL::LcField::isHighLighted

(

)

const [inline]

Returns true if field is highlighted.

bool Eaagles::BasicGL::LcField::isUnderlined

(

)

const [inline]

Returns true if field is underlined.

bool Eaagles::BasicGL::LcField::isReversed

(

)

const [inline]

Returns true if field is reversed.

bool Eaagles::BasicGL::LcField::isSpecial

(

)

const [inline]

Returns true if field is special.

bool Eaagles::BasicGL::LcField::isVertical

(

)

const [inline]

Returns true if field is vertical.

bool Eaagles::BasicGL::LcField::areBracketsOn

(

)

const [inline]

Returns true if brackets are on.

bool Eaagles::BasicGL::LcField::isDisplayMode

(

const int

t

)

const [inline]

Returns true if display mode is equal to t.

void Eaagles::BasicGL::LcField::setDisplayMode

(

const int

t

)

[inline]

Adds display mode t to the current display mode. (combination, not addition).

void Eaagles::BasicGL::LcField::clearDisplayMode

(

const int

t

)

[inline]

Removes display mode t from the current display mode.

void Eaagles::BasicGL::LcField::clearAllDisplayModes

(

)

[inline]

Removes all special display modes.

Basic::LcString::Justify Eaagles::BasicGL::LcField::justification

(

)

const

Returns the current justification mode.

Basic::LcString::Justify Eaagles::BasicGL::LcField::justification

(

const Basic::LcString::Justify

t

)

Sets justification mode to t.

bool Eaagles::BasicGL::LcField::setPosition

(

const Basic::LcList *const

spobj

)

[virtual]

Sets the Position to [Line Column] specified by spobj.

bool Eaagles::BasicGL::LcField::withinField	(	const int	ln,
		const int	cp
	)			const [virtual]

Returns true if location specified is within the current field.

void Eaagles::BasicGL::LcField::setText

(

const char

newString[]

)

[virtual]

Sets the field's text string.

int Eaagles::BasicGL::LcField::setExample

(

const char *const

example

)

[virtual]

Sets the input example to example, and returns the length of example.

char Eaagles::BasicGL::LcField::getChar

(

)

[virtual]

Gets the character if in input mode.

void Eaagles::BasicGL::LcField::setChar

(

const char

c

)

[virtual]

Sets the character to c if in input mode.

void Eaagles::BasicGL::LcField::backSpace

(

const int

ns = 1

)

[virtual]

Backs up one space if in input mode.

void Eaagles::BasicGL::LcField::advanceSpace

(

const int

ns = 1

)

[virtual]

Advance one space if in input mode.

bool Eaagles::BasicGL::LcField::onForwardSpace

(

)

[virtual]

Calls advanceSpace() and returns true.

bool Eaagles::BasicGL::LcField::onBackSpace

(

)

[virtual]

Calls backSpace() and returns true.

char Eaagles::BasicGL::LcField::filterInputEvent	(	const int	event,
		const int	tc
	)			[virtual]

Filters input event 'event' using template character 'tc'.

bool Eaagles::BasicGL::LcField::isValidInputPosition

(

const int

tc

)

[virtual]

Makes sure the current input position is valid.

LCreal Eaagles::BasicGL::LcField::getInputValue

(

)

const [virtual]

Returns 0.0.

bool Eaagles::BasicGL::LcField::isInputValueValid

(

)

const [virtual]

Returns true always.

int Eaagles::BasicGL::LcField::getInputCharacterPosition

(

)

const [inline]

Returns the current input character position.

bool Eaagles::BasicGL::LcField::isLinked

(

)

const [inline]

Returns true if linked.

void Eaagles::BasicGL::LcField::setLinked

(

const bool

f

)

[inline]

Sets linked to f.

bool Eaagles::BasicGL::LcField::isInheritColor

(

)

const [inline]

Returns true if inheritColor is on.

bool Eaagles::BasicGL::LcField::setInheritColor

(

const bool

i

)

[inline]

Sets the inheritColor to i, then returns true.

bool Eaagles::BasicGL::LcField::cursor	(	int *	ln,
		int *	cp
	)			const [virtual]

Returns true if text cursor should be seen within this object and the position of the cursor.

Reimplemented from Eaagles::BasicGL::LcGraphic.

bool Eaagles::BasicGL::LcField::onSetLine

(

const Basic::LcNumber *const

oslobj

)

[virtual]

Sets the line number and returns true.

bool Eaagles::BasicGL::LcField::onSetColumn

(

const Basic::LcNumber *const

oscobj

)

[virtual]

Sets the column number and returns true.

void Eaagles::BasicGL::LcField::drawFunc

(

)

[virtual]

Method of LcGraphic interface. Draws the text field.

Reimplemented from Eaagles::BasicGL::LcGraphic.

virtual bool Eaagles::BasicGL::LcField::event	(	const int	event,
		LcObject *const	obj = 0
	)			[virtual]

Event handler method of LcComponent interface.

Reimplemented from Eaagles::BasicGL::LcGraphic.

void Eaagles::BasicGL::LcField::updateData

(

const LCreal

dt = 0.0

)

[virtual]

Updates the non-critical background data.

Reimplemented from Eaagles::Basic::LcComponent.

bool Eaagles::BasicGL::LcField::setSlotWidth

(

const Basic::LcNumber *const

swobj

)

[protected, virtual]

Slot table macro function to set width.

bool Eaagles::BasicGL::LcField::setSlotHighlight

(

const Basic::LcNumber *const

shobj

)

[protected, virtual]

Slot table macro function to set the text hightlight flag.

bool Eaagles::BasicGL::LcField::setSlotUnderline

(

const Basic::LcNumber *const

suobj

)

[protected, virtual]

Slot table macro function to set the text underline flag.

bool Eaagles::BasicGL::LcField::setSlotReversed

(

const Basic::LcNumber *const

srobj

)

[protected, virtual]

Slot table macro function to set the reversed video flag.

bool Eaagles::BasicGL::LcField::setSlotJustification

(

const Basic::LcString *const

sjobj

)

[protected, virtual]

Slot table macro function to set justification.

bool Eaagles::BasicGL::LcField::setSlotSpecial

(

const Basic::LcNumber *const

ssobj

)

[protected, virtual]

Slot table macro function to turn the special character set flag.

bool Eaagles::BasicGL::LcField::setSlotVertical

(

const Basic::LcNumber *const

ssobj

)

[protected, virtual]

Slot table macro function to set the vertical field flag.

bool Eaagles::BasicGL::LcField::setSlotBrackets

(

const Basic::LcNumber *const

obj

)

[protected, virtual]

Slot table macro function to set the bracket characters.

bool Eaagles::BasicGL::LcField::setSlotLinked

(

const Basic::LcNumber *const

msg

)

[protected, virtual]

Slot table macro function to turn the linked flag.

bool Eaagles::BasicGL::LcField::setSlotInheritColor

(

const Basic::LcNumber *const

ic

)

[protected, virtual]

Slot table macro function to inherit color of container.

void Eaagles::BasicGL::LcField::adjust

(

)

[inline, private]

Sets the original saved text to default justification mode.

---

Member Data Documentation

Basic::LcString Eaagles::BasicGL::LcField::origStr [protected]

Orig text saved by setText.

Basic::LcString Eaagles::BasicGL::LcField::inputExample [protected]

Input Templete String.

Basic::LcString Eaagles::BasicGL::LcField::str [protected]

Text stored in field.

Mode Eaagles::BasicGL::LcField::mode [protected]

Current mode.

int Eaagles::BasicGL::LcField::icp [protected]

Input character pointer.

int Eaagles::BasicGL::LcField::inpDspMode [protected]

Auto switches to this display mode during input mode.

bool Eaagles::BasicGL::LcField::inpModeHold [protected]

Hold input mode until after first input character.

int Eaagles::BasicGL::LcField::ln [private]

Line this field is on.

int Eaagles::BasicGL::LcField::cp [private]

Starting character position of field.

size_t Eaagles::BasicGL::LcField::w [private]

Width of the field.

bool Eaagles::BasicGL::LcField::linked [private]

Linked field (on input).

int Eaagles::BasicGL::LcField::dmode [private]

Display mode flags.

Basic::LcString::Justify Eaagles::BasicGL::LcField::jmode [private]

Justification mode.

bool Eaagles::BasicGL::LcField::inheritColor [private]

Inherit color instead of using a default color.

---