Class SBGWindowDock

ClassList > SBGWindowDock

This class describes a dock window. More...

• #include "SBGWindowDock.hpp"

Inherits the following classes: QDockWidget

Public Signals

Type	Name
signal void	closed Emitted when the dock window is closed by the user.
signal void	locked (bool) Emitted when the dock window is locked or unlocked.
signal void	shown (bool) Emitted when the dock window is shown or hidden.

Public Functions

Type	Name
	SBGWindowDock (QWidget * widget, QString title, QWidget * parent, Qt::WindowFlags flags) Constructor.
	SB_DECLARE_DATA (SBGWindowDock)
bool	getCitableWindowFlag () const Returns whether the citable window flag.
SBGWindowWidget *	getEmbeddedWidget () const Returns the embedded widget.
SBUUID	getPreferencesUUID () const Returns the UUID of preferences (static attributes), if present.
bool	getSavableWindowFlag () const Returns whether the window options can be saved.
SBCContainerUUID	getUUID () const Returns the UUID.
bool	isLocked () const Returns whether the dock window is locked.
void	loadDefaultSettings () Loads the default settings of the window.
virtual void	print (unsigned int offset=0) const Prints some debugging information.
void	saveDefaultSettings () Saves the default settings of the window.
void	setCitableWindowFlag (bool flag) Sets whether the citable window flag.
void	setEmbeddedWidget (SBGWindowWidget * embeddedWidget) Sets the embedded widget.
void	setPreferencesUUID (const SBUUID & preferencesUUID) Sets the UUID of preferences (static attributes), if present.
void	setSavableWindowFlag (bool flag) Sets whether the window options can be saved.
void	setUUID (const SBCContainerUUID & uuid) Sets the UUID.
virtual	~SBGWindowDock () Destructor.

Protected Attributes

Type	Name
SBGWindowDockData *	dataPointer

Protected Functions

Type	Name
virtual void	changeEvent (QEvent * event) Handles events.
virtual bool	event (QEvent * event) Handles events.
virtual void	hideEvent (QHideEvent * event) Handles hide event.
virtual void	paintEvent (QPaintEvent * event) Handles paint event.
virtual void	resizeEvent (QResizeEvent * event) Handles resize events.
virtual void	showEvent (QShowEvent * event) Handles show event.
virtual void	wheelEvent (QWheelEvent * event) Handles mouse wheel events.

Detailed Description

Short name: SBWindowDock

Public Signals Documentation

signal closed

Emitted when the dock window is closed by the user.

void SBGWindowDock::closed;

---

signal locked

Emitted when the dock window is locked or unlocked.

void SBGWindowDock::locked;

---

signal shown

Emitted when the dock window is shown or hidden.

void SBGWindowDock::shown;

---

Public Functions Documentation

function SBGWindowDock

Constructor.

SBGWindowDock::SBGWindowDock (
    QWidget * widget,
    QString title,
    QWidget * parent,
    Qt::WindowFlags flags
) 

---

function SB_DECLARE_DATA

SBGWindowDock::SB_DECLARE_DATA (
    SBGWindowDock
) 

---

function getCitableWindowFlag

Returns whether the citable window flag.

bool SBGWindowDock::getCitableWindowFlag () const

---

function getEmbeddedWidget

Returns the embedded widget.

SBGWindowWidget * SBGWindowDock::getEmbeddedWidget () const

---

function getPreferencesUUID

Returns the UUID of preferences (static attributes), if present.

SBUUID SBGWindowDock::getPreferencesUUID () const

---

function getSavableWindowFlag

Returns whether the window options can be saved.

bool SBGWindowDock::getSavableWindowFlag () const

---

function getUUID

Returns the UUID.

SBCContainerUUID SBGWindowDock::getUUID () const

---

function isLocked

Returns whether the dock window is locked.

bool SBGWindowDock::isLocked () const

---

function loadDefaultSettings

Loads the default settings of the window.

void SBGWindowDock::loadDefaultSettings () 

---

function print

Prints some debugging information.

virtual void SBGWindowDock::print (
    unsigned int offset=0
) const

---

function saveDefaultSettings

Saves the default settings of the window.

void SBGWindowDock::saveDefaultSettings () 

---

function setCitableWindowFlag

Sets whether the citable window flag.

void SBGWindowDock::setCitableWindowFlag (
    bool flag
) 

---

function setEmbeddedWidget

Sets the embedded widget.

void SBGWindowDock::setEmbeddedWidget (
    SBGWindowWidget * embeddedWidget
) 

---

function setPreferencesUUID

Sets the UUID of preferences (static attributes), if present.

void SBGWindowDock::setPreferencesUUID (
    const SBUUID & preferencesUUID
) 

---

function setSavableWindowFlag

Sets whether the window options can be saved.

void SBGWindowDock::setSavableWindowFlag (
    bool flag
) 

---

function setUUID

Sets the UUID.

void SBGWindowDock::setUUID (
    const SBCContainerUUID & uuid
) 

---

function ~SBGWindowDock

Destructor.

virtual SBGWindowDock::~SBGWindowDock () 

---

Protected Attributes Documentation

variable dataPointer

SBGWindowDockData* SBGWindowDock::dataPointer;

---

Protected Functions Documentation

function changeEvent

Handles events.

virtual void SBGWindowDock::changeEvent (
    QEvent * event
) 

---

function event

Handles events.

virtual bool SBGWindowDock::event (
    QEvent * event
) 

---

function hideEvent

Handles hide event.

virtual void SBGWindowDock::hideEvent (
    QHideEvent * event
) 

---

function paintEvent

Handles paint event.

virtual void SBGWindowDock::paintEvent (
    QPaintEvent * event
) 

---

function resizeEvent

Handles resize events.

virtual void SBGWindowDock::resizeEvent (
    QResizeEvent * event
) 

---

function showEvent

Handles show event.

virtual void SBGWindowDock::showEvent (
    QShowEvent * event
) 

---

function wheelEvent

Handles mouse wheel events.

virtual void SBGWindowDock::wheelEvent (
    QWheelEvent * event
) 

---