Provides the bookmark toolbox which is mainly a view of the BookmarkModel. More...

#include <bookmarkDockWidget.h>

Inheritance diagram for ito::BookmarkDockWidget:

Public Member Functions
	BookmarkDockWidget (const QString &title, const QString &objName, QWidget *parent=NULL, bool docked=true, bool isDockAvailable=true, tFloatingStyle floatingStyle=floatingNone, tMovingStyle movingStyle=movingEnabled)
	Constructor for the toolbox.

	~BookmarkDockWidget ()
	Destructor for the toolbox.

void	setBookmarkModel (BookmarkModel *model)
	Set the BookmarkModel for this toolbox.

Public Member Functions inherited from ito::AbstractDockWidget
	AbstractDockWidget (bool docked, bool isDockAvailable, tFloatingStyle floatingStyle, tMovingStyle movingStyle, const QString &title=QString(), const QString &objName=QString(), QWidget *parent=0)
	constructor

virtual	~AbstractDockWidget ()
	destructor

bool	docked () const

RetVal	setTopLevel (tTopLevelStyle topLevel, bool showWindow=true)

void	setParent (QWidget *parent)

QWidget *	getActiveInstance ()

QRect	frameGeometry () const

const QRect &	geometry () const

QRect	normalGeometry () const

int	x () const

int	y () const

QPoint	pos () const

QSize	frameSize () const

QSize	size () const

int	width () const

int	height () const

QRect	rect () const

QRect	childrenRect () const

QRegion	childrenRegion () const

void	move (int x, int y)

void	move (const QPoint &)

void	resize (int w, int h)

void	resize (const QSize &)

void	setGeometry (int x, int y, int w, int h)

void	setGeometry (const QRect &)

void	setMinimumSize (const QSize &size)

QString	windowTitle ()

void	setWindowTitle (const QString &title)

bool	isEnabled () const

bool	isVisible () const

void	saveState (const QString &iniName) const

void	restoreState (const QString &iniName)

void	synchronizeTopLevelState ()
	synchronizes the top level state of the dock widget with the floating settings of this abstract dock widget

virtual QSize	sizeHint () const

virtual QSize	minimumSizeHint () const

Protected Member Functions
void	createActions ()
	this method creates all actions of this toolbox and is overloaded from AbstractDockWidget.

void	createMenus ()
	this method creates all menus of this toolbox and is overloaded from AbstractDockWidget.

void	createToolBars ()
	this method creates all menus of this toolbox and is overloaded from AbstractDockWidget.

void	createStatusBar ()
	this method is overloaded from AbstractDockWidget to initialize any status bars. Here it does nothing.

void	updateActions ()
	this method is overloaded from AbstractDockWidget and is called if any actions should be updated.

void	updatePythonActions ()
	this method is overloaded from AbstractDockWidget and is called whenever any Python relevant actions are changed. It does nothing.

Protected Member Functions inherited from ito::AbstractDockWidget
bool	eventFilter (QObject obj, QEvent event)
	eventFilter for m_pWindow

void	init ()
	init method, called by constructor

virtual void	closeEvent (QCloseEvent *event)
	closeEvent invoked if this AbstractDockWidget should be closed

Qt::WindowFlags	modifyFlags (const Qt::WindowFlags &flags, const Qt::WindowFlags &setFlags, const Qt::WindowFlags &unsetFlags)

virtual void	windowStateChanged (bool)

void	setContentWidget (QWidget *widget)
	sets any given QWidget as central widget of QMainWindow and inversely sets this QWidget's parent to the instance of QMainWindget

QWidget *	getContentWidget () const

QMainWindow *	getCanvas ()

bool	pythonBusy () const

bool	pythonDebugMode () const

bool	pythonInWaitingMode () const

QToolBar *	getToolBar (QString key) const
	returns reference to toolbar with given key-value

QMenuBar *	getMenuBar () const

RetVal	addToolBar (QToolBar *tb, const QString &key, Qt::ToolBarArea area=Qt::TopToolBarArea, int section=1)

RetVal	removeToolBar (const QString &key)

Private Slots
void	doubleClicked (const QModelIndex &index)
	This slot is executed when a bookmark has been double clicked.

void	treeViewContextMenuRequested (const QPoint &pos)
	This slot is executed when a context has been requested on the tree view of this toolbox.

Private Attributes
QTreeViewItom *	m_bookmarkView

QToolBar *	m_pMainToolbar

QMenu *	m_pContextMenu

BookmarkModel *	m_pModel

QAction *	m_pSpacerAction

Additional Inherited Members
Public Types inherited from ito::AbstractDockWidget
enum	tFloatingStyle { floatingNone , floatingStandard , floatingWindow }
	The floating style of a widget, derived from AbstractDockWidget. More...

enum	tMovingStyle { movingDisabled , movingEnabled }
	The configuration if a docked AbstractDockWidget can be moved from one docking area to another one. More...

enum	tTopLevelStyle { topLevelOverall , topLevelParentOnly , topLevelNothing }
	The top level style of a widget, derived from AbstractDockWidget. More...

Public Slots inherited from ito::AbstractDockWidget
void	setEnabled (bool)

virtual void	setVisible (bool visible)

virtual void	pythonStateChanged (tPythonTransitions pyTransition)
	slot invoked if python state changed. Sets the specific member variables according to the python transition.

void	raiseAndActivate ()
	activates this dock widget or window and raises it on top of all opened windows

void	mini ()

void	setDockSize (int newWidth, int newHeight)

void	dockWidget ()
	docks this dockWidget.

void	undockWidget (bool show_it=true)
	undocks this dockWidget.

RetVal	setAdvancedWindowTitle (QString newCompleteTitle=QString(), bool appendToBasicTitle=true)
	changes the title of widget

Signals inherited from ito::AbstractDockWidget
void	dockStateChanged (bool docked)
	emitted if the widget is either docked or undocked from the main window

Protected Attributes inherited from ito::AbstractDockWidget
QAction *	m_actStayOnTop

QAction *	m_actStayOnTopOfApp

Properties inherited from ito::AbstractDockWidget
bool	visible

bool	enabled

QRect	geometry

QRect	frameGeometry

QRect	normalGeometry

int	x

int	y

QPoint	pos

QSize	frameSize

QSize	size

int	width

int	height

QRect	rect

QRect	childrenRect

QRegion	childrenRegion

QString	windowTitle

Detailed Description

Provides the bookmark toolbox which is mainly a view of the BookmarkModel.

Constructor & Destructor Documentation

◆ BookmarkDockWidget()

ito::BookmarkDockWidget::BookmarkDockWidget	(	const QString &	title,
		const QString &	objName,
		QWidget *	parent = NULL,
		bool	docked = true,
		bool	isDockAvailable = true,
		tFloatingStyle	floatingStyle = floatingNone,
		tMovingStyle	movingStyle = movingEnabled )

Constructor for the toolbox.

Parameters

title	is the title of the toolbox
objName	is an internal object name for this toolbox, used to store its geometry and state at shutdown
parent	is an optional parent widget
docked	indicate if the toolbox should be docked per default
isDockAvailable	indicates if this toolbox can be docked in any case
floatingStyle	indicates the window floating style behaviour of this toolbox
movingStyle	indicates if this toolbox might be moved from one dockable area of itom's main window to another one or not.

Member Function Documentation

◆ createActions()

void ito::BookmarkDockWidget::createActions ( )

protectedvirtual

this method creates all actions of this toolbox and is overloaded from AbstractDockWidget.

Implements ito::AbstractDockWidget.

◆ createMenus()

void ito::BookmarkDockWidget::createMenus ( )

protectedvirtual

this method creates all menus of this toolbox and is overloaded from AbstractDockWidget.

Implements ito::AbstractDockWidget.

◆ createStatusBar()

void ito::BookmarkDockWidget::createStatusBar ( )

inlineprotectedvirtual

this method is overloaded from AbstractDockWidget to initialize any status bars. Here it does nothing.

Implements ito::AbstractDockWidget.

◆ createToolBars()

void ito::BookmarkDockWidget::createToolBars ( )

protectedvirtual

this method creates all menus of this toolbox and is overloaded from AbstractDockWidget.

Implements ito::AbstractDockWidget.

◆ setBookmarkModel()

void ito::BookmarkDockWidget::setBookmarkModel ( BookmarkModel * model )

Set the BookmarkModel for this toolbox.

Usually, the BookmarkModel is not available during construction of this toolbox, since the main window of itom is loaded earlier than the ScriptEditorOrganizer, which is the owner of the BookmarkModel.

Therefore the model is set via this method at a later time. However the model can only be set once. Further calls of this method will do nothing.

Parameters

model is a reference to the initialized BookmarkModel

◆ updateActions()

void ito::BookmarkDockWidget::updateActions ( )

protectedvirtual

this method is overloaded from AbstractDockWidget and is called if any actions should be updated.

Reimplemented from ito::AbstractDockWidget.

◆ updatePythonActions()

void ito::BookmarkDockWidget::updatePythonActions ( )

inlineprotectedvirtual

this method is overloaded from AbstractDockWidget and is called whenever any Python relevant actions are changed. It does nothing.

Implements ito::AbstractDockWidget.

Member Data Documentation

◆ m_bookmarkView

QTreeViewItom* ito::BookmarkDockWidget::m_bookmarkView

private

QTreeViewItom derived from QTreeView with some special selection behaviour (see QItomWidgets)

◆ m_pContextMenu

QMenu* ito::BookmarkDockWidget::m_pContextMenu

private

Context menu with the same actions as the toolbar

◆ m_pMainToolbar

QToolBar* ito::BookmarkDockWidget::m_pMainToolbar

private

Toolbar with QActions

◆ m_pModel

BookmarkModel* ito::BookmarkDockWidget::m_pModel

private

reference to the BookmarkModel. This widget is not the owner of the model.

◆ m_pSpacerAction

QAction* ito::BookmarkDockWidget::m_pSpacerAction

private

since the model is usually provided after having constructed this toolbox, some actions will be added to the toolbar in front of this action.

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

C:/Workspace/itom_development_VS2019_Qt5.15.2_x64/itomProject/itom/Qitom/widgets/bookmarkDockWidget.h
C:/Workspace/itom_development_VS2019_Qt5.15.2_x64/itomProject/itom/Qitom/widgets/bookmarkDockWidget.cpp

Public Member Functions

Protected Member Functions

Private Slots

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ BookmarkDockWidget()

Member Function Documentation

◆ createActions()

◆ createMenus()

◆ createStatusBar()

◆ createToolBars()

◆ setBookmarkModel()

◆ updateActions()

◆ updatePythonActions()

Member Data Documentation

◆ m_bookmarkView

◆ m_pContextMenu

◆ m_pMainToolbar

◆ m_pModel

◆ m_pSpacerAction