The QgsLayerTreeView class extends QTreeView and provides some additional functionality when working with a layer tree. More...

#include <qgslayertreeview.h>

Inheritance diagram for QgsLayerTreeView:

[legend]

Public Slots
void	collapseAllNodes ()
	Enhancement of QTreeView::collapseAll() that also records expanded state in layer tree nodes. More...

void	expandAllNodes ()
	Enhancement of QTreeView::expandAll() that also records expanded state in layer tree nodes. More...

void	refreshLayerSymbology (const QString &layerId)
	Force refresh of layer symbology. Normally not needed as the changes of layer's renderer are monitored by the model. More...

Signals
void	currentLayerChanged (QgsMapLayer *layer)
	Emitted when a current layer is changed. More...

Public Member Functions
	QgsLayerTreeView (QWidget *parent=nullptr)

	~QgsLayerTreeView ()

QgsLayerTreeGroup *	currentGroupNode () const
	Get current group node. If a layer is current node, the function will return parent group. May be null. More...

QgsMapLayer *	currentLayer () const
	Get currently selected layer. May be null. More...

QgsLayerTreeModelLegendNode *	currentLegendNode () const
	Get current legend node. More...

QgsLayerTreeNode *	currentNode () const
	Get current node. May be null. More...

QgsLayerTreeViewDefaultActions *	defaultActions ()
	Get access to the default actions that may be used with the tree view. More...

QgsLayerTreeModel *	layerTreeModel () const
	Get access to the model casted to QgsLayerTreeModel. More...

QgsLayerTreeViewMenuProvider *	menuProvider () const
	Return pointer to the context menu provider. May be null. More...

QList< QgsLayerTreeLayer * >	selectedLayerNodes () const
	Return list of selected nodes filtered to just layer nodes. More...

QList< QgsMapLayer * >	selectedLayers () const
	Get list of selected layers. More...

QList< QgsLayerTreeNode * >	selectedNodes (bool skipInternal=false) const
	Return list of selected nodes. More...

void	setCurrentLayer (QgsMapLayer *layer)
	Set currently selected layer. Null pointer will deselect any layer. More...

void	setMenuProvider (QgsLayerTreeViewMenuProvider *menuProvider)
	Set provider for context menu. Takes ownership of the instance. More...

virtual void	setModel (QAbstractItemModel *model) override
	Overridden setModel() from base class. Only QgsLayerTreeModel is an acceptable model. More...

Public Member Functions inherited from QTreeView
	QTreeView (QWidget *parent)

	~QTreeView ()

bool	allColumnsShowFocus () const

int	autoExpandDelay () const

void	collapse (const QModelIndex &index)

void	collapseAll ()

void	collapsed (const QModelIndex &index)

int	columnAt (int x) const

int	columnViewportPosition (int column) const

int	columnWidth (int column) const

virtual void	dataChanged (const QModelIndex &topLeft, const QModelIndex &bottomRight)

void	expand (const QModelIndex &index)

void	expandAll ()

void	expanded (const QModelIndex &index)

bool	expandsOnDoubleClick () const

void	expandToDepth (int depth)

QHeaderView *	header () const

void	hideColumn (int column)

int	indentation () const

QModelIndex	indexAbove (const QModelIndex &index) const

virtual QModelIndex	indexAt (const QPoint &point) const

QModelIndex	indexBelow (const QModelIndex &index) const

bool	isAnimated () const

bool	isColumnHidden (int column) const

bool	isExpanded (const QModelIndex &index) const

bool	isFirstColumnSpanned (int row, const QModelIndex &parent) const

bool	isHeaderHidden () const

bool	isRowHidden (int row, const QModelIndex &parent) const

bool	isSortingEnabled () const

bool	itemsExpandable () const

virtual void	keyboardSearch (const QString &search)

virtual void	reset ()

void	resizeColumnToContents (int column)

bool	rootIsDecorated () const

virtual void	scrollTo (const QModelIndex &index, ScrollHint hint)

virtual void	selectAll ()

void	setAllColumnsShowFocus (bool enable)

void	setAnimated (bool enable)

void	setAutoExpandDelay (int delay)

void	setColumnHidden (int column, bool hide)

void	setColumnWidth (int column, int width)

void	setExpanded (const QModelIndex &index, bool expanded)

void	setExpandsOnDoubleClick (bool enable)

void	setFirstColumnSpanned (int row, const QModelIndex &parent, bool span)

void	setHeader (QHeaderView *header)

void	setHeaderHidden (bool hide)

void	setIndentation (int i)

void	setItemsExpandable (bool enable)

virtual void	setRootIndex (const QModelIndex &index)

void	setRootIsDecorated (bool show)

void	setRowHidden (int row, const QModelIndex &parent, bool hide)

virtual void	setSelectionModel (QItemSelectionModel *selectionModel)

void	setSortingEnabled (bool enable)

void	setUniformRowHeights (bool uniform)

void	setWordWrap (bool on)

void	showColumn (int column)

void	sortByColumn (int column)

void	sortByColumn (int column, Qt::SortOrder order)

bool	uniformRowHeights () const

virtual QRect	visualRect (const QModelIndex &index) const

bool	wordWrap () const

Public Member Functions inherited from QAbstractItemView
	QAbstractItemView (QWidget *parent)

	~QAbstractItemView ()

void	activated (const QModelIndex &index)

bool	alternatingRowColors () const

int	autoScrollMargin () const

void	clearSelection ()

void	clicked (const QModelIndex &index)

void	closePersistentEditor (const QModelIndex &index)

QModelIndex	currentIndex () const

Qt::DropAction	defaultDropAction () const

void	doubleClicked (const QModelIndex &index)

DragDropMode	dragDropMode () const

bool	dragDropOverwriteMode () const

bool	dragEnabled () const

void	edit (const QModelIndex &index)

EditTriggers	editTriggers () const

void	entered (const QModelIndex &index)

bool	hasAutoScroll () const

ScrollMode	horizontalScrollMode () const

QSize	iconSize () const

virtual QModelIndex	indexAt (const QPoint &point) const=0

QWidget *	indexWidget (const QModelIndex &index) const

virtual QVariant	inputMethodQuery (Qt::InputMethodQuery query) const

QAbstractItemDelegate *	itemDelegate () const

QAbstractItemDelegate *	itemDelegate (const QModelIndex &index) const

QAbstractItemDelegate *	itemDelegateForColumn (int column) const

QAbstractItemDelegate *	itemDelegateForRow (int row) const

QAbstractItemModel *	model () const

void	openPersistentEditor (const QModelIndex &index)

void	pressed (const QModelIndex &index)

QModelIndex	rootIndex () const

virtual void	scrollTo (const QModelIndex &index, ScrollHint hint)=0

void	scrollToBottom ()

void	scrollToTop ()

QAbstractItemView::SelectionBehavior	selectionBehavior () const

QAbstractItemView::SelectionMode	selectionMode () const

QItemSelectionModel *	selectionModel () const

void	setAlternatingRowColors (bool enable)

void	setAutoScroll (bool enable)

void	setAutoScrollMargin (int margin)

void	setCurrentIndex (const QModelIndex &index)

void	setDefaultDropAction (Qt::DropAction dropAction)

void	setDragDropMode (DragDropMode behavior)

void	setDragDropOverwriteMode (bool overwrite)

void	setDragEnabled (bool enable)

void	setDropIndicatorShown (bool enable)

void	setEditTriggers (QFlags< QAbstractItemView::EditTrigger > triggers)

void	setHorizontalScrollMode (ScrollMode mode)

void	setIconSize (const QSize &size)

void	setIndexWidget (const QModelIndex &index, QWidget *widget)

void	setItemDelegate (QAbstractItemDelegate *delegate)

void	setItemDelegateForColumn (int column, QAbstractItemDelegate *delegate)

void	setItemDelegateForRow (int row, QAbstractItemDelegate *delegate)

void	setSelectionBehavior (QAbstractItemView::SelectionBehavior behavior)

void	setSelectionMode (QAbstractItemView::SelectionMode mode)

void	setTabKeyNavigation (bool enable)

void	setTextElideMode (Qt::TextElideMode mode)

void	setVerticalScrollMode (ScrollMode mode)

bool	showDropIndicator () const

QSize	sizeHintForIndex (const QModelIndex &index) const

virtual int	sizeHintForRow (int row) const

bool	tabKeyNavigation () const

Qt::TextElideMode	textElideMode () const

void	update (const QModelIndex &index)

ScrollMode	verticalScrollMode () const

void	viewportEntered ()

virtual QRect	visualRect (const QModelIndex &index) const=0

Public Member Functions inherited from QAbstractScrollArea
	QAbstractScrollArea (QWidget *parent)

	~QAbstractScrollArea ()

void	addScrollBarWidget (QWidget *widget, QFlags< Qt::AlignmentFlag > alignment)

QWidget *	cornerWidget () const

QScrollBar *	horizontalScrollBar () const

Qt::ScrollBarPolicy	horizontalScrollBarPolicy () const

QSize	maximumViewportSize () const

virtual QSize	minimumSizeHint () const

QWidgetList	scrollBarWidgets (QFlags< Qt::AlignmentFlag > alignment)

void	setCornerWidget (QWidget *widget)

void	setHorizontalScrollBar (QScrollBar *scrollBar)

void	setHorizontalScrollBarPolicy (Qt::ScrollBarPolicy)

void	setVerticalScrollBar (QScrollBar *scrollBar)

void	setVerticalScrollBarPolicy (Qt::ScrollBarPolicy)

void	setViewport (QWidget *widget)

virtual QSize	sizeHint () const

QScrollBar *	verticalScrollBar () const

Qt::ScrollBarPolicy	verticalScrollBarPolicy () const

QWidget *	viewport () const

Public Member Functions inherited from QFrame
	QFrame (QWidget *parent, QFlags< Qt::WindowType > f)

	QFrame (QWidget parent, const char name, QFlags< Qt::WindowType > f)

	~QFrame ()

QRect	frameRect () const

Shadow	frameShadow () const

Shape	frameShape () const

int	frameStyle () const

int	frameWidth () const

int	lineWidth () const

int	midLineWidth () const

void	setFrameRect (const QRect &)

void	setFrameShadow (Shadow)

void	setFrameShape (Shape)

void	setFrameStyle (int style)

void	setLineWidth (int)

void	setMidLineWidth (int)

Public Member Functions inherited from QWidget
	QWidget (QWidget *parent, QFlags< Qt::WindowType > f)

	QWidget (QWidget parent, const char name, QFlags< Qt::WindowType > f)

	~QWidget ()

bool	acceptDrops () const

QString	accessibleDescription () const

QString	accessibleName () const

QList< QAction * >	actions () const

void	activateWindow ()

void	addAction (QAction *action)

void	addActions (QList< QAction * > actions)

void	adjustSize ()

bool	autoFillBackground () const

Qt::BackgroundMode	backgroundMode () const

QPoint	backgroundOffset () const

BackgroundOrigin	backgroundOrigin () const

QPalette::ColorRole	backgroundRole () const

QSize	baseSize () const

QString	caption () const

QWidget *	childAt (int x, int y, bool includeThis) const

QWidget *	childAt (const QPoint &p, bool includeThis) const

QWidget *	childAt (int x, int y) const

QWidget *	childAt (const QPoint &p) const

QRect	childrenRect () const

QRegion	childrenRegion () const

void	clearFocus ()

void	clearMask ()

bool	close (bool alsoDelete)

bool	close ()

QColorGroup	colorGroup () const

void	constPolish () const

QMargins	contentsMargins () const

QRect	contentsRect () const

Qt::ContextMenuPolicy	contextMenuPolicy () const

QCursor	cursor () const

void	customContextMenuRequested (const QPoint &pos)

void	drawText (const QPoint &p, const QString &s)

void	drawText (int x, int y, const QString &s)

WId	effectiveWinId () const

void	ensurePolished () const

void	erase ()

void	erase (const QRect &rect)

void	erase (const QRegion &rgn)

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

Qt::FocusPolicy	focusPolicy () const

QWidget *	focusProxy () const

QWidget *	focusWidget () const

const QFont &	font () const

QFontInfo	fontInfo () const

QFontMetrics	fontMetrics () const

QPalette::ColorRole	foregroundRole () const

QRect	frameGeometry () const

QSize	frameSize () const

const QRect &	geometry () const

void	getContentsMargins (int left, int top, int right, int bottom) const

virtual HDC	getDC () const

void	grabGesture (Qt::GestureType gesture, QFlags< Qt::GestureFlag > flags)

void	grabKeyboard ()

void	grabMouse ()

void	grabMouse (const QCursor &cursor)

int	grabShortcut (const QKeySequence &key, Qt::ShortcutContext context)

QGraphicsEffect *	graphicsEffect () const

QGraphicsProxyWidget *	graphicsProxyWidget () const

bool	hasEditFocus () const

bool	hasFocus () const

bool	hasMouse () const

bool	hasMouseTracking () const

int	height () const

virtual int	heightForWidth (int w) const

void	hide ()

const QPixmap *	icon () const

void	iconify ()

QString	iconText () const

QInputContext *	inputContext ()

Qt::InputMethodHints	inputMethodHints () const

void	insertAction (QAction before, QAction action)

void	insertActions (QAction before, QList< QAction > actions)

bool	isActiveWindow () const

bool	isAncestorOf (const QWidget *child) const

bool	isDesktop () const

bool	isDialog () const

bool	isEnabled () const

bool	isEnabledTo (QWidget *ancestor) const

bool	isEnabledToTLW () const

bool	isFullScreen () const

bool	isHidden () const

bool	isInputMethodEnabled () const

bool	isMaximized () const

bool	isMinimized () const

bool	isModal () const

bool	isPopup () const

bool	isShown () const

bool	isTopLevel () const

bool	isUpdatesEnabled () const

bool	isVisible () const

bool	isVisibleTo (QWidget *ancestor) const

bool	isVisibleToTLW () const

bool	isWindow () const

bool	isWindowModified () const

QLayout *	layout () const

Qt::LayoutDirection	layoutDirection () const

QLocale	locale () const

void	lower ()

Qt::HANDLE	macCGHandle () const

Qt::HANDLE	macQDHandle () const

QPoint	mapFrom (QWidget *parent, const QPoint &pos) const

QPoint	mapFromGlobal (const QPoint &pos) const

QPoint	mapFromParent (const QPoint &pos) const

QPoint	mapTo (QWidget *parent, const QPoint &pos) const

QPoint	mapToGlobal (const QPoint &pos) const

QPoint	mapToParent (const QPoint &pos) const

QRegion	mask () const

int	maximumHeight () const

QSize	maximumSize () const

int	maximumWidth () const

int	minimumHeight () const

QSize	minimumSize () const

int	minimumWidth () const

void	move (int x, int y)

void	move (const QPoint &)

QWidget *	nativeParentWidget () const

QWidget *	nextInFocusChain () const

QRect	normalGeometry () const

void	overrideWindowFlags (QFlags< Qt::WindowType > flags)

bool	ownCursor () const

bool	ownFont () const

bool	ownPalette () const

virtual QPaintEngine *	paintEngine () const

const QPalette &	palette () const

QWidget *	parentWidget (bool sameWindow) const

QWidget *	parentWidget () const

QPlatformWindow *	platformWindow () const

QPlatformWindowFormat	platformWindowFormat () const

void	polish ()

QPoint	pos () const

QWidget *	previousInFocusChain () const

void	raise ()

void	recreate (QWidget *parent, QFlags< Qt::WindowType > f, const QPoint &p, bool showIt)

QRect	rect () const

virtual void	releaseDC (HDC hdc) const

void	releaseKeyboard ()

void	releaseMouse ()

void	releaseShortcut (int id)

void	removeAction (QAction *action)

void	render (QPaintDevice *target, const QPoint &targetOffset, const QRegion &sourceRegion, QFlags< QWidget::RenderFlag > renderFlags)

void	render (QPainter *painter, const QPoint &targetOffset, const QRegion &sourceRegion, QFlags< QWidget::RenderFlag > renderFlags)

void	repaint (int x, int y, int w, int h, bool b)

void	repaint (const QRegion &rgn, bool b)

void	repaint ()

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

void	repaint (const QRegion &rgn)

void	repaint (bool b)

void	repaint (const QRect &rect)

void	repaint (const QRect &r, bool b)

void	reparent (QWidget *parent, QFlags< Qt::WindowType > f, const QPoint &p, bool showIt)

void	reparent (QWidget *parent, const QPoint &p, bool showIt)

void	resize (int w, int h)

void	resize (const QSize &)

bool	restoreGeometry (const QByteArray &geometry)

QByteArray	saveGeometry () const

void	scroll (int dx, int dy)

void	scroll (int dx, int dy, const QRect &r)

void	setAcceptDrops (bool on)

void	setAccessibleDescription (const QString &description)

void	setAccessibleName (const QString &name)

void	setActiveWindow ()

void	setAttribute (Qt::WidgetAttribute attribute, bool on)

void	setAutoFillBackground (bool enabled)

void	setBackgroundColor (const QColor &color)

void	setBackgroundMode (Qt::BackgroundMode widgetBackground, Qt::BackgroundMode paletteBackground)

void	setBackgroundOrigin (BackgroundOrigin background)

void	setBackgroundPixmap (const QPixmap &pixmap)

void	setBackgroundRole (QPalette::ColorRole role)

void	setBaseSize (const QSize &)

void	setBaseSize (int basew, int baseh)

void	setCaption (const QString &c)

void	setContentsMargins (int left, int top, int right, int bottom)

void	setContentsMargins (const QMargins &margins)

void	setContextMenuPolicy (Qt::ContextMenuPolicy policy)

void	setCursor (const QCursor &)

void	setDisabled (bool disable)

void	setEditFocus (bool enable)

void	setEnabled (bool)

void	setEraseColor (const QColor &color)

void	setErasePixmap (const QPixmap &pixmap)

void	setFixedHeight (int h)

void	setFixedSize (const QSize &s)

void	setFixedSize (int w, int h)

void	setFixedWidth (int w)

void	setFocus (Qt::FocusReason reason)

void	setFocus ()

void	setFocusPolicy (Qt::FocusPolicy policy)

void	setFocusProxy (QWidget *w)

void	setFont (const QFont &)

void	setFont (const QFont &f, bool b)

void	setForegroundRole (QPalette::ColorRole role)

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

void	setGeometry (const QRect &)

void	setGraphicsEffect (QGraphicsEffect *effect)

void	setHidden (bool hidden)

void	setIcon (const QPixmap &i)

void	setIconText (const QString &it)

void	setInputContext (QInputContext *context)

void	setInputMethodEnabled (bool enabled)

void	setInputMethodHints (QFlags< Qt::InputMethodHint > hints)

void	setKeyCompression (bool b)

void	setLayout (QLayout *layout)

void	setLayoutDirection (Qt::LayoutDirection direction)

void	setLocale (const QLocale &locale)

void	setMask (const QBitmap &bitmap)

void	setMask (const QRegion &region)

void	setMaximumHeight (int maxh)

void	setMaximumSize (const QSize &)

void	setMaximumSize (int maxw, int maxh)

void	setMaximumWidth (int maxw)

void	setMinimumHeight (int minh)

void	setMinimumSize (int minw, int minh)

void	setMinimumSize (const QSize &)

void	setMinimumWidth (int minw)

void	setMouseTracking (bool enable)

void	setPalette (const QPalette &)

void	setPalette (const QPalette &p, bool b)

void	setPaletteBackgroundColor (const QColor &color)

void	setPaletteBackgroundPixmap (const QPixmap &pixmap)

void	setPaletteForegroundColor (const QColor &color)

void	setParent (QWidget *parent)

void	setParent (QWidget *parent, QFlags< Qt::WindowType > f)

void	setPlatformWindow (QPlatformWindow *window)

void	setPlatformWindowFormat (const QPlatformWindowFormat &format)

void	setShortcutAutoRepeat (int id, bool enable)

void	setShortcutEnabled (int id, bool enable)

void	setShown (bool shown)

void	setSizeIncrement (const QSize &)

void	setSizeIncrement (int w, int h)

void	setSizePolicy (QSizePolicy::Policy hor, QSizePolicy::Policy ver, bool hfw)

void	setSizePolicy (QSizePolicy::Policy horizontal, QSizePolicy::Policy vertical)

void	setSizePolicy (QSizePolicy)

void	setStatusTip (const QString &)

void	setStyle (QStyle *style)

QStyle *	setStyle (const QString &style)

void	setStyleSheet (const QString &styleSheet)

void	setToolTip (const QString &)

void	setUpdatesEnabled (bool enable)

void	setupUi (QWidget *widget)

virtual void	setVisible (bool visible)

void	setWhatsThis (const QString &)

void	setWindowFilePath (const QString &filePath)

void	setWindowFlags (QFlags< Qt::WindowType > type)

void	setWindowIcon (const QIcon &icon)

void	setWindowIconText (const QString &)

void	setWindowModality (Qt::WindowModality windowModality)

void	setWindowModified (bool)

void	setWindowOpacity (qreal level)

void	setWindowRole (const QString &role)

void	setWindowState (QFlags< Qt::WindowState > windowState)

void	setWindowSurface (QWindowSurface *surface)

void	setWindowTitle (const QString &)

void	show ()

void	showFullScreen ()

void	showMaximized ()

void	showMinimized ()

void	showNormal ()

QSize	size () const

QSize	sizeIncrement () const

QSizePolicy	sizePolicy () const

void	stackUnder (QWidget *w)

QString	statusTip () const

QStyle *	style () const

QString	styleSheet () const

bool	testAttribute (Qt::WidgetAttribute attribute) const

QString	toolTip () const

QWidget *	topLevelWidget () const

bool	underMouse () const

void	ungrabGesture (Qt::GestureType gesture)

void	unsetCursor ()

void	unsetFont ()

void	unsetLayoutDirection ()

void	unsetLocale ()

void	unsetPalette ()

void	update (const QRect &rect)

void	update (const QRegion &rgn)

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

void	update ()

void	updateGeometry ()

bool	updatesEnabled () const

QRect	visibleRect () const

QRegion	visibleRegion () const

QString	whatsThis () const

int	width () const

QWidget *	window () const

QString	windowFilePath () const

Qt::WindowFlags	windowFlags () const

QIcon	windowIcon () const

QString	windowIconText () const

Qt::WindowModality	windowModality () const

qreal	windowOpacity () const

QString	windowRole () const

Qt::WindowStates	windowState () const

QWindowSurface *	windowSurface () const

QString	windowTitle () const

Qt::WindowType	windowType () const

WId	winId () const

int	x () const

const QX11Info &	x11Info () const

Qt::HANDLE	x11PictureHandle () const

int	y () const

Public Member Functions inherited from QObject
	QObject (QObject *parent)

	QObject (QObject parent, const char name)

virtual	~QObject ()

bool	blockSignals (bool block)

QObject *	child (const char objName, const char inheritsClass, bool recursiveSearch) const

const QObjectList &	children () const

const char *	className () const

bool	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const

void	deleteLater ()

void	destroyed (QObject *obj)

bool	disconnect (const QObject receiver, const char method)

bool	disconnect (const char signal, const QObject receiver, const char *method)

void	dumpObjectInfo ()

void	dumpObjectTree ()

QList< QByteArray >	dynamicPropertyNames () const

virtual bool	eventFilter (QObject watched, QEvent event)

T	findChild (const QString &name) const

QList< T >	findChildren (const QRegExp &regExp) const

QList< T >	findChildren (const QString &name) const

bool	inherits (const char *className) const

void	insertChild (QObject *object)

void	installEventFilter (QObject *filterObj)

bool	isA (const char *className) const

bool	isWidgetType () const

void	killTimer (int id)

virtual const QMetaObject *	metaObject () const

void	moveToThread (QThread *targetThread)

const char *	name () const

const char *	name (const char *defaultName) const

QString	objectName () const

QObject *	parent () const

QVariant	property (const char *name) const

void	removeChild (QObject *object)

void	removeEventFilter (QObject *obj)

void	setName (const char *name)

void	setObjectName (const QString &name)

void	setParent (QObject *parent)

bool	setProperty (const char *name, const QVariant &value)

bool	signalsBlocked () const

int	startTimer (int interval)

QThread *	thread () const

Public Member Functions inherited from QPaintDevice
virtual	~QPaintDevice ()

int	colorCount () const

int	depth () const

int	height () const

int	heightMM () const

int	logicalDpiX () const

int	logicalDpiY () const

int	numColors () const

virtual QPaintEngine *	paintEngine () const=0

bool	paintingActive () const

int	physicalDpiX () const

int	physicalDpiY () const

int	width () const

int	widthMM () const

int	x11Cells () const

Qt::HANDLE	x11Colormap () const

bool	x11DefaultColormap () const

bool	x11DefaultVisual () const

int	x11Depth () const

Display *	x11Display () const

int	x11Screen () const

void *	x11Visual () const

Protected Slots
void	modelRowsInserted (const QModelIndex &index, int start, int end)

void	modelRowsRemoved ()

void	onCurrentChanged ()

void	onExpandedChanged (QgsLayerTreeNode *node, bool expanded)

void	onModelReset ()

void	updateExpandedStateToNode (const QModelIndex &index)

Protected Member Functions
void	contextMenuEvent (QContextMenuEvent *event) override

void	dropEvent (QDropEvent *event) override

QgsMapLayer *	layerForIndex (const QModelIndex &index) const

void	updateExpandedStateFromNode (QgsLayerTreeNode *node)

Protected Member Functions inherited from QTreeView
void	columnCountChanged (int oldCount, int newCount)

void	columnMoved ()

void	columnResized (int column, int oldSize, int newSize)

virtual void	currentChanged (const QModelIndex &current, const QModelIndex &previous)

virtual void	dragMoveEvent (QDragMoveEvent *event)

virtual void	drawBranches (QPainter *painter, const QRect &rect, const QModelIndex &index) const

virtual void	drawRow (QPainter *painter, const QStyleOptionViewItem &option, const QModelIndex &index) const

void	drawTree (QPainter *painter, const QRegion &region) const

virtual int	horizontalOffset () const

int	indexRowSizeHint (const QModelIndex &index) const

virtual bool	isIndexHidden (const QModelIndex &index) const

virtual void	keyPressEvent (QKeyEvent *event)

virtual void	mouseDoubleClickEvent (QMouseEvent *event)

virtual void	mouseMoveEvent (QMouseEvent *event)

virtual void	mousePressEvent (QMouseEvent *event)

virtual void	mouseReleaseEvent (QMouseEvent *event)

virtual QModelIndex	moveCursor (CursorAction cursorAction, QFlags< Qt::KeyboardModifier > modifiers)

virtual void	paintEvent (QPaintEvent *event)

int	rowHeight (const QModelIndex &index) const

virtual void	rowsAboutToBeRemoved (const QModelIndex &parent, int start, int end)

virtual void	rowsInserted (const QModelIndex &parent, int start, int end)

void	rowsRemoved (const QModelIndex &parent, int start, int end)

virtual void	scrollContentsBy (int dx, int dy)

virtual QModelIndexList	selectedIndexes () const

virtual void	selectionChanged (const QItemSelection &selected, const QItemSelection &deselected)

virtual void	setSelection (const QRect &rect, QFlags< QItemSelectionModel::SelectionFlag > command)

virtual int	sizeHintForColumn (int column) const

virtual void	timerEvent (QTimerEvent *event)

virtual void	updateGeometries ()

virtual int	verticalOffset () const

virtual bool	viewportEvent (QEvent *event)

virtual QRegion	visualRegionForSelection (const QItemSelection &selection) const

Protected Member Functions inherited from QAbstractItemView
virtual void	closeEditor (QWidget *editor, QAbstractItemDelegate::EndEditHint hint)

virtual void	commitData (QWidget *editor)

QPoint	dirtyRegionOffset () const

virtual void	dragEnterEvent (QDragEnterEvent *event)

virtual void	dragLeaveEvent (QDragLeaveEvent *event)

DropIndicatorPosition	dropIndicatorPosition () const

virtual bool	edit (const QModelIndex &index, EditTrigger trigger, QEvent *event)

virtual void	editorDestroyed (QObject *editor)

virtual bool	event (QEvent *event)

void	executeDelayedItemsLayout ()

virtual void	focusInEvent (QFocusEvent *event)

virtual bool	focusNextPrevChild (bool next)

virtual void	focusOutEvent (QFocusEvent *event)

virtual int	horizontalOffset () const=0

int	horizontalStepsPerItem () const

virtual void	inputMethodEvent (QInputMethodEvent *event)

virtual bool	isIndexHidden (const QModelIndex &index) const=0

virtual QModelIndex	moveCursor (CursorAction cursorAction, QFlags< Qt::KeyboardModifier > modifiers)=0

virtual void	resizeEvent (QResizeEvent *event)

void	scheduleDelayedItemsLayout ()

void	scrollDirtyRegion (int dx, int dy)

virtual QItemSelectionModel::SelectionFlags	selectionCommand (const QModelIndex &index, const QEvent *event) const

void	setDirtyRegion (const QRegion &region)

void	setHorizontalStepsPerItem (int steps)

virtual void	setSelection (const QRect &rect, QFlags< QItemSelectionModel::SelectionFlag > flags)=0

void	setState (State state)

void	setVerticalStepsPerItem (int steps)

virtual void	startDrag (QFlags< Qt::DropAction > supportedActions)

State	state () const

virtual int	verticalOffset () const=0

int	verticalStepsPerItem () const

virtual QStyleOptionViewItem	viewOptions () const

virtual QRegion	visualRegionForSelection (const QItemSelection &selection) const=0

Protected Member Functions inherited from QAbstractScrollArea
void	setupViewport (QWidget *viewport)

void	setViewportMargins (const QMargins &margins)

void	setViewportMargins (int left, int top, int right, int bottom)

virtual void	wheelEvent (QWheelEvent *e)

Protected Member Functions inherited from QFrame
virtual void	changeEvent (QEvent *ev)

Protected Member Functions inherited from QWidget
virtual void	actionEvent (QActionEvent *event)

virtual void	closeEvent (QCloseEvent *event)

void	create (WId window, bool initializeWindow, bool destroyOldWindow)

void	destroy (bool destroyWindow, bool destroySubWindows)

virtual void	enterEvent (QEvent *event)

bool	focusNextChild ()

bool	focusPreviousChild ()

virtual void	hideEvent (QHideEvent *event)

virtual void	keyReleaseEvent (QKeyEvent *event)

virtual void	languageChange ()

virtual void	leaveEvent (QEvent *event)

virtual bool	macEvent (EventHandlerCallRef caller, EventRef event)

virtual int	metric (PaintDeviceMetric m) const

virtual void	moveEvent (QMoveEvent *event)

virtual bool	qwsEvent (QWSEvent *event)

void	resetInputContext ()

virtual void	showEvent (QShowEvent *event)

virtual void	tabletEvent (QTabletEvent *event)

void	updateMicroFocus ()

virtual bool	winEvent (MSG message, long result)

virtual bool	x11Event (XEvent *event)

Protected Member Functions inherited from QObject
bool	checkConnectArgs (const char signal, const QObject object, const char *method)

virtual void	childEvent (QChildEvent *event)

virtual void	connectNotify (const char *signal)

virtual void	customEvent (QEvent *event)

virtual void	disconnectNotify (const char *signal)

int	receivers (const char *signal) const

QObject *	sender () const

int	senderSignalIndex () const

Protected Member Functions inherited from QPaintDevice
	QPaintDevice ()

Protected Attributes
QString	mCurrentLayerID
	Keeps track of current layer ID (to check when to emit signal about change of current layer) More...

QgsLayerTreeViewDefaultActions *	mDefaultActions
	helper class with default actions. Lazily initialized. More...

QgsLayerTreeViewMenuProvider *	mMenuProvider
	Context menu provider. Owned by the view. More...

Additional Inherited Members
Static Public Member Functions inherited from QWidget
QWidget *	find (WId id)

QWidget *	keyboardGrabber ()

QWidget *	mouseGrabber ()

void	setTabOrder (QWidget first, QWidget second)

QWidgetMapper *	wmapper ()

Static Public Member Functions inherited from QObject
bool	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)

bool	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type)

bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char method)

bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method)

QString	tr (const char sourceText, const char disambiguation, int n)

QString	trUtf8 (const char sourceText, const char disambiguation, int n)

Static Public Member Functions inherited from QPaintDevice
int	x11AppCells (int screen)

Qt::HANDLE	x11AppColormap (int screen)

bool	x11AppDefaultColormap (int screen)

bool	x11AppDefaultVisual (int screen)

int	x11AppDepth (int screen)

Display *	x11AppDisplay ()

int	x11AppDpiX (int screen)

int	x11AppDpiY (int screen)

Qt::HANDLE	x11AppRootWindow (int screen)

int	x11AppScreen ()

void *	x11AppVisual (int screen)

void	x11SetAppDpiX (int dpi, int screen)

void	x11SetAppDpiY (int dpi, int screen)

Public Attributes inherited from QAbstractItemView
typedef	EditTriggers

Public Attributes inherited from QWidget
typedef	RenderFlags

Static Protected Member Functions inherited from QObject
QByteArray	normalizeSignalSlot (const char *signalSlot)

Properties inherited from QTreeView
	allColumnsShowFocus

	animated

	autoExpandDelay

	expandsOnDoubleClick

	headerHidden

	indentation

	itemsExpandable

	rootIsDecorated

	sortingEnabled

	uniformRowHeights

	wordWrap

Properties inherited from QAbstractItemView
	alternatingRowColors

	autoScroll

	autoScrollMargin

	defaultDropAction

	dragDropMode

	dragDropOverwriteMode

	dragEnabled

	editTriggers

	horizontalScrollMode

	iconSize

	selectionBehavior

	selectionMode

	showDropIndicator

	tabKeyNavigation

	textElideMode

	verticalScrollMode

Properties inherited from QAbstractScrollArea
	horizontalScrollBarPolicy

	verticalScrollBarPolicy

Properties inherited from QFrame
	frameRect

	frameShadow

	frameShape

	frameWidth

	lineWidth

	midLineWidth

Properties inherited from QWidget
	acceptDrops

	accessibleDescription

	accessibleName

	autoFillBackground

	baseSize

	childrenRect

	childrenRegion

	contextMenuPolicy

	cursor

	enabled

	focus

	focusPolicy

	font

	frameGeometry

	frameSize

	fullScreen

	geometry

	height

	inputMethodHints

	isActiveWindow

	layoutDirection

	locale

	maximized

	maximumHeight

	maximumSize

	maximumWidth

	minimized

	minimumHeight

	minimumSize

	minimumSizeHint

	minimumWidth

	modal

	mouseTracking

	normalGeometry

	palette

	pos

	rect

	size

	sizeHint

	sizeIncrement

	sizePolicy

	statusTip

	styleSheet

	toolTip

	updatesEnabled

	visible

	whatsThis

	width

	windowFilePath

	windowFlags

	windowIcon

	windowIconText

	windowModality

	windowModified

	windowOpacity

	windowTitle

	x

	y

Properties inherited from QObject
	objectName

Detailed Description

The QgsLayerTreeView class extends QTreeView and provides some additional functionality when working with a layer tree.

The view updates expanded state of layer tree nodes and also listens to changes to expanded states in the layer tree.

The view keeps track of the current layer and emits a signal when the current layer has changed.

Allows the client to specify a context menu provider with custom actions. Also it comes with a set of default actions that can be used when building context menu.

See also: QgsLayerTreeModel

Note: added in 2.4

Definition at line 46 of file qgslayertreeview.h.

Constructor & Destructor Documentation

◆ QgsLayerTreeView()

QgsLayerTreeView::QgsLayerTreeView ( QWidget * parent = nullptr )

explicit

Definition at line 29 of file qgslayertreeview.cpp.

◆ ~QgsLayerTreeView()

QgsLayerTreeView::~QgsLayerTreeView ( )

Definition at line 49 of file qgslayertreeview.cpp.

Member Function Documentation

◆ collapseAllNodes

void QgsLayerTreeView::collapseAllNodes ( )

slot

Enhancement of QTreeView::collapseAll() that also records expanded state in layer tree nodes.

Note: added in QGIS 2.18

Definition at line 383 of file qgslayertreeview.cpp.

◆ contextMenuEvent()

void QgsLayerTreeView::contextMenuEvent ( QContextMenuEvent * event )

overrideprotectedvirtual

Reimplemented from QAbstractScrollArea.

Definition at line 112 of file qgslayertreeview.cpp.

◆ currentGroupNode()

QgsLayerTreeGroup * QgsLayerTreeView::currentGroupNode ( ) const

Get current group node. If a layer is current node, the function will return parent group. May be null.

Definition at line 282 of file qgslayertreeview.cpp.

◆ currentLayer()

QgsMapLayer * QgsLayerTreeView::currentLayer ( ) const

Get currently selected layer. May be null.

Definition at line 91 of file qgslayertreeview.cpp.

◆ currentLayerChanged

void QgsLayerTreeView::currentLayerChanged ( QgsMapLayer * layer )

signal

Emitted when a current layer is changed.

◆ currentLegendNode()

QgsLayerTreeModelLegendNode * QgsLayerTreeView::currentLegendNode ( ) const

Get current legend node.

May be null if current node is not a legend node.

Note: added in QGIS 2.14

Definition at line 304 of file qgslayertreeview.cpp.

◆ currentNode()

QgsLayerTreeNode * QgsLayerTreeView::currentNode ( ) const

Get current node. May be null.

Definition at line 277 of file qgslayertreeview.cpp.

◆ defaultActions()

QgsLayerTreeViewDefaultActions * QgsLayerTreeView::defaultActions ( )

Get access to the default actions that may be used with the tree view.

Definition at line 78 of file qgslayertreeview.cpp.

◆ dropEvent()

void QgsLayerTreeView::dropEvent ( QDropEvent * event )

overrideprotectedvirtual

Reimplemented from QAbstractItemView.

Definition at line 390 of file qgslayertreeview.cpp.

◆ expandAllNodes

void QgsLayerTreeView::expandAllNodes ( )

slot

Enhancement of QTreeView::expandAll() that also records expanded state in layer tree nodes.

Note: added in QGIS 2.18

Definition at line 376 of file qgslayertreeview.cpp.

◆ layerForIndex()

QgsMapLayer * QgsLayerTreeView::layerForIndex ( const QModelIndex & index ) const

protected

Definition at line 254 of file qgslayertreeview.cpp.

◆ layerTreeModel()

QgsLayerTreeModel * QgsLayerTreeView::layerTreeModel ( ) const

Get access to the model casted to QgsLayerTreeModel.

Definition at line 73 of file qgslayertreeview.cpp.

◆ menuProvider()

QgsLayerTreeViewMenuProvider* QgsLayerTreeView::menuProvider ( ) const

inline

Return pointer to the context menu provider. May be null.

Definition at line 65 of file qgslayertreeview.h.

◆ modelRowsInserted

void QgsLayerTreeView::modelRowsInserted	(	const QModelIndex &	index,
		int	start,
		int	end
	)

protectedslot

Definition at line 128 of file qgslayertreeview.cpp.

◆ modelRowsRemoved

void QgsLayerTreeView::modelRowsRemoved ( )

protectedslot

Definition at line 181 of file qgslayertreeview.cpp.

◆ onCurrentChanged

void QgsLayerTreeView::onCurrentChanged ( )

protectedslot

Definition at line 212 of file qgslayertreeview.cpp.

◆ onExpandedChanged

void QgsLayerTreeView::onExpandedChanged	(	QgsLayerTreeNode *	node,
		bool	expanded
	)

protectedslot

Definition at line 233 of file qgslayertreeview.cpp.

◆ onModelReset

void QgsLayerTreeView::onModelReset ( )

protectedslot

Definition at line 240 of file qgslayertreeview.cpp.

◆ refreshLayerSymbology

void QgsLayerTreeView::refreshLayerSymbology ( const QString & layerId )

slot

Force refresh of layer symbology. Normally not needed as the changes of layer's renderer are monitored by the model.

Definition at line 337 of file qgslayertreeview.cpp.

◆ selectedLayerNodes()

QList< QgsLayerTreeLayer * > QgsLayerTreeView::selectedLayerNodes ( ) const

Return list of selected nodes filtered to just layer nodes.

Definition at line 314 of file qgslayertreeview.cpp.

◆ selectedLayers()

QList< QgsMapLayer * > QgsLayerTreeView::selectedLayers ( ) const

Get list of selected layers.

Definition at line 325 of file qgslayertreeview.cpp.

◆ selectedNodes()

QList< QgsLayerTreeNode * > QgsLayerTreeView::selectedNodes ( bool skipInternal = false ) const

Return list of selected nodes.

skipInternal If true, will ignore nodes which have an ancestor in the selection

Definition at line 309 of file qgslayertreeview.cpp.

◆ setCurrentLayer()

void QgsLayerTreeView::setCurrentLayer ( QgsMapLayer * layer )

Set currently selected layer. Null pointer will deselect any layer.

Definition at line 96 of file qgslayertreeview.cpp.

◆ setMenuProvider()

void QgsLayerTreeView::setMenuProvider ( QgsLayerTreeViewMenuProvider * menuProvider )

Set provider for context menu. Takes ownership of the instance.

Definition at line 85 of file qgslayertreeview.cpp.

◆ setModel()

void QgsLayerTreeView::setModel ( QAbstractItemModel * model )

overridevirtual

Overridden setModel() from base class. Only QgsLayerTreeModel is an acceptable model.

Reimplemented from QTreeView.

Definition at line 54 of file qgslayertreeview.cpp.

◆ updateExpandedStateFromNode()

void QgsLayerTreeView::updateExpandedStateFromNode ( QgsLayerTreeNode * node )

protected

Definition at line 245 of file qgslayertreeview.cpp.

◆ updateExpandedStateToNode

void QgsLayerTreeView::updateExpandedStateToNode ( const QModelIndex & index )

protectedslot

Definition at line 187 of file qgslayertreeview.cpp.

Member Data Documentation

◆ mCurrentLayerID

QString QgsLayerTreeView::mCurrentLayerID

protected

Keeps track of current layer ID (to check when to emit signal about change of current layer)

Definition at line 134 of file qgslayertreeview.h.

◆ mDefaultActions

QgsLayerTreeViewDefaultActions* QgsLayerTreeView::mDefaultActions

protected

helper class with default actions. Lazily initialized.

Definition at line 130 of file qgslayertreeview.h.

◆ mMenuProvider

QgsLayerTreeViewMenuProvider* QgsLayerTreeView::mMenuProvider

protected

Context menu provider. Owned by the view.

Definition at line 132 of file qgslayertreeview.h.

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

/tmp/buildd/qgis-2.18.21+99unstable/src/gui/layertree/qgslayertreeview.h
/tmp/buildd/qgis-2.18.21+99unstable/src/gui/layertree/qgslayertreeview.cpp

Public Slots

Signals

Public Member Functions

Protected Slots

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QgsLayerTreeView()

◆ ~QgsLayerTreeView()

Member Function Documentation

◆ collapseAllNodes

◆ contextMenuEvent()

◆ currentGroupNode()

◆ currentLayer()

◆ currentLayerChanged

◆ currentLegendNode()

◆ currentNode()

◆ defaultActions()

◆ dropEvent()

◆ expandAllNodes

◆ layerForIndex()

◆ layerTreeModel()

◆ menuProvider()

◆ modelRowsInserted

◆ modelRowsRemoved

◆ onCurrentChanged

◆ onExpandedChanged

◆ onModelReset

◆ refreshLayerSymbology

◆ selectedLayerNodes()

◆ selectedLayers()

◆ selectedNodes()

◆ setCurrentLayer()

◆ setMenuProvider()

◆ setModel()

◆ updateExpandedStateFromNode()

◆ updateExpandedStateToNode

Member Data Documentation

◆ mCurrentLayerID

◆ mDefaultActions

◆ mMenuProvider