MainArea Class Reference

main window area It is implemented as a MDI (multi document interface). This allows you to add custom widgets to it. More...

#include <main_area.hh>

Public Member Functions
	MainArea (QWidget *parent=NULL)
void	EnableTabbedMode (bool tabbed_mode=true)
void	AddWidget (const QString &title, QWidget *widget)
void	AddPersistentWidget (const QString &title, const QString &name, QWidget *widget, int width, int height, int x, int y)
void	AddPersistentWidget (const QString &title, const QString &name, QWidget *widget, Qt::WindowStates window_state=Qt::WindowStates())
void	ShowSubWindow (QWidget *widget)
void	HideSubWindow (QWidget *widget)

---

Detailed Description

main window area It is implemented as a MDI (multi document interface). This allows you to add custom widgets to it.

Definition at line 34 of file main_area.hh.

---

Constructor & Destructor Documentation

MainArea

(

QWidget *

parent = NULL

)

---

Member Function Documentation

void AddPersistentWidget	(	const QString &	title,
		const QString &	name,
		QWidget *	widget,
		Qt::WindowStates	window_state = Qt::WindowStates()
	)

add a widget with custom window states to the ui. The Geometry is preserved across application relaunches

See also:

AddPersistentWidget(const QString& title, const QString& name, QWidget* widget, int width, int height, int x, int y)

Parameters:

	title	string that is displayed in the gui
	name	is the unique name (within the scope of the main area) for the widget that is used to restore and save the widget geometry.
	widget	is the widget to be added to the main area.
	window_state	custom window_state for the widget. See Qt Documentation to learn more about WindowStates.

void AddPersistentWidget	(	const QString &	title,
		const QString &	name,
		QWidget *	widget,
		int	width,
		int	height,
		int	x,
		int	y
	)

add a widget whose geometry is preserved across application relaunches

For widgets that are volatile, use AddWidget()

If tabbed mode is enabled, the widget geometry is ignored.

Parameters:

	title	string that is displayed in the gui
	name	is the unique name (within the scope of the main area) for the widget that is used to restore and save the widget geometry.
	widget	is the widget to be added to the main area.
	width	width of the widget inside the mdi
	height	height of the widget inside the mdi
	x	x position of the widget inside the mdi
	y	y position of the widget inside the mdi

See also:

AddWidget

void AddWidget	(	const QString &	title,
		QWidget *	widget
	)

add volatile widget

Parameters:

	title	string that is displayed in the gui
	widget	is the widget to be added to the main area.

void EnableTabbedMode

(

bool

tabbed_mode = true

)

switch between free window and tabbed window mode

void HideSubWindow

(

QWidget *

widget

)

hides the given widget inside the main area This method can be used to hide a widget that has been added to this mdi area. This method should only be called if you are sure, that the widget has been added to the main area. Otherwise, there might be an unexpected behaviour!

Parameters:

widget

which you want to hide

void ShowSubWindow

(

QWidget *

widget

)

display the given widget inside the main area This method can be used to make a widget visible that has been added to the mdi area. This method should only be called if you are sure, that the widget has been added to the main area. Otherwise, there might be an unexpected behaviour!

Parameters:

widget

which you want to make visible

---

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

• stage/include/ost/gui/main_area.hh