Inheritance diagram for ciTreeCtrl:

Classes
struct	structPanelList

Public Types
enum	ciPanelClassInfo { undefined = -1, base = 0, scenario = 1000, sensorlist, sensor, ephemeris, atmosphere, terrain, environment, entity, sensim, optics, detector, electronics, track, movieplayer, nvtherm, guitrack, network, movieMerge }

Public Member Functions
	ciTreeCtrl ()
	ciTreeCtrl (wxWindow *parent, wxWindowID id, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxTR_HAS_BUTTONS, const wxValidator &validator=wxDefaultValidator, const wxString &name="ciListCtrl")
void	DestroyPanelList ()
void	DeleteAllItems ()
void	Delete (const wxTreeItemId &item)
wxTreeItemId	AddRoot (const wxString &text, wxWindow *panelWnd, int panelClassInfo, int image=-1, int selImage=-1)
wxTreeItemId	AppendItem (const wxTreeItemId &parentId, const wxString &text, wxWindow *panelWnd, int panelClassInfo, int image=-1, int selImage=-1)
wxTreeItemId	InsertItem (const wxTreeItemId &parent, const wxTreeItemId &item, const wxString &text, wxWindow *panelWnd, int panelClassInfo, int image=-1, int selImage=-1)
void	AddPanel (wxTreeItemId nodeId, wxWindow *panelWnd, int panelClassInfo)
void	InsertPanel (wxTreeItemId nodeId, wxWindow *panelWnd, int panelClassInfo, int idx=-1)
int	FindPanel (wxTreeItemId nodeId)
int	FindPanel (wxWindow *panelWnd)
void	RemovePanel (wxTreeItemId nodeId)
void	RemovePanel (wxWindow *panelWnd)
void	RemovePanel (int idx)
wxWindow *	GetPanelWnd (wxTreeItemId nodeId)
wxWindow *	GetPanelWnd (int idx)
int	GetPanelClass (int idx)
int	GetPanelClass (wxTreeItemId nodeId)
int	GetPanelClass (wxWindow *panelWnd)
wxTreeItemId	getItemId (wxWindow *panelWnd)
wxTreeItemId	getItemId (int idx)

Protected Member Functions
virtual	~ciTreeCtrl ()

Protected Attributes
struct ciTreeCtrl::structPanelList *	m_panelList

Private Attributes
int	m_nPanelWnds

Detailed Description

ciTreeCtrl class declaration

Member Enumeration Documentation

enum ciTreeCtrl::ciPanelClassInfo

Description: Enumerates the defined panel window classes.

Enumerator:

undefined	-1 - undefined class!
base	0 - not normally used!
scenario	1000
sensorlist
sensor	1001
ephemeris	1002
atmosphere	1003
terrain	1004
environment	1005
entity	1006
sensim	1007
optics	1008
detector	1009
electronics	1010
track	1011
movieplayer	1012
nvtherm	1013
guitrack	1014
network
movieMerge

Constructor & Destructor Documentation

ciTreeCtrl::ciTreeCtrl ( )

Description:: Default constructor.

ciTreeCtrl::ciTreeCtrl	(	wxWindow *	parent,
		wxWindowID	id,
		const wxPoint &	pos = `wxDefaultPosition`,
		const wxSize &	size = `wxDefaultSize`,
		long	style = `wxTR_HAS_BUTTONS`,
		const wxValidator &	validator = `wxDefaultValidator`,
		const wxString &	name = `"ciListCtrl"`
	)

Description:: Constructor, creating and showing a tree control.

Parameters

parent	- Parent window. Must not be NULL.
id	- Window identifier. A value of -1 indicates a default value.
pos	- Window position.
size	- Window size. If the default size (-1, -1) is specified then the window is sized appropriately.
style	- Window style. See wxTreeCtrl.
validator	- Window validator.
name	- Window name.

virtual ciTreeCtrl::~ciTreeCtrl ( )

protectedvirtual

Description:: Default destructor.

Note: Protected destructor. Cannot be passed as an argument or copied...

Member Function Documentation

void ciTreeCtrl::DestroyPanelList ( )

Description: Frees the memory allocated for the panel list structure.

Returns: void

See Also: structPanelList

Note: This method does not destroy any panel windows contained in the list.

void ciTreeCtrl::DeleteAllItems ( )

Description: Deletes all the items in the control. Overwritten to support the custom control.

Returns: void

See Also: Delete()

Note: This will not generate any events unlike Delete method

void ciTreeCtrl::Delete ( const wxTreeItemId & item )

Description: Deletes the specified item. An EVT_TREE_DELETE_ITEM event will be generated.

Parameters

item	- the Id of the node to delete

Returns: void

See Also: Delete()

Note: This function may cause a subsequent call to GetNextChild to fail.

wxTreeItemId ciTreeCtrl::AddRoot	(	const wxString &	text,
		wxWindow *	panelWnd,
		int	panelClassInfo,
		int	image = `-1`,
		int	selImage = `-1`
	)

Description: Adds a panel to the tree control in the root node. Overloads the wxTreeCtrl implementation.

Parameters

text	- the title for the node
panelWnd	- the pointer to the panel window
panelClassInfo	- the class information of the panel
image	- the default image for the node
selImage	- the selected (highlighted) image for the node

Returns: wxTreeItemId - the ID associated the root node

See Also: enumPanelClassInfo, structPanelList

wxTreeItemId ciTreeCtrl::AppendItem	(	const wxTreeItemId &	parentId,
		const wxString &	text,
		wxWindow *	panelWnd,
		int	panelClassInfo,
		int	image = `-1`,
		int	selImage = `-1`
	)

Description: Adds a panel to the tree control as a child to a parent item.

Parameters

parentId	- the node Id of parent
text	- the title for the node
panelWnd	- the pointer to the panel window
panelClassInfo	- the class information of the panel
image	- the default image for the node
selImage	- the selected (highlighted) image for the node

Returns: wxTreeItemId - the ID associated the item node

See Also: PanelClassInfo, structPanelList

wxTreeItemId ciTreeCtrl::InsertItem	(	const wxTreeItemId &	parent,
		const wxTreeItemId &	item,
		const wxString &	text,
		wxWindow *	panelWnd,
		int	panelClassInfo,
		int	image = `-1`,
		int	selImage = `-1`
	)

Description: Inserts a panel prior to item.

Parameters

parent	- the node Id of parent
item	- node to insert prior
text	- the title for the node
panelWnd	- the pointer to the panel window
panelClassInfo	- the class information of the panel
image	- the default image for the node
selImage	- the selected (highlighted) image for the node

Returns: wxTreeItemId - the ID associated the new item node

See Also: PanelClassInfo, structPanelList

void ciTreeCtrl::AddPanel	(	wxTreeItemId	nodeId,
		wxWindow *	panelWnd,
		int	panelClassInfo
	)

Description: Adds the panel to the node list structure.

Parameters

nodeId	- the tree control node's ID
panelWnd	- the pointer to the panel window
panelClassInfo	- the class information of the panel

Returns: void

See Also: PanelClassInfo, structPanelList

void ciTreeCtrl::InsertPanel	(	wxTreeItemId	nodeId,
		wxWindow *	panelWnd,
		int	panelClassInfo,
		int	idx = `-1`
	)

Description: Inserts a panel prior to idx in the node list structure.

Parameters

nodeId	- the tree control node's ID
panelWnd	- the pointer to the panel window
panelClassInfo	- the class information of the panel
idx	- the index into the node list. If idx = 0, the panel will be inserted at the head of the list. If idx = 1, it will be added to the tail.

Returns: void

See Also: PanelClassInfo, structPanelList

int ciTreeCtrl::FindPanel ( wxTreeItemId nodeId )

Description: Finds the index to the panel in the panel list structure.

Parameters

nodeId - the tree control node's ID

Returns: The index in the list of the located information, or -1 if not found.

See Also: enumPanelClassInfo, structPanelList

int ciTreeCtrl::FindPanel ( wxWindow * panelWnd )

Description: Finds the index to the panel in the panel list structure.

Parameters

panelWnd - the pointer to the panel window

Returns: The index in the list of the located information, or -1 if not found.

See Also: enumPanelClassInfo, structPanelList

void ciTreeCtrl::RemovePanel ( wxTreeItemId nodeId )

Description: Removes the panel from the panel list structure.

Parameters

nodeId - the tree control node's ID

Returns: void

Note: Removing the panel information does not destroy the panel window!

See Also: enumPanelClassInfo, structPanelList

void ciTreeCtrl::RemovePanel ( wxWindow * panelWnd )

Description: Removes the panel from the panel list structure.

Parameters

panelWnd - the pointer to the panel window

Returns: void

Note: Removing the panel information does not destroy the panel window!

See Also: enumPanelClassInfo, structPanelList

void ciTreeCtrl::RemovePanel ( int idx )

Description: Removes the panel from the panel list structure.

Parameters

idx	- the index into the panel list

Returns: void

Note: Removing the panel information does not destroy the panel window!

See Also: enumPanelClassInfo, structPanelList

wxWindow* ciTreeCtrl::GetPanelWnd ( wxTreeItemId nodeId )

Description: Gets the pointer to the managed panel window.

Parameters

nodeId - the tree control node's ID

Returns: wxWindow pointer to the panel window.

wxWindow* ciTreeCtrl::GetPanelWnd ( int idx )

Description: Gets the pointer to the managed panel window.

Parameters

idx	- the index into the panel list

Returns: wxWindow pointer to the panel window.

int ciTreeCtrl::GetPanelClass ( int idx )

Description: Gets the class information to the managed panel window.

Parameters

idx	- the index into the panel list

Returns: the enumerated class information.

See Also: enumPanelClassInfo

int ciTreeCtrl::GetPanelClass ( wxTreeItemId nodeId )

Description: Gets the class information to the managed panel window.

Parameters

nodeId - the tree control node's ID

Returns: the enumerated class information.

See Also: enumPanelClassInfo

int ciTreeCtrl::GetPanelClass ( wxWindow * panelWnd )

Description: Gets the class information to the managed panel window.

Parameters

panelWnd - the pointer to the panel window

Returns: the enumerated class information.

See Also: enumPanelClassInfo

wxTreeItemId ciTreeCtrl::getItemId ( wxWindow * panelWnd )

Description: Gets the tree control item id.

Parameters

panelWnd - the pointer to the panel window

Returns: the tree control item's id.

wxTreeItemId ciTreeCtrl::getItemId ( int idx )

Description: Gets the tree control item id.

Parameters

idx	- the index into the panel list

Returns: the tree control item's id.

Member Data Documentation

struct ciTreeCtrl::structPanelList * ciTreeCtrl::m_panelList

protected

int ciTreeCtrl::m_nPanelWnds

private

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

ciTreeCtrl.h

Classes

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation