DynExp::WindowStyleParamsExtension Class Reference

Bundles several parameters to describe a UI window's style. Use in parameter classes. More...

#include <Module.h>

Public Types
enum	WindowStateType { Normal , Minimized , Maximized }
	Indicates the window state for showing it. More...
enum	WindowDockingStateType { Docked , Undocked }
	Indicates the window docking state. More...

Public Member Functions
	WindowStyleParamsExtension (ParamsBase &Owner, const std::string &Prefix="")
	Constructs a WindowStyleParamsExtension instance.
void	ApplyTo (QWidget &Widget, bool Show=true) const
	Applies the bundled style parameters to Widget.
void	FromWidget (const QWidget &Widget)
	Assigns styles applied to Widget to the bundled parameters.

Public Attributes
ParamsBase::Param< int >	WindowPosX
	Window x coordinate.
ParamsBase::Param< int >	WindowPosY
	Window y coordinate.
ParamsBase::Param< unsigned int >	WindowWidth
	Window width.
ParamsBase::Param< unsigned int >	WindowHeight
	Window height.
ParamsBase::Param< WindowStateType >	WindowState
	Window show state.
ParamsBase::Param< WindowDockingStateType >	WindowDockingState
	Window docking state.

Detailed Description

Bundles several parameters to describe a UI window's style. Use in parameter classes.

Definition at line 1557 of file Module.h.

Member Enumeration Documentation

WindowDockingStateType

enum DynExp::WindowStyleParamsExtension::WindowDockingStateType

Indicates the window docking state.

Enumerator
Docked	The window is docked to the DynExp's main window.
Undocked	The window is undocked from the DynExp's main window.

Definition at line 1580 of file Module.h.

WindowStateType

enum DynExp::WindowStyleParamsExtension::WindowStateType

Indicates the window state for showing it.

Enumerator
Normal	The window is shown in the default way.
Minimized	The window is shown minimized.
Maximized	The window is shown maximized.

Definition at line 1563 of file Module.h.

Constructor & Destructor Documentation

WindowStyleParamsExtension()

DynExp::WindowStyleParamsExtension::WindowStyleParamsExtension ( ParamsBase &  Owner, const std::string &  Prefix = ""  )

inline

Constructs a WindowStyleParamsExtension instance.

Parameters

Owner	Parameter class owning the parameters bundled by this instance.
Prefix	String to prepend to the bundled parameters' names in case Owner owns multiple WindowStyleParamsExtension instances.

Definition at line 1596 of file Module.h.

Member Function Documentation

ApplyTo()

void DynExp::WindowStyleParamsExtension::ApplyTo	(	QWidget &	Widget,
		bool	Show = true
	)		const

Applies the bundled style parameters to Widget.

Parameters

Widget	Widget to apply the style parameters to.
Show	Pass true to show Widget, false not to affect the Widget's show state.

Definition at line 555 of file Module.cpp.

FromWidget()

void DynExp::WindowStyleParamsExtension::FromWidget

(

const QWidget &

Widget

)

Assigns styles applied to Widget to the bundled parameters.

Parameters

Widget

Widget to retrieve the style from.

Definition at line 579 of file Module.cpp.

Member Data Documentation

WindowDockingState

ParamsBase::Param<WindowDockingStateType> DynExp::WindowStyleParamsExtension::WindowDockingState

Window docking state.

Definition at line 1623 of file Module.h.

WindowHeight

ParamsBase::Param<unsigned int> DynExp::WindowStyleParamsExtension::WindowHeight

Window height.

Definition at line 1621 of file Module.h.

WindowPosX

ParamsBase::Param<int> DynExp::WindowStyleParamsExtension::WindowPosX

Window x coordinate.

Definition at line 1618 of file Module.h.

WindowPosY

ParamsBase::Param<int> DynExp::WindowStyleParamsExtension::WindowPosY

Window y coordinate.

Definition at line 1619 of file Module.h.

WindowState

ParamsBase::Param<WindowStateType> DynExp::WindowStyleParamsExtension::WindowState

Window show state.

Definition at line 1622 of file Module.h.

WindowWidth

ParamsBase::Param<unsigned int> DynExp::WindowStyleParamsExtension::WindowWidth

Window width.

Definition at line 1620 of file Module.h.

---

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

• Module.h
• Module.cpp