QmaxDockWidget Class Reference

#include <C:/adskgit/3dsmax/3dsmax/3dswin/src/maxsdk/include/Qt/QmaxDockWidget.h>

Inheritance diagram for QmaxDockWidget:

Signals
void	orientationChanged (Qt::Orientation orientation)
	Emitted when the dock widget orientation has changed.

Public Member Functions
	QmaxDockWidget (const QString &objectName, const QString &title, QWidget *parent=nullptr, Qt::WindowFlags flags={})
	QmaxDockWidget (QmaxMainWindow::QmaxDockType dockType, const QString &objectName, const QString &title, QWidget *parent=nullptr, Qt::WindowFlags flags={})
	QmaxDockWidget (QWidget *parent=nullptr, Qt::WindowFlags flags={})
virtual	~QmaxDockWidget () override
bool	loadCUIContent (const QString &fileName, int startup)
	Loads CUI content from a file into the dock widget.
void	saveCUIContent (const QString &fileName)
	Save CUI content from the dock widget into a file.
void	setMaxDockType (QmaxMainWindow::QmaxDockType dockType)
	Sets the 3ds Max dock type on the dock widget.
QmaxMainWindow::QmaxDockType	maxDockType () const
	Returns the 3ds Max dock type for the widget.
void	setMaxDockFlags (QmaxMainWindow::QmaxDockFlags dockFlags)
	Sets the 3ds Max specific dock flags on the dock widget.
void	addMaxDockFlags (QmaxMainWindow::QmaxDockFlags dockFlags)
	Adds the 3ds Max specific dock flags on the dock widget.
QmaxMainWindow::QmaxDockFlags	maxDockFlags () const
	Returns the 3ds Max specific dock flags for the dock widget.
Qt::Orientation	orientation () const
	Returns the orientation of the dock widget.
void	setOrientation (Qt::Orientation orientation)
	Sets the orientation of the dock widget.
Qt::DockWidgetArea	dockWidgetArea ()
	Returns the docking area of the dock widget in the parent main window layout.

Protected Member Functions
bool	event (QEvent *evt) override
void	paintEvent (QPaintEvent *evt) override
bool	nativeEvent (const QByteArray &eventType, void *message, qintptr *result) override

Properties
Qt::Orientation	orientation
	The orientation of the dock widget.

Constructor & Destructor Documentation

QmaxDockWidget() [1/3]

QmaxDockWidget ( const QString & objectName, const QString & title, QWidget * parent = nullptr, Qt::WindowFlags flags = {} )

explicit

QmaxDockWidget() [2/3]

QmaxDockWidget ( QmaxMainWindow::QmaxDockType dockType, const QString & objectName, const QString & title, QWidget * parent = nullptr, Qt::WindowFlags flags = {} )

explicit

QmaxDockWidget() [3/3]

QmaxDockWidget ( QWidget * parent = nullptr, Qt::WindowFlags flags = {} )

explicit

~QmaxDockWidget()

virtual ~QmaxDockWidget ( )

overridevirtual

Member Function Documentation

loadCUIContent()

bool loadCUIContent	(	const QString &	fileName,
		int	startup )

Loads CUI content from a file into the dock widget.

See also

saveCUIContent()

saveCUIContent()

void saveCUIContent

(

const QString &

fileName

)

Save CUI content from the dock widget into a file.

See also

loadCUIContent()

setMaxDockType()

void setMaxDockType ( QmaxMainWindow::QmaxDockType dockType )

inline

Sets the 3ds Max dock type on the dock widget.

Parameters

[in]

dockType

The dock type of the actual docking content.

See also

maxDockType()

{ QmaxMainWindow::setMaxDockType( this, dockType ); }

maxDockType()

QmaxMainWindow::QmaxDockType maxDockType ( ) const

inline

Returns the 3ds Max dock type for the widget.

See also

setMaxDockType()

{ return QmaxMainWindow::maxDockType( this ); }

setMaxDockFlags()

void setMaxDockFlags ( QmaxMainWindow::QmaxDockFlags dockFlags )

inline

Sets the 3ds Max specific dock flags on the dock widget.

Parameters

[in]

dockFlags

The 3ds Max specific dock flags.

See also

maxDockFlags(), addMaxDockFlags()

{ QmaxMainWindow::setMaxDockFlags( this, dockFlags ); }

addMaxDockFlags()

void addMaxDockFlags ( QmaxMainWindow::QmaxDockFlags dockFlags )

inline

Adds the 3ds Max specific dock flags on the dock widget.

Parameters

[in]

dockFlags

The 3ds Max specific dock flags.

See also

maxDockFlags(), setMaxDockFlags()

{ QmaxMainWindow::addMaxDockFlags( this, dockFlags ); }

maxDockFlags()

QmaxMainWindow::QmaxDockFlags maxDockFlags ( ) const

inline

Returns the 3ds Max specific dock flags for the dock widget.

See also

setMaxDockFlags(), addMaxDockFlags()

{ return QmaxMainWindow::maxDockFlags( this ); }    

orientation()

Qt::Orientation orientation

(

)

const

Returns the orientation of the dock widget.

See also

setOrientation()

setOrientation()

void setOrientation

(

Qt::Orientation

orientation

)

Sets the orientation of the dock widget.

See also

orientation()

dockWidgetArea()

Qt::DockWidgetArea dockWidgetArea

(

)

Returns the docking area of the dock widget in the parent main window layout.

If dock widget has not been added to a main window, the return value will be Qt::NoDockWidgetArea.

orientationChanged

void orientationChanged ( Qt::Orientation orientation )

signal

Emitted when the dock widget orientation has changed.

Parameters

orientation

The new dock widget orientation.

See also

orientation(), setOrientation().

event()

bool event ( QEvent * evt )

overrideprotected

paintEvent()

void paintEvent ( QPaintEvent * evt )

overrideprotected

nativeEvent()

bool nativeEvent ( const QByteArray & eventType, void * message, qintptr * result )

overrideprotected

Property Documentation

orientation

Qt::Orientation orientation

readwrite

The orientation of the dock widget.

The orientation property for the dock widget works equivalent to the orientation of the QToolBar. When the QmaxDockWidget is in a QMainWindow docking layout then the orientation will be managed by the system. For the left and right dock area the orientation will be Qt::Vertical. Which means top-down, the title bar is on top of the dock widget. For the top and bottom dock area the orientation will be Qt::Horizontal.

See also

orientation(), setOrientation()