TdkInterfaceParams Class Reference

Defines the TdkInterfaceController class. This class defines an class with parameters to construct dialogs. More...

#include <TdkInterfaceParams.h>

List of all members.

Public Member Functions

Constructor and Destructor Methods
Methods related to instantiation and destruction.

 TdkInterfaceParams (const bool &modal=false, const std::string &name="")
 Constructor.
virtual ~TdkInterfaceParams ()
 Virtual destructor.
Setting and Getting Methods
Methods used to sets and gets atributes.

void setModal (const bool &modal)
 Sets modal parameter.
bool getModal ()
 Retrieves modal parameter value.
void setName (const std::string &name)
 Sets name parameter.
std::string getName ()
 Retrieves name parameter value.
void setParent (TdkDlg *dlg)
 Sets parent dialog parameter.
TdkDlggetParent ()
 Retrieves parent dialog parameter value.
void setFactoryName (const std::string &fname)
 Sets dialog factory name parameter.
std::string getFactoryName ()
 Retrieves dialog factory name parameter value.
std::string getProductId ()
 Retrieves the dialog factory name. This method is used by Abstract factory.

Private Attributes

bool _modal
 Sinalizes if a dialog will be modal or not.
string _name
 Name of dialog.
string _factoryName
 Dialog factory name.
TdkDlg_parent
 Parent dialog.


Detailed Description

Defines the TdkInterfaceController class. This class defines an class with parameters to construct dialogs.

TODO: 1)

See also:
TdkDlg


Constructor & Destructor Documentation

TdkInterfaceParams::TdkInterfaceParams ( const bool &  modal = false,
const std::string &  name = "" 
) [inline]

Constructor.

Parameters:
modal Define the type of dilog: modal \ no modal.
name Dialog name.

TdkInterfaceParams::~TdkInterfaceParams (  )  [inline, virtual]

Virtual destructor.


Member Function Documentation

void TdkInterfaceParams::setModal ( const bool &  modal  )  [inline]

Sets modal parameter.

Parameters:
modal True - if dialog is modal, false otherwise.

bool TdkInterfaceParams::getModal (  )  [inline]

Retrieves modal parameter value.

Returns:
True - if dialog is modal, false otherwise.

void TdkInterfaceParams::setName ( const std::string &  name  )  [inline]

Sets name parameter.

Parameters:
name Dialog's name.

std::string TdkInterfaceParams::getName (  )  [inline]

Retrieves name parameter value.

Returns:
Dialog's name.

void TdkInterfaceParams::setParent ( TdkDlg dlg  )  [inline]

Sets parent dialog parameter.

Parameters:
dlg Parent dialog.

TdkDlg * TdkInterfaceParams::getParent (  )  [inline]

Retrieves parent dialog parameter value.

Returns:
Parent dialog.

void TdkInterfaceParams::setFactoryName ( const std::string &  fname  )  [inline]

Sets dialog factory name parameter.

Parameters:
Parent dialog.

std::string TdkInterfaceParams::getFactoryName (  )  [inline]

Retrieves dialog factory name parameter value.

Returns:
Dialog factory name.

std::string TdkInterfaceParams::getProductId (  )  [inline]

Retrieves the dialog factory name. This method is used by Abstract factory.

Returns:
Dialog factory name.


Member Data Documentation

bool TdkInterfaceParams::_modal [private]

Sinalizes if a dialog will be modal or not.

string TdkInterfaceParams::_name [private]

Name of dialog.

string TdkInterfaceParams::_factoryName [private]

Dialog factory name.

TdkDlg* TdkInterfaceParams::_parent [private]

Parent dialog.


The documentation for this class was generated from the following file:
Generated on Fri Jun 15 16:54:41 2007 for TDK by  doxygen 1.5.2