This class define the setup level interface. More...

#include <SetupTool.h>

Public Member Functions
virtual void	Delete ()
	Create an instance of SetupTool. More...

virtual const char *	GetBinaryFolder () const =0
	Retrieve the name of the folder containing binary files. More...

virtual const char *	GetIncludeFolder () const =0
	Retrieve the name of the folder containing header files. More...

virtual const char *	GetInstallFolder () const =0
	Retrieve the name of the installation folder. More...

virtual const char *	GetLibraryFolder () const =0
	Retrieve the name of the folder containing library files. More...

virtual bool	IsDebugEnabled () const =0
	Is the debug trace enabled? More...

virtual Status	Install ()=0
	Install. More...

virtual Status	Uninstall ()=0
	Uninstall. More...

virtual Status	Interactif_ExecuteCommand (unsigned int aCommand)=0
	Execute interactif command. More...

virtual unsigned int	Interactif_GetCommandCount ()=0
	Retrieve the number of available interactif commands. More...

virtual const char *	Interactif_GetCommandText (unsigned int aCommand)=0
	Retrieve the text describing an interactif commands. More...

virtual Status	Wizard_ExecutePage (unsigned int *aPage, unsigned int aButton)=0
	Execute a wizard page. More...

virtual unsigned int	Wizard_GetPageButtonCount (unsigned int aPage)=0
	Retrieve the number of button on a wizard pages. More...

virtual const char *	Wizard_GetPageButtonText (unsigned int aPage, unsigned int aButton)=0
	Retrieve the text of a button. More...

virtual unsigned int	Wizard_GetPageCount ()=0
	Retrieve the number of wizard pages. More...

virtual const char *	Wizard_GetPageText (unsigned int aPage)=0
	Retrieve the text of a wizard page. More...

virtual const char *	Wizard_GetPageTitle (unsigned int aPage)=0
	Retrieve the title of a wizard page. More...

Static Public Member Functions
static OPEN_NET_PUBLIC SetupTool *	Create (bool aDebug=false)
	Create an instance of SetupTool. More...

Detailed Description

This class define the setup level interface.

Member Function Documentation

static OPEN_NET_PUBLIC SetupTool* OpenNet::SetupTool::Create ( bool aDebug = false )

static

Create an instance of SetupTool.

Parameters

aDebug true to enabled debug output

See also: Delete, IsDebugEnabled

virtual void OpenNet::SetupTool::Delete ( )

virtual

Create an instance of SetupTool.

See also: Create

virtual const char* OpenNet::SetupTool::GetBinaryFolder ( ) const

pure virtual

Retrieve the name of the folder containing binary files.

Returns: This method returns the address of an internal buffer.

virtual const char* OpenNet::SetupTool::GetIncludeFolder ( ) const

pure virtual

Retrieve the name of the folder containing header files.

Returns: This method returns the address of an internal buffer.

virtual const char* OpenNet::SetupTool::GetInstallFolder ( ) const

pure virtual

Retrieve the name of the installation folder.

Returns: This method returns the address of an internal buffer.

virtual const char* OpenNet::SetupTool::GetLibraryFolder ( ) const

pure virtual

Retrieve the name of the folder containing library files.

Returns: This method returns the address of an internal buffer.

virtual Status OpenNet::SetupTool::Install ( )

pure virtual

Install.

Return values

STATUS_OK

See also: Uninstall

virtual Status OpenNet::SetupTool::Interactif_ExecuteCommand ( unsigned int aCommand )

pure virtual

Execute interactif command.

Parameters

aCommand Index of the command

Return values

STATUS_OK

See also: Interactif_GetCommand

virtual unsigned int OpenNet::SetupTool::Interactif_GetCommandCount ( )

pure virtual

Retrieve the number of available interactif commands.

Returns: This method returns the number of commands.

See also: Interactif_GetCommand

virtual const char* OpenNet::SetupTool::Interactif_GetCommandText ( unsigned int aCommand )

pure virtual

Retrieve the text describing an interactif commands.

Parameters

aCommand Index of the command

Returns: This method returns the address of an internal buffer.

See also: Interactif_ExecuteCommand, Interactif_GetCommandCount

virtual bool OpenNet::SetupTool::IsDebugEnabled ( ) const

pure virtual

Is the debug trace enabled?

Return values

false
true

See also: Create

virtual Status OpenNet::SetupTool::Uninstall ( )

pure virtual

Uninstall.

Return values

STATUS_OK

See also: Install

virtual Status OpenNet::SetupTool::Wizard_ExecutePage	(	unsigned int *	aPage,
		unsigned int	aButton
	)

pure virtual

Execute a wizard page.

Parameters

aPage	Index of the page
aButton	The button index

Return values

STATUS_OK

See also: Interractif_GetPageButtonText, Interactif_GetPageText, Interactif_GetPageTitle

virtual unsigned int OpenNet::SetupTool::Wizard_GetPageButtonCount ( unsigned int aPage )

pure virtual

Retrieve the number of button on a wizard pages.

Parameters

aPage The wizard page index

Returns: This method returns the number of buttons.

See also: Wizard_GetPageButtonText

virtual const char* OpenNet::SetupTool::Wizard_GetPageButtonText	(	unsigned int	aPage,
		unsigned int	aButton
	)

pure virtual

Retrieve the text of a button.

Parameters

aPage	The wizard page index
aButton	The button index

Returns: This method returns the address of an internal buffer.

See also: Wizard_GetPageButtonCount

virtual unsigned int OpenNet::SetupTool::Wizard_GetPageCount ( )

pure virtual

Retrieve the number of wizard pages.

Returns: This method returns the number of pages.

See also: Wizard_GetPageButtonText, Wizard_GetPageText, Wizard_GetPageTitle

virtual const char* OpenNet::SetupTool::Wizard_GetPageText ( unsigned int aPage )

pure virtual

Retrieve the text of a wizard page.

Parameters

aPage The wizard page index

Returns: This method returns the address of an internal buffer.

See also: Wizard_GetPageButtonText

virtual const char* OpenNet::SetupTool::Wizard_GetPageTitle ( unsigned int aPage )

pure virtual

Retrieve the title of a wizard page.

Parameters

aPage The wizard page index

Returns: This method returns the address of an internal buffer.

See also: Wizard_GetPageCount

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

Includes/OpenNet/SetupTool.h

Public Member Functions

Static Public Member Functions

Detailed Description

Member Function Documentation