QGIS/python/gui/auto_generated/layertree/qgslayertreeviewdefaultactions.sip.in

/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/gui/layertree/qgslayertreeviewdefaultactions.h                   *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
 ************************************************************************/






class QgsLayerTreeViewDefaultActions : QObject
{
%Docstring(signature="appended")
The :py:class:`QgsLayerTreeViewDefaultActions` class serves as a factory of actions
that can be used together with a layer tree view.

.. seealso:: :py:class:`QgsLayerTreeView`
%End

%TypeHeaderCode
#include "qgslayertreeviewdefaultactions.h"
%End
  public:
    QgsLayerTreeViewDefaultActions( QgsLayerTreeView *view );

    QAction *actionAddGroup( QObject *parent = 0 ) /Factory/;
    QAction *actionRemoveGroupOrLayer( QObject *parent = 0 ) /Factory/;
    QAction *actionShowInOverview( QObject *parent = 0 ) /Factory/;
    QAction *actionRenameGroupOrLayer( QObject *parent = 0 ) /Factory/;
    QAction *actionShowFeatureCount( QObject *parent = 0 ) /Factory/;

    QAction *actionCheckAndAllChildren( QObject *parent = 0 );
%Docstring
Action to check a group and all its children
%End

    QAction *actionUncheckAndAllChildren( QObject *parent = 0 );
%Docstring
Action to uncheck a group and all its children
%End

    QAction *actionCheckAndAllParents( QObject *parent = 0 );
%Docstring
Action to check a group and all its parents
%End

 QAction *actionZoomToLayer( QgsMapCanvas *canvas, QObject *parent = 0 ) /Factory,Deprecated/;
%Docstring
Action to zoom to the active layer from the layer tree.

.. deprecated:: QGIS 3.18
  use :py:func:`~QgsLayerTreeViewDefaultActions.actionZoomToLayers`
%End

    QAction *actionZoomToLayers( QgsMapCanvas *canvas, QObject *parent = 0 ) /Factory/;
%Docstring
Action to zoom to all the selected layer(s) in the layer tree

.. versionadded:: 3.18
%End

    QAction *actionZoomToSelection( QgsMapCanvas *canvas, QObject *parent = 0 ) /Factory/;
%Docstring
Action to zoom to selected features of a vector layer

.. versionadded:: 3.2
%End
    QAction *actionZoomToGroup( QgsMapCanvas *canvas, QObject *parent = 0 ) /Factory/;

 QAction *actionMakeTopLevel( QObject *parent = 0 ) /Factory/;
%Docstring

.. deprecated:: QGIS 3.2
  use :py:func:`~QgsLayerTreeViewDefaultActions.actionMoveOutOfGroup`
%End

    QAction *actionMoveOutOfGroup( QObject *parent = 0 ) /Factory/;
%Docstring

.. seealso:: :py:func:`moveOutOfGroup`

.. versionadded:: 3.2
%End

    QAction *actionMoveToTop( QObject *parent = 0 ) /Factory/;
%Docstring

.. seealso:: :py:func:`moveToTop`

.. versionadded:: 3.2
%End

    QAction *actionMoveToBottom( QObject *parent = 0 ) /Factory/;
%Docstring

.. seealso:: :py:func:`moveToBottom`

.. versionadded:: 3.14
%End
    QAction *actionGroupSelected( QObject *parent = 0 ) /Factory/;

    QAction *actionMutuallyExclusiveGroup( QObject *parent = 0 ) /Factory/;
%Docstring
Action to enable/disable mutually exclusive flag of a group (only one child node may be checked)
%End

 void zoomToLayer( QgsMapCanvas *canvas ) /Deprecated/;
%Docstring
Zooms a map ``canvas`` to the extent of the active layer in the layer tree.

.. deprecated:: QGIS 3.18
  use :py:func:`~QgsLayerTreeViewDefaultActions.zoomToLayers`
%End

    void zoomToLayers( QgsMapCanvas *canvas );
%Docstring
Zooms a map ``canvas`` to all the selected layer(s) in the layer tree

.. seealso:: :py:func:`zoomToLayers`

.. versionadded:: 3.18
%End

    void zoomToSelection( QgsMapCanvas *canvas );
%Docstring

.. seealso:: :py:func:`zoomToSelection`

.. versionadded:: 3.2
%End
    void zoomToGroup( QgsMapCanvas *canvas );

  public slots:
    void showInOverview();
    void addGroup();

  protected slots:
    void removeGroupOrLayer();
    void renameGroupOrLayer();
    void showFeatureCount();

 void zoomToLayer() /Deprecated/;
%Docstring
Zooms to the extent of the active layer in the layer tree.

.. deprecated:: QGIS 3.18
  use :py:func:`~QgsLayerTreeViewDefaultActions.zoomToLayers`
%End

    void zoomToLayers();
%Docstring
Zooms to the combined extent of all the selected layer(s) in the layer tree.

.. versionadded:: 3.18
%End

    void zoomToSelection();
%Docstring
Zooms to the bounding box of all selected features of a vector layer.

.. versionadded:: 3.2
%End
    void zoomToGroup();

 void makeTopLevel() /Deprecated/;
%Docstring

.. deprecated:: QGIS 3.2
  use :py:func:`~QgsLayerTreeViewDefaultActions.moveOutOfGroup`
%End

    void moveOutOfGroup();
%Docstring
Moves selected layer(s) out of the group(s) and places this/these above the group(s)

.. versionadded:: 3.2
%End

    void moveToTop();
%Docstring
Moves selected layer(s) and/or group(s) to the top of the layer panel
or the top of the group if the layer/group is placed within a group.

.. versionadded:: 3.2
%End

    void moveToBottom();
%Docstring
Moves selected layer(s) and/or group(s) to the bottom of the layer panel
or the bottom of the group if the layer/group is placed within a group.

.. versionadded:: 3.14
%End
    void groupSelected();

    void mutuallyExclusiveGroup();
%Docstring
Slot to enable/disable mutually exclusive group flag
%End

  protected:
    void zoomToLayers( QgsMapCanvas *canvas, const QList<QgsMapLayer *> &layers );

    QString uniqueGroupName( QgsLayerTreeGroup *parentGroup );

  protected:
};


/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/gui/layertree/qgslayertreeviewdefaultactions.h                   *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
 ************************************************************************/