ConfigApplication Class Reference

ConfigApplication. More...

#include <ConfigApplication.h>

Inheritance diagram for ConfigApplication:

List of all members.

Public Types
typedef int	WindowSize
	Type of the size used in the config.
Public Member Functions
	ConfigApplication (string pdp, string hfp, WindowSize width, WindowSize height, bool isToolbarShown, bool isStatusbarShown, bool isPaletteShown, bool isSpeedSliderShown)
	Constructs object from known data.
	ConfigApplication (TiXmlElement *node)
	Constructs object using data from XML node.
	ConfigApplication ()
	Constructs object from default data.
virtual	~ConfigApplication ()
	Destructor.
virtual void	ShowEditationWindow (wxWindow *parent, bool waitUntilClosed=true)
	Shows editation window where the user can edit the config.
virtual TiXmlElement *	CreateXmlNode () const
	Creates node representing the config.
const string &	GetPaletteDirectoryPath () const
	Returns palette directory path.
void	SetPaletteDirectoryPath (string newPalettePath)
	Sets new palette directory path.
const string &	GetHelpFilePath () const
	Returns help file path.
void	SetHelpFilePath (string newHelpFilePath)
	Sets new help file path.
WindowSize	GetWindowWidth () const
	Returns window width.
WindowSize	GetWindowHeight () const
	Returns window height.
bool	IsToolbarShown () const
	Returns true if the toolbar is shown, false otherwise.
bool	IsStatusbarShown () const
	Returns true if the statusbar is shown, false otherwise.
bool	IsPaletteShown () const
	Returns true if the pallette is shown, false otherwise.
bool	IsSpeedSliderShown () const
	Returns true if the speed slider is shown, false otherwise.
Static Public Member Functions
static string	GetDefaultHelpPath ()
	Returns default help document path.
static string	GetDefaultAppConfigPath ()
	Returns default application config path (including filename).
Private Attributes
string	paletteDirectoryPath
	Palette directory.
string	helpFilePath
	Help file path.
WindowSize	windowWidth
	Width of window.
WindowSize	windowHeight
	Height of window.
bool	toolbarIsShown
	Toolbar visibility.
bool	statusbarIsShown
	Status bar visibility.
bool	paletteIsShown
	Palette visibility.
bool	speedSliderIsShown
	Palette visibility.
Static Private Attributes
static const string	DEFAULT_PALETTE_DIRECTORY
	Default path to directory with palette.
static const string	DEFAULT_HELP_PATH
	Default help path.
static const string	DEFAULT_APP_CONFIG_PATH
	Default application config path.
static const WindowSize	DEFAULT_WIDTH = 400
	Default window width.
static const WindowSize	DEFAULT_HEIGHT = 300
	Default window height.
static const bool	DEFAULT_TOOLBAR_VISIBILITY = true
	Default toolbar visibility.
static const bool	DEFAULT_STATUSBAR_VISIBILITY = true
	Default status bar visibility.
static const bool	DEFAULT_PALETTE_VISIBILITY = true
	Default palette visibility.
static const bool	DEFAULT_SPEEDSLIDER_VISIBILITY = true
	Default speed slider visibility.

---

Detailed Description

ConfigApplication.

---

Member Typedef Documentation

typedef int ConfigApplication::WindowSize

Type of the size used in the config.

---

Constructor & Destructor Documentation

ConfigApplication::ConfigApplication	(	string	pdp,
		string	hfp,
		WindowSize	width,
		WindowSize	height,
		bool	isToolbarShown,
		bool	isStatusbarShown,
		bool	isPaletteShown,
		bool	isSpeedSliderShown
	)			[inline]

Constructs object from known data.

Parameters:

	pdp	Palette directory path
	hfp	Help file path
	width	Width of the window
	height	Height window
	isToolbarShown	Toolbar visibility
	isStatusbarShown	Statusbar visibility
	isPaletteShown	Palette visibility
	isSpeedSliderShown	Speed slider visibility

ConfigApplication::ConfigApplication

(

TiXmlElement *

node

)

[explicit]

Constructs object using data from XML node.

ConfigApplication::ConfigApplication

(

)

Constructs object from default data.

virtual ConfigApplication::~ConfigApplication

(

)

[inline, virtual]

Destructor.

---

Member Function Documentation

TiXmlElement * ConfigApplication::CreateXmlNode

(

)

const [virtual]

Creates node representing the config.

Implements BaseConfig.

static string ConfigApplication::GetDefaultAppConfigPath

(

)

[inline, static]

Returns default application config path (including filename).

Relative address, like app.xml.

static string ConfigApplication::GetDefaultHelpPath

(

)

[inline, static]

Returns default help document path.

Relative address, like doc/help/index.html.

const string& ConfigApplication::GetHelpFilePath

(

)

const [inline]

Returns help file path.

const string& ConfigApplication::GetPaletteDirectoryPath

(

)

const [inline]

Returns palette directory path.

WindowSize ConfigApplication::GetWindowHeight

(

)

const [inline]

Returns window height.

WindowSize ConfigApplication::GetWindowWidth

(

)

const [inline]

Returns window width.

bool ConfigApplication::IsPaletteShown

(

)

const [inline]

Returns true if the pallette is shown, false otherwise.

bool ConfigApplication::IsSpeedSliderShown

(

)

const [inline]

Returns true if the speed slider is shown, false otherwise.

bool ConfigApplication::IsStatusbarShown

(

)

const [inline]

Returns true if the statusbar is shown, false otherwise.

bool ConfigApplication::IsToolbarShown

(

)

const [inline]

Returns true if the toolbar is shown, false otherwise.

void ConfigApplication::SetHelpFilePath

(

string

newHelpFilePath

)

[inline]

Sets new help file path.

Parameters:

newHelpFilePath

New help file path that has to be set

void ConfigApplication::SetPaletteDirectoryPath

(

string

newPalettePath

)

[inline]

Sets new palette directory path.

Parameters:

newPalettePath

New palette path that has to be set

void ConfigApplication::ShowEditationWindow	(	wxWindow *	parent,
		bool	waitUntilClosed = true
	)			[virtual]

Shows editation window where the user can edit the config.

Parameters:

	parent	Parent window
	waitUntilClosed	If true, application will be stopped until the window is closed

Implements EditableInWindowConfig.

---

Member Data Documentation

const string ConfigApplication::DEFAULT_APP_CONFIG_PATH [static, private]

Default application config path.

const ConfigApplication::WindowSize ConfigApplication::DEFAULT_HEIGHT = 300 [static, private]

Default window height.

const string ConfigApplication::DEFAULT_HELP_PATH [static, private]

Default help path.

const string ConfigApplication::DEFAULT_PALETTE_DIRECTORY [static, private]

Default path to directory with palette.

const bool ConfigApplication::DEFAULT_PALETTE_VISIBILITY = true [static, private]

Default palette visibility.

const bool ConfigApplication::DEFAULT_SPEEDSLIDER_VISIBILITY = true [static, private]

Default speed slider visibility.

const bool ConfigApplication::DEFAULT_STATUSBAR_VISIBILITY = true [static, private]

Default status bar visibility.

const bool ConfigApplication::DEFAULT_TOOLBAR_VISIBILITY = true [static, private]

Default toolbar visibility.

const ConfigApplication::WindowSize ConfigApplication::DEFAULT_WIDTH = 400 [static, private]

Default window width.

string ConfigApplication::helpFilePath [private]

Help file path.

string ConfigApplication::paletteDirectoryPath [private]

Palette directory.

bool ConfigApplication::paletteIsShown [private]

Palette visibility.

bool ConfigApplication::speedSliderIsShown [private]

Palette visibility.

bool ConfigApplication::statusbarIsShown [private]

Status bar visibility.

bool ConfigApplication::toolbarIsShown [private]

Toolbar visibility.

WindowSize ConfigApplication::windowHeight [private]

Height of window.

WindowSize ConfigApplication::windowWidth [private]

Width of window.

---

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

• /home/s3rvac/Projekty/FIT/ICP/ICP07/src/configs/ConfigApplication.h
• /home/s3rvac/Projekty/FIT/ICP/ICP07/src/configs/ConfigApplication.cpp

---