Functions
UICORE_API_EXPORT void	addEventHandler (UID _windowUID, aWindowEventHandler *_eventHandler)
	Will add the provided event handler to the window.

UICORE_API_EXPORT void	close (UID _windowUID)
	Will close the provided window.

UICORE_API_EXPORT void	removeEventHandler (UID _windowUID, aWindowEventHandler *_eventHandler)
	Will remove the provided event handler from the window.

UICORE_API_EXPORT void	setStatusLabelVisible (UID _windowUID, bool _visible=true, bool _delayed=true)
	Will set the visible state of the status label of the provided window.

UICORE_API_EXPORT void	setStatusProgressVisible (UID _windowUID, bool _visible=true, bool _delayed=true)
	Will set the visible state of the status progress bar of the provided window.

UICORE_API_EXPORT void	setStatusLabelText (UID _windowUID, const QString &_text)
	Will set the status label text at the provided window.

UICORE_API_EXPORT void	setStatusProgressValue (UID _windowUID, int _value)
	Will set the value of the status progress bar at the provided window.

UICORE_API_EXPORT void	setStatusProgressContinuous (UID _windowUID, bool _continuous=true)
	Will set the continuous option of the status progress bar at the provided window.

UICORE_API_EXPORT void	setTabToolBarVisible (UID _windowUID, bool _visible=true)
	Will set the visible state of the tabToolbar in the specified window.

UICORE_API_EXPORT void	setTabToolbarDoubleClickEnabled (UID _windowUID, bool _isEnabled)
	Will set the enabled state of double click event in the tab toolbar.

UICORE_API_EXPORT ID	getCurrentTabToolBarTab (UID _windowUID)
	Will return the current tab of the tab tool bar at the specified window.

UICORE_API_EXPORT std::string	getCurrentToolBarTabText (UID _windowUID)

UICORE_API_EXPORT int	getTabToolBarTabCount (UID _windowUID)
	Will return the tab count of the tab tool bar at the specified window.

UICORE_API_EXPORT void	enableTabToolBar (UID _windowUID, bool _enable)
	Will enable or disable the tab tool bar at the specified window.

UICORE_API_EXPORT void	setCurrentTabToolBarTab (UID _windowUID, ID _tabID)
	Will set the specified tab toolbar tab as current at the specified window.

UICORE_API_EXPORT void	setCurrentTabToolBarTab (UID _windowUID, const QString &_tabName)

UICORE_API_EXPORT void	setTitle (UID _windowUID, const QString &_title)
	Will set the title at the specified window.

UICORE_API_EXPORT void	setWindowIcon (UID _windowUID, const QIcon &_icon)
	Will set the icon at the specified window.

UICORE_API_EXPORT bool	getStatusLabelVisible (UID _windowUID)
	Will return true if the status label is visible at the provided window.

UICORE_API_EXPORT bool	getStatusProgressVisible (UID _windowUID)
	Will return true if the status progress bar is visible at the provided window.

UICORE_API_EXPORT QString	getStatusLabelText (UID _windowUID)
	Will return the status label text at the provided window.

UICORE_API_EXPORT int	getStatusProgressValue (UID _windowUID)
	Will return the status progress bar value at the provided window.

UICORE_API_EXPORT bool	getStatusProgressContinuous (UID _windowUID)
	Will return the continuous option of the status progress bar at the provided window.

UICORE_API_EXPORT void	setCentralWidget (UID _windowUID, UID _widgetUID)
	Will set the windows central widget (The widget will be added to a container, the actual central widget differs)

UICORE_API_EXPORT void	setCentralWidget (UID _windowUID, QWidget *_widget)
	Will set the windows central widget (The widget will be added to a container, the actual central widget differs)

UICORE_API_EXPORT void	showMaximized (UID _windowUID)
	Will show the window as maximized.

UICORE_API_EXPORT void	showNormal (UID _windowUID)
	Will show the window.

UICORE_API_EXPORT void	showMinimized (UID _windowUID)
	Will show the window as minimized.

UICORE_API_EXPORT QSize	size (UID _windowUID)
	Will return the size of the window.

UICORE_API_EXPORT QPoint	position (UID _windowUID)
	Will return the position of the window.

UICORE_API_EXPORT void	setWaitingAnimationVisible (UID _windowUID, bool _visible=true)
	Will set the visible state of the waiting animation.

UICORE_API_EXPORT void	setWaitingAnimation (UID _windowUID, QMovie *_movie)
	Will set the movie as waiting animation in the window.

UICORE_API_EXPORT void	setWaitingAnimation (UID _windowUID, const QString &_animationName)
	Will set the animation as waiting animation in the window.

UICORE_API_EXPORT void	setCentralWidgetMinimumSize (UID _windowUID, int _width, int _height)
	Will set the central widget minimum size.

UICORE_API_EXPORT double	devicePixelRatio (void)
	Will return the device pixel ratio of the currently used device.

UICORE_API_EXPORT void	resize (UID _windowUID, int _width, int _height)
	Will resize the window.

UICORE_API_EXPORT std::string	saveState (UID _windowUID, std::string _currentState="")
	Will return the state of the window so it can be restored.

UICORE_API_EXPORT bool	restoreState (UID _windowUID, const std::string &_state, bool _setPositionAndSize=true)
	Will return the state of the window so it can be restored.

UICORE_API_EXPORT void	setTabToolBarTabOrder (UID _windowUID, const QStringList &_list)

UICORE_API_EXPORT void	activateToolBarTab (UID _windowUID, const QString &_tabName)

Function Documentation

◆ activateToolBarTab()

void ak::uiAPI::window::activateToolBarTab	(	UID	_windowUID,
		const QString &	_tabName )

◆ addEventHandler()

void ak::uiAPI::window::addEventHandler	(	UID	_windowUID,
		aWindowEventHandler *	_eventHandler )

Will add the provided event handler to the window.

Parameters

_windowUID	The UID of the window
_eventHandler	The event handler to add

◆ close()

void ak::uiAPI::window::close ( UID _windowUID )

Will close the provided window.

Parameters

_windowUID The UID of the uiManager to close

◆ devicePixelRatio()

double ak::uiAPI::window::devicePixelRatio ( void )

Will return the device pixel ratio of the currently used device.

◆ enableTabToolBar()

void ak::uiAPI::window::enableTabToolBar	(	UID	_windowUID,
		bool	_enable )

Will enable or disable the tab tool bar at the specified window.

Parameters

_windowUID	The UID of the window
_enable	A flag indicating whetehr the toolbar shall be enabled or disabled

◆ getCurrentTabToolBarTab()

ak::ID ak::uiAPI::window::getCurrentTabToolBarTab ( UID _windowUID )

Will return the current tab of the tab tool bar at the specified window.

Parameters

_windowUID The UID of the window

◆ getCurrentToolBarTabText()

std::string ak::uiAPI::window::getCurrentToolBarTabText ( UID _windowUID )

◆ getStatusLabelText()

QString ak::uiAPI::window::getStatusLabelText ( UID _windowUID )

Will return the status label text at the provided window.

Parameters

_windowUID The UID of the window

◆ getStatusLabelVisible()

bool ak::uiAPI::window::getStatusLabelVisible ( UID _windowUID )

Will return true if the status label is visible at the provided window.

Parameters

_windowUID The UID of the window

◆ getStatusProgressContinuous()

bool ak::uiAPI::window::getStatusProgressContinuous ( UID _windowUID )

Will return the continuous option of the status progress bar at the provided window.

Parameters

_windowUID The UID of the window

◆ getStatusProgressValue()

int ak::uiAPI::window::getStatusProgressValue ( UID _windowUID )

Will return the status progress bar value at the provided window.

Parameters

_windowUID The UID of the window

◆ getStatusProgressVisible()

bool ak::uiAPI::window::getStatusProgressVisible ( UID _windowUID )

Will return true if the status progress bar is visible at the provided window.

Parameters

_windowUID The UID of the window

◆ getTabToolBarTabCount()

int ak::uiAPI::window::getTabToolBarTabCount ( UID _windowUID )

Will return the tab count of the tab tool bar at the specified window.

Parameters

_windowUID The UID of the window

◆ position()

QPoint ak::uiAPI::window::position ( UID _windowUID )

Will return the position of the window.

Parameters

_windowUID The UID of the window

◆ removeEventHandler()

void ak::uiAPI::window::removeEventHandler	(	UID	_windowUID,
		aWindowEventHandler *	_eventHandler )

Will remove the provided event handler from the window.

Parameters

_windowUID	The UID of the window
_eventHandler	The event handler to remove

◆ resize()

void ak::uiAPI::window::resize	(	UID	_windowUID,
		int	_width,
		int	_height )

Will resize the window.

◆ restoreState()

bool ak::uiAPI::window::restoreState	(	UID	_windowUID,
		const std::string &	_state,
		bool	_setPositionAndSize = true )

Will return the state of the window so it can be restored.

◆ saveState()

std::string ak::uiAPI::window::saveState	(	UID	_windowUID,
		std::string	_currentState = "" )

Will return the state of the window so it can be restored.

◆ setCentralWidget() [1/2]

void ak::uiAPI::window::setCentralWidget	(	UID	_windowUID,
		QWidget *	_widget )

Will set the windows central widget (The widget will be added to a container, the actual central widget differs)

Parameters

_windowUID	The UID of the window
_widget	The widget to set as central widget

◆ setCentralWidget() [2/2]

void ak::uiAPI::window::setCentralWidget	(	UID	_windowUID,
		UID	_widgetUID )

Will set the windows central widget (The widget will be added to a container, the actual central widget differs)

Parameters

_windowUID	The UID of the window
_widgetUID	The widget UID of the widget to set as central widget

◆ setCentralWidgetMinimumSize()

void ak::uiAPI::window::setCentralWidgetMinimumSize	(	UID	_windowUID,
		int	_width,
		int	_height )

Will set the central widget minimum size.

Parameters

_windowUID	The UID of the window
_width	The width to set
_height	The height to set

◆ setCurrentTabToolBarTab() [1/2]

void ak::uiAPI::window::setCurrentTabToolBarTab	(	UID	_windowUID,
		const QString &	_tabName )

◆ setCurrentTabToolBarTab() [2/2]

void ak::uiAPI::window::setCurrentTabToolBarTab	(	UID	_windowUID,
		ID	_tabID )

Will set the specified tab toolbar tab as current at the specified window.

Parameters

_windowUID	The UID of the window
_tabID	The tab to set as current

◆ setStatusLabelText()

void ak::uiAPI::window::setStatusLabelText	(	UID	_windowUID,
		const QString &	_text )

Will set the status label text at the provided window.

Parameters

_windowUID	The UID of the window
_text	The text to set

◆ setStatusLabelVisible()

void ak::uiAPI::window::setStatusLabelVisible	(	UID	_windowUID,
		bool	_visible = true,
		bool	_delayed = true )

Will set the visible state of the status label of the provided window.

Parameters

_windowUID	The UID of the window
_visible	If true the status label will be visible

◆ setStatusProgressContinuous()

void ak::uiAPI::window::setStatusProgressContinuous	(	UID	_windowUID,
		bool	_continuous = true )

Will set the continuous option of the status progress bar at the provided window.

Parameters

_windowUID	The UID of the window
_continuous	If true the status progress bar will be displayed as a continuous bar

◆ setStatusProgressValue()

void ak::uiAPI::window::setStatusProgressValue	(	UID	_windowUID,
		int	_value )

Will set the value of the status progress bar at the provided window.

Parameters

_windowUID	The UID of the window
_value	The value to set (0 - 100)

◆ setStatusProgressVisible()

void ak::uiAPI::window::setStatusProgressVisible	(	UID	_windowUID,
		bool	_visible = true,
		bool	_delayed = true )

Will set the visible state of the status progress bar of the provided window.

Parameters

_windowUID	The UID of the window
_visible	If true the status progress bar will be visible

◆ setTabToolbarDoubleClickEnabled()

void ak::uiAPI::window::setTabToolbarDoubleClickEnabled	(	UID	_windowUID,
		bool	_isEnabled )

Will set the enabled state of double click event in the tab toolbar.

◆ setTabToolBarTabOrder()

void ak::uiAPI::window::setTabToolBarTabOrder	(	UID	_windowUID,
		const QStringList &	_list )

◆ setTabToolBarVisible()

void ak::uiAPI::window::setTabToolBarVisible	(	UID	_windowUID,
		bool	_visible = true )

Will set the visible state of the tabToolbar in the specified window.

Parameters

_windowUID	The UID of the window
_visible	If true the tabToolbar will be visible

◆ setTitle()

void ak::uiAPI::window::setTitle	(	UID	_windowUID,
		const QString &	_title )

Will set the title at the specified window.

Parameters

_windowUID	The UID of the window
_title	The title to set

◆ setWaitingAnimation() [1/2]

void ak::uiAPI::window::setWaitingAnimation	(	UID	_windowUID,
		const QString &	_animationName )

Will set the animation as waiting animation in the window.

Parameters

_windowUID	The UID of the window
_animationName	The name of the animation

◆ setWaitingAnimation() [2/2]

void ak::uiAPI::window::setWaitingAnimation	(	UID	_windowUID,
		QMovie *	_movie )

Will set the movie as waiting animation in the window.

Parameters

_windowUID	The UID of the window
_movie	The movie to set

◆ setWaitingAnimationVisible()

void ak::uiAPI::window::setWaitingAnimationVisible	(	UID	_windowUID,
		bool	_visible = true )

Will set the visible state of the waiting animation.

Parameters

_windowUID	The UID of the window
_visible	The visible state to set

◆ setWindowIcon()

void ak::uiAPI::window::setWindowIcon	(	UID	_windowUID,
		const QIcon &	_icon )

Will set the icon at the specified window.

Parameters

_windowUID	The UID of the window
_icon	The icon to set

◆ showMaximized()

void ak::uiAPI::window::showMaximized ( UID _windowUID )

Will show the window as maximized.

Parameters

_windowUID The UID of the window

◆ showMinimized()

void ak::uiAPI::window::showMinimized ( UID _windowUID )

Will show the window as minimized.

Parameters

_windowUID The UID of the window

◆ showNormal()

void ak::uiAPI::window::showNormal ( UID _windowUID )

Will show the window.

Parameters

_windowUID The UID of the window

◆ size()

QSize ak::uiAPI::window::size ( UID _windowUID )

Will return the size of the window.

Parameters

_windowUID The UID of the window

	OpenTwin 0.1 OpenTwin

Functions

Function Documentation

◆ activateToolBarTab()

◆ addEventHandler()

◆ close()

◆ devicePixelRatio()

◆ enableTabToolBar()

◆ getCurrentTabToolBarTab()

◆ getCurrentToolBarTabText()

◆ getStatusLabelText()

◆ getStatusLabelVisible()

◆ getStatusProgressContinuous()

◆ getStatusProgressValue()

◆ getStatusProgressVisible()

◆ getTabToolBarTabCount()

◆ position()

◆ removeEventHandler()

◆ resize()

◆ restoreState()

◆ saveState()

◆ setCentralWidget() [1/2]

◆ setCentralWidget() [2/2]

◆ setCentralWidgetMinimumSize()

◆ setCurrentTabToolBarTab() [1/2]

◆ setCurrentTabToolBarTab() [2/2]

◆ setStatusLabelText()

◆ setStatusLabelVisible()

◆ setStatusProgressContinuous()

◆ setStatusProgressValue()

◆ setStatusProgressVisible()

◆ setTabToolbarDoubleClickEnabled()

◆ setTabToolBarTabOrder()

◆ setTabToolBarVisible()

◆ setTitle()

◆ setWaitingAnimation() [1/2]

◆ setWaitingAnimation() [2/2]

◆ setWaitingAnimationVisible()

◆ setWindowIcon()

◆ showMaximized()

◆ showMinimized()

◆ showNormal()

◆ size()