#include <cinossiotftexp.h>

Inheritance diagram for CTFTIncoMember:

[legend]

Public Member Functions
	CTFTIncoMember (CINOSSioTftExpTab *apParent, XMLNode axVarNode)
	Constructor.

virtual	~CTFTIncoMember ()
	Destructor.

virtual void	GetValueLimited (char *apBuf, uint32 auSize)
	Get string form of current value.

virtual void	GetValue (char *apBuf, uint32 auSize)
	Get string form of current value.

virtual void	SetValue (char *apBuf)
	Set new value.

virtual void	GetUnit (char *apBuf, uint32 auSize)
	Get unit of member.

virtual uint32	GetCharacteristics ()
	Get characteristics of member.

bool	SetCharacteristics (uint32 auChar, ETFTCharCmd aeCmd)
	Change characteristics.

virtual bool	IsWritable (uint32 auUserLevel)
	Check if member is writable for editing with given level.

virtual void	SelLanguage (const char apLangName, const char apLangFile, const char *apLangFileEnd)
	Set name according to selected language (or default).

virtual bool	UpdateInco ()
	Update inco item pointer if member has one.

virtual bool	RepaintNeeded ()
	Update member and check if anything requires a repaint.

virtual const char *	GetName ()
	Get current name of member (depends on selected language).

virtual const char *	FindName (const char *apLangName=NULL)
	Find member name according to given language.

virtual void	GetDefaultName (char *apBuf, uint32 auSize)
	Get default name independent of language.

virtual bool	CanToggle ()
	Returns true if the member can be toggled.

virtual void	Toggle ()
	Toggles the value of this member.

virtual uint16	GetCoordX ()

virtual uint16	GetCoordY ()

virtual void	SetCoordY (uint16 auCoordY)

virtual uint16	GetSizeX ()

virtual uint16	GetSizeY ()

virtual bool	HitTest (uint16 auCoordX, uint16 auCoordY)

virtual EBlockTextAlignment	GetAlignment ()

uint8	GetForeColor ()

uint8	GetBackColor ()

void	SetBackColor (uint8 auColor)

uint8	GetFrame ()

STFTFontInfo &	GetFont ()

void	SetReadOnly ()

void	SetWritable ()

uint8	GetKeyBoard () const

Protected Attributes
CINOSSioTftExpTab *	m_pParent

XMLNode	m_xVarNode
	Config node for this member.

const char *	m_pName
	Pointer to current name (depending on language).

uint32	m_uType
	Type of member.

uint16	m_uColumns
	Column setting (value, unit) for this member.

uint16	m_uCoordX
	X coordinate of member (to check for touches).

uint16	m_uCoordY
	Y coordinate of member (to check for touches).

uint8	m_uHeight
	Height of this member.

uint16	m_uSizeX
	X size of member.

uint16	m_uSizeY
	Y size of member.

EBlockTextAlignment	m_eAlign

uint8	m_uColFore

uint8	m_uColBack

uint8	m_uFrame

uint8	m_uKeyboard
	required keyboard

bool	m_bReadOnly
	Flag indicating if the user is not allowed to change the member.

bool	m_bUserReadOnly
	Flag indicating if the user is not allowed to change the member in this state.

STFTFontInfo	m_Font
	Font for this member.

Friends
class	CINOSSioTftExp

class	CINOSSioTftExpTab

Detailed Description

Base class for all tab 'members' like variables, titles, memory etc

Constructor & Destructor Documentation

◆ CTFTIncoMember()

CTFTIncoMember::CTFTIncoMember	(	CINOSSioTftExpTab *	apParent,
		XMLNode	axVarNode
	)

Constructor.

Parameters

apParent	Tab that contains this member.
axVarNode	XML config node for this member.

Member Function Documentation

◆ CanToggle()

virtual bool CTFTIncoMember::CanToggle ( )

inlinevirtual

Returns true if the member can be toggled.

Reimplemented in CTFTIncoVariable.

◆ FindName()

virtual const char * CTFTIncoMember::FindName ( const char * apLangName = NULL )

inlinevirtual

Find member name according to given language.

Parameters

apLangName Name of language to look for, NULL for default name.

Returns: Matching member name (or default).

Reimplemented in CTFTIncoVariable, CTFTIncoTitle, CTFTIncoStatic, CTFTIncoMemory, and CTFTIncoBitmap.

◆ GetCharacteristics()

virtual uint32 CTFTIncoMember::GetCharacteristics ( )

virtual

Get characteristics of member.

Returns: Member characteristics.

Reimplemented in CTFTIncoVariable, and CTFTIncoMemory.

◆ GetDefaultName()

virtual void CTFTIncoMember::GetDefaultName	(	char *	apBuf,
		uint32	auSize
	)

inlinevirtual

Get default name independent of language.

Parameters

apBuf	Buffer to receive name string.
auSize	Size of string buffer.

◆ GetName()

virtual const char * CTFTIncoMember::GetName ( )

virtual

Get current name of member (depends on selected language).

Returns: Current member name.

◆ GetUnit()

virtual void CTFTIncoMember::GetUnit	(	char *	apBuf,
		uint32	auSize
	)

virtual

Get unit of member.

Parameters

apBuf	Buffer to receive unit string.
auSize	Size of string buffer.

Reimplemented in CTFTIncoVariable.

◆ GetValue()

virtual void CTFTIncoMember::GetValue	(	char *	apBuf,
		uint32	auSize
	)

virtual

Get string form of current value.

Parameters

apBuf	Buffer to receive value string.
auSize	Size of string buffer.

Reimplemented in CTFTIncoVariable, CTFTIncoStatic, and CTFTIncoMemory.

◆ GetValueLimited()

virtual void CTFTIncoMember::GetValueLimited	(	char *	apBuf,
		uint32	auSize
	)

virtual

Get string form of current value.

Parameters

apBuf	Buffer to receive value string.
auSize	Size of string buffer.

Reimplemented in CTFTIncoVariable.

◆ IsWritable()

virtual bool CTFTIncoMember::IsWritable ( uint32 auUserLevel )

virtual

Check if member is writable for editing with given level.

Parameters

auUserLevel User level to check against for writing.

Returns: True if member is writable for this user.

Reimplemented in CTFTIncoVariable, and CTFTIncoMemory.

◆ RepaintNeeded()

virtual bool CTFTIncoMember::RepaintNeeded ( )

virtual

Update member and check if anything requires a repaint.

Returns: True if member changed.

Reimplemented in CTFTIncoVariable.

◆ SelLanguage()

virtual void CTFTIncoMember::SelLanguage	(	const char *	apLangName,
		const char *	apLangFile,
		const char *	apLangFileEnd
	)

virtual

Set name according to selected language (or default).

Parameters

apLangName	Name of language to look for in xml config.
apLangFile	Text of language file or NULL.
apLangFileEnd	Pointer to end of language file.

◆ SetBackColor()

void CTFTIncoMember::SetBackColor ( uint8 auColor )

changes the background color of an item.

Note: Ensure display is refreshed afterwards

◆ SetCharacteristics()

bool CTFTIncoMember::SetCharacteristics	(	uint32	auChar,
		ETFTCharCmd	aeCmd
	)

Change characteristics.

Parameters

auChar	Characteristics to apply.
aeCmd	Command to execute (set/add/clear).

◆ SetValue()

virtual void CTFTIncoMember::SetValue ( char * apBuf )

virtual

Set new value.

Parameters

String form of new value to set.

Reimplemented in CTFTIncoVariable, and CTFTIncoMemory.

◆ Toggle()

virtual void CTFTIncoMember::Toggle ( )

inlinevirtual

Toggles the value of this member.

Reimplemented in CTFTIncoVariable.

◆ UpdateInco()

virtual bool CTFTIncoMember::UpdateInco ( )

virtual

Update inco item pointer if member has one.

Returns: True if pointer changed.

Reimplemented in CTFTIncoVariable.

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

/home/jenkins/workspace/inos_doxygen/os/inos/inc/cinossiotftexp.h

Public Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ CTFTIncoMember()

Member Function Documentation

◆ CanToggle()

◆ FindName()

◆ GetCharacteristics()

◆ GetDefaultName()

◆ GetName()

◆ GetUnit()

◆ GetValue()

◆ GetValueLimited()

◆ IsWritable()

◆ RepaintNeeded()

◆ SelLanguage()

◆ SetBackColor()

◆ SetCharacteristics()

◆ SetValue()

◆ Toggle()

◆ UpdateInco()