RTD documentation
Main Page   Class Hierarchy   Compound List   Compound Members  

Crtd_Dlg Class Reference

Main run-time dialog. More...

#include <rtd_Dlg.h>

Inheritance diagram for Crtd_Dlg:

Crtd_BaseDlg CDialog CWnd List of all members.

Public Methods

 Crtd_Dlg (UINT nIDD = 0, CWnd* pParent = NULL)
 Constructor. More...

CStringArray* GetItemNames ()
 Retrieves item names. More...

CUIntArray* GetItemIDs ()
 Retrieves item IDs. More...

CString GetItemNameByID (UINT nID)
 Get item name by item ID. More...

int GetItemIDByName (const CString& szName)
 Get item ID by name. More...

virtual void Store (BOOL bStore, CString szFileName = _T(""))
 Serializes dialogs' data. More...

void GotoNextCfg (int iDir)
 Loades next configuration. More...

BOOL CanGotoNextCfg ()
 Tells if there is next configuration available. More...

void Edit ()
 Launches dialog editor. More...

void SetActiveCfg (int iActiveCfg, BOOL bForce = FALSE)
 Sets active configuration. More...

int GetActiveCfg ()
 Gets current configuration ID. More...

Crtd_Cfg& GetCfg (int iCfg = -1)
 Gets current configuration. More...

CCfgs* GetCfgs ()
 Gets array of configurations. More...

Crtd_DItem* GetDItem (int iCfg, UINT nID)
 Get dialog item information. More...

void Refresh ()
 Refreshes dialog. More...

void AddItemName (UINT nID, CString szName)
 Adds an item to the dialog. More...

void Serialize (CArchive& ar)
 Serializes configuration data to an archive. More...

Detailed Description

Main run-time dialog.

Crtd_Dlg is the main run-time dialog. You should derive from this class to create your own customizable dialogs. The class provides the required interface for accessing controls, configurations and serialization methods.

Version:
1.3
Date:
01.01.2000

Constructor & Destructor Documentation

Crtd_Dlg::Crtd_Dlg ( UINT nIDD = 0,
CWnd * pParent = NULL )
 

Constructor.

Standard dialog constructor.

Parameters:
nIDD   resource ID of the dialog.
pParent   pointer to the parent window.

Member Function Documentation

void Crtd_Dlg::AddItemName ( UINT nID,
CString szName ) [inline]
 

Adds an item to the dialog.

Adds an item to the list of dialog resource IDs and names. The information will be used for accessing dialog items by their display names.

Parameters:
nID   dialog item resource ID.
szName   dialog item display ID.

BOOL Crtd_Dlg::CanGotoNextCfg ( ) [inline]
 

Tells if there is next configuration available.

Checks if there is at least one more configuration available in the array of configurations.

Returns:
TRUE if at least one more configuration is available.

void Crtd_Dlg::Edit ( )
 

Launches dialog editor.

Loads all configurations and displays dialog editor.

int Crtd_Dlg::GetActiveCfg ( ) [inline]
 

Gets current configuration ID.

Retreives ID of the currently used configuraiton.

Returns:
int current configuration ID.

Crtd_Cfg & Crtd_Dlg::GetCfg ( int iCfg = -1 ) [inline]
 

Gets current configuration.

Retreives currently used configuraiton.

Returns:
Crtd_Cfg currently used configuration.

CCfgs * Crtd_Dlg::GetCfgs ( ) [inline]
 

Gets array of configurations.

Retreives the array of all available configurations.

Returns:
CCfgs* currently used configuration.

Crtd_DItem * Crtd_Dlg::GetDItem ( int iCfg,
UINT nID ) [inline]
 

Get dialog item information.

Retreives dialog item information by item's ID and configuration number.

Parameters:
iCfg   configuration number.
nID   dialog item resource ID.
Returns:
Crtd_DItem* pointer to dialog item information.

int Crtd_Dlg::GetItemIDByName ( const CString & szName )
 

Get item ID by name.

Retrieves ID of a dialog item given it's name.

Parameters:
szName   name of a dialog item.
Returns:
int dialog item ID.

CUIntArray * Crtd_Dlg::GetItemIDs ( ) [inline]
 

Retrieves item IDs.

This is a helper function used to fill configurations combo boxes with item IDs.

Returns:
CUIntArray pointer to array of item IDs.

CString Crtd_Dlg::GetItemNameByID ( UINT nID )
 

Get item name by item ID.

Retrieves the names of an item by it's ID.

Parameters:
nID   resource ID of the dialog item.
Returns:
CString dialog item name.

CStringArray * Crtd_Dlg::GetItemNames ( ) [inline]
 

Retrieves item names.

This is a helper function used to fill configurations combo boxes with item names.

Returns:
CStringArray pointer to array of dialog item names.

void Crtd_Dlg::GotoNextCfg ( int iDir )
 

Loades next configuration.

Loades next configuration and changes dialog controls accordingly.

Parameters:
iDir   get's next configuration if iDir equals 1, to get previous config - set iDir to -1.

void Crtd_Dlg::Refresh ( )
 

Refreshes dialog.

Causes dialog to redraw.

void Crtd_Dlg::Serialize ( CArchive & ar )
 

Serializes configuration data to an archive.

Stores or loads configuration data from an archive. The arhive has to be initialized and connected to a file before the method is called.

Parameters:
ar   archive for serialization.

void Crtd_Dlg::SetActiveCfg ( int iActiveCfg,
BOOL bForce = FALSE )
 

Sets active configuration.

Loads all configurations and displays dialog editor.

Parameters:
iActiveCfg   configuration ID.
bForse   forces switch to another configuration.

void Crtd_Dlg::Store ( BOOL bStore,
CString szFileName = _T("") ) [virtual]
 

Serializes dialogs' data.

Stores or loads dialogs configuration from a file.

Parameters:
bStore   stores data on disk if set to TRUE, loads data otherwise.
szFileName   name of the file.

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

Last reviewed on Saturday February 07, 2004. Latest version is available at hamradio.idealog.net