mirror of
https://github.com/qgis/QGIS.git
synced 2025-02-26 00:02:08 -05:00
ecd90c6ecb
* [FEATURE] Allow customization of the items show is browser. User can select in Interface Customization dialog to hide some of the items in the browser panel Funded by Limerick City and County Council
214 lines
5.4 KiB
Plaintext
214 lines
5.4 KiB
Plaintext
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/gui/qgsbrowserdockwidget.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
|
|
************************************************************************/
|
|
|
|
|
|
|
|
|
|
class QgsBrowserDockWidget : QgsDockWidget
|
|
{
|
|
%Docstring
|
|
The QgsBrowserDockWidget class
|
|
|
|
.. versionadded:: 3.0
|
|
%End
|
|
|
|
%TypeHeaderCode
|
|
#include "qgsbrowserdockwidget.h"
|
|
%End
|
|
public:
|
|
|
|
explicit QgsBrowserDockWidget( const QString &name, QgsBrowserGuiModel *browserModel, QWidget *parent /TransferThis/ = 0 );
|
|
%Docstring
|
|
Constructor for QgsBrowserDockWidget
|
|
|
|
:param name: name of the widget
|
|
:param browserModel: instance of the (shared) browser model
|
|
:param parent: parent widget
|
|
%End
|
|
~QgsBrowserDockWidget();
|
|
|
|
void addFavoriteDirectory( const QString &favDir, const QString &name = QString() ) /Deprecated/;
|
|
%Docstring
|
|
Add directory to favorites.
|
|
|
|
.. deprecated::
|
|
will be removed in QGIS 4.0 - use the methods in QgsBrowserModel instead
|
|
%End
|
|
|
|
void setMessageBar( QgsMessageBar *bar );
|
|
%Docstring
|
|
Sets a message ``bar`` to use alongside the dock widget. Setting this allows items
|
|
to utilize the message bar to provide non-blocking feedback to users, e.g.
|
|
success or failure of actions.
|
|
|
|
.. seealso:: :py:func:`messageBar`
|
|
|
|
.. versionadded:: 3.6
|
|
%End
|
|
|
|
QgsMessageBar *messageBar();
|
|
%Docstring
|
|
Returns the message bar associated with the dock.
|
|
|
|
.. seealso:: :py:func:`setMessageBar`
|
|
|
|
.. versionadded:: 3.6
|
|
%End
|
|
|
|
void setDisabledDataItemsKeys( const QStringList &filter );
|
|
%Docstring
|
|
Sets the customization for data items based on item's data provider key
|
|
|
|
By default browser model shows all items from all available data items provider and few special
|
|
items (e.g. Favourites). To customize the behavior, set the filter to not load certain data items.
|
|
The items that are not based on data item providers (e.g. Favourites, Home) have
|
|
prefix "special:"
|
|
|
|
Used in the proxy browser model to hide items
|
|
|
|
.. versionadded:: 3.12
|
|
%End
|
|
|
|
public slots:
|
|
|
|
bool addLayerAtIndex( const QModelIndex &index ) /Deprecated/;
|
|
%Docstring
|
|
Adds the layer corresponding to the specified model ``index``.
|
|
|
|
Returns ``True`` if the index was successfully intrepreted as a map layer and loaded, or
|
|
``False`` if the index is not a map layer or could not be loaded.
|
|
|
|
.. deprecated::
|
|
will be removed in QGIS 4.0 - retrieve the QgsLayerItem itself and manually add to project.
|
|
%End
|
|
|
|
void showContextMenu( QPoint );
|
|
%Docstring
|
|
Show context menu
|
|
%End
|
|
|
|
void addFavorite() /Deprecated/;
|
|
%Docstring
|
|
Add current item to favorite.
|
|
|
|
.. deprecated::
|
|
will be removed in QGIS 4.0 - use the methods in QgsBrowserModel instead
|
|
%End
|
|
|
|
void addFavoriteDirectory() /Deprecated/;
|
|
%Docstring
|
|
Add directory from file dialog to favorite.
|
|
|
|
.. deprecated::
|
|
will be removed in QGIS 4.0 - use the methods in QgsBrowserModel instead
|
|
%End
|
|
|
|
void removeFavorite() /Deprecated/;
|
|
%Docstring
|
|
Remove from favorite.
|
|
|
|
.. deprecated::
|
|
will be removed in QGIS 4.0 - use the methods in QgsBrowserModel instead
|
|
%End
|
|
|
|
void refresh();
|
|
%Docstring
|
|
Refresh browser view model (and view)
|
|
%End
|
|
|
|
void showFilterWidget( bool visible );
|
|
%Docstring
|
|
Show/hide filter widget
|
|
%End
|
|
void enablePropertiesWidget( bool enable );
|
|
%Docstring
|
|
Enable/disable properties widget
|
|
%End
|
|
void setFilterSyntax( QAction * );
|
|
%Docstring
|
|
Sets filter syntax
|
|
%End
|
|
void setCaseSensitive( bool caseSensitive );
|
|
%Docstring
|
|
Sets filter case sensitivity
|
|
%End
|
|
void setFilter();
|
|
%Docstring
|
|
Apply filter to the model
|
|
%End
|
|
void setActiveIndex( const QModelIndex &index );
|
|
%Docstring
|
|
Sets the selection to ``index`` and expand it
|
|
%End
|
|
void updateProjectHome();
|
|
%Docstring
|
|
Update project home directory
|
|
%End
|
|
|
|
void addSelectedLayers();
|
|
%Docstring
|
|
Add selected layers to the project
|
|
%End
|
|
void showProperties();
|
|
%Docstring
|
|
Show the layer properties
|
|
%End
|
|
void hideItem();
|
|
%Docstring
|
|
Hide current item
|
|
%End
|
|
|
|
void toggleFastScan() /Deprecated/;
|
|
%Docstring
|
|
Toggle fast scan
|
|
|
|
.. deprecated::
|
|
will be removed in QGIS 4.0
|
|
%End
|
|
|
|
|
|
void selectionChanged( const QItemSelection &selected, const QItemSelection &deselected );
|
|
%Docstring
|
|
Selection has changed
|
|
%End
|
|
void splitterMoved();
|
|
%Docstring
|
|
Splitter has been moved
|
|
%End
|
|
|
|
signals:
|
|
void openFile( const QString &fileName, const QString &fileTypeHint = QString() );
|
|
%Docstring
|
|
Emitted when a file needs to be opened
|
|
%End
|
|
void handleDropUriList( const QgsMimeDataUtils::UriList & );
|
|
%Docstring
|
|
Emitted when drop uri list needs to be handled
|
|
%End
|
|
void connectionsChanged();
|
|
%Docstring
|
|
Connections changed in the browser
|
|
%End
|
|
|
|
protected:
|
|
virtual void showEvent( QShowEvent *event );
|
|
|
|
%Docstring
|
|
Show event override
|
|
%End
|
|
|
|
};
|
|
|
|
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/gui/qgsbrowserdockwidget.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
|
|
************************************************************************/
|