CINOSSioTftExpTab Class Reference

Tabulator, holds all necessary info in a explorer tabulator. More...

#include <cinossiotftexp.h>

Public Member Functions
	CINOSSioTftExpTab (XMLNode axTabNode, CINOSSioTftExpTab *apParent)
	Constructor.
virtual	~CINOSSioTftExpTab ()
	Destructor.
void	AddTab (CINOSSioTftExpTab *apSubTab)
	Add new tab to list of children.
void	AddProc (XMLNode axProcNode)
	Add new procedure to tab.
void	AddVar (XMLNode axVarNode)
	Add new variable to tab.
void	InheritProcs (TINOSSioTftExpProc *apProcs)
	Inherit procedures from parent tab to me.
const char *	GetDefaultName ()
	Get default name of tab.
CINOSSioTftExpTab *	GetTabAt (uint32 auIndex)
	Get tab by index.
CINOSSioTftExpTab *	FindAndSelectTab (char *apTab)
	Find tab by name and make it active.
CINOSSioTftExpTab *	FindTab (const char *const apTab, bool abSelect)
	Find tab by name and make it active if desired.
CTFTIncoMember *	FindMember (const char *const apPath)
TINOSSioTftExpProc	FindProc (const char *const apPath)
bool	SetCharacteristics (uint32 auChar, ETFTCharCmd aeCmd)
	Change characteristics.
void	SelLanguage (const char *apLangName, bool abRecursive, const char *apLangFile, const char *apLangFileEnd)
	Set name according to selected language (or default).
bool	UpdateInco ()
	Update inco item pointers of items e.g. after new registrations.
bool	RepaintNeeded ()
uint32	GetCharacteristics ()
	Get characteristics of tab.
void	ReadTab (XMLNode axNode, uint32 auLevel=0)
	Read in definition of a tab.
uint8	GetForeColor ()
uint8	GetBackColor ()
virtual uint16	GetCoordX ()
virtual uint16	GetCoordY ()
virtual void	SetCoordX (uint16 auCoordX)
virtual void	SetCoordY (uint16 auCoordY)
virtual uint16	GetSizeX ()
virtual uint16	GetSizeY ()
bool	HitTest (uint16 auCoordX, uint16 auCoordY)

Friends
class	CINOSSioTftExp
	Allow explorer to access my members.

Detailed Description

Tabulator, holds all necessary info in a explorer tabulator.

A Tabulator has pointers to other tabulators on the same level, to the parent tabulator and the first child tabulator for navigation. Which one of the child tabs is active is also saved so it is selected if the user navigates through this tab again. There is also a list of all numbers belonging to this tab.

Constructor & Destructor Documentation

CINOSSioTftExpTab()

CINOSSioTftExpTab::CINOSSioTftExpTab	(	XMLNode	axTabNode,
		CINOSSioTftExpTab *	apParent
	)

Constructor.

Parameters

axTabNode	Xml config node for tab.
apParent	Parent tab.

Member Function Documentation

AddProc()

void CINOSSioTftExpTab::AddProc

(

XMLNode

axProcNode

)

Add new procedure to tab.

Parameters

axProcNode

Xml config of procedure to add.

AddTab()

void CINOSSioTftExpTab::AddTab

(

CINOSSioTftExpTab *

apSubTab

)

Add new tab to list of children.

Parameters

apSubTab

Tab to add.

AddVar()

void CINOSSioTftExpTab::AddVar

(

XMLNode

axVarNode

)

Add new variable to tab.

Parameters

axVarNode

Xml config of variable to add.

FindAndSelectTab()

CINOSSioTftExpTab * CINOSSioTftExpTab::FindAndSelectTab

(

char *

apTab

)

Find tab by name and make it active.

Parameters

apTab

Tab path in the form 'PTab1.Ptab2.MyTab'.

Returns

The found and selected tab or NULL.

FindTab()

CINOSSioTftExpTab * CINOSSioTftExpTab::FindTab	(	const char *const	apTab,
		bool	abSelect
	)

Find tab by name and make it active if desired.

Parameters

apTab	Tab path in the form 'PTab1.Ptab2.MyTab'.
abSelect	Flag if tabs should be selected.

Returns

The found and selected tab or NULL.

GetCharacteristics()

uint32 CINOSSioTftExpTab::GetCharacteristics ( )

inline

Get characteristics of tab.

Returns

Tab's characteristics.

GetDefaultName()

const char * CINOSSioTftExpTab::GetDefaultName ( )

inline

Get default name of tab.

Returns

Default name of tab.

GetTabAt()

CINOSSioTftExpTab * CINOSSioTftExpTab::GetTabAt

(

uint32

auIndex

)

Get tab by index.

Parameters

auIndex

Index of tab to get.

Returns

Found tab or NULL if not found.

InheritProcs()

void CINOSSioTftExpTab::InheritProcs

(

TINOSSioTftExpProc *

apProcs

)

Inherit procedures from parent tab to me.

Parameters

apProcs

Procedures to take over.

ReadTab()

void CINOSSioTftExpTab::ReadTab	(	XMLNode	axNode,
		uint32	auLevel = 0
	)

Read in definition of a tab.

Parameters

axNode	Xml config node of tab.
auLevel	Current nesting level to prevent too deep levels.

SelLanguage()

void CINOSSioTftExpTab::SelLanguage	(	const char *	apLangName,
		bool	abRecursive,
		const char *	apLangFile,
		const char *	apLangFileEnd
	)

Set name according to selected language (or default).

Parameters

apLangName	Name of language to look for in xml config.
abRecursive	Flag if children and members shoulb be set too.
apLangFile	Text of language file or NULL.
apLangFileEnd	Pointer to end of language file.

SetCharacteristics()

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

Change characteristics.

Parameters

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

UpdateInco()

bool CINOSSioTftExpTab::UpdateInco

(

)

Update inco item pointers of items e.g. after new registrations.

Returns

True if at least one pointer changed.

---

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

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