mirror of
https://github.com/qgis/QGIS.git
synced 2025-11-04 00:04:25 -05:00
106 lines
3.0 KiB
Plaintext
106 lines
3.0 KiB
Plaintext
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/gui/qgsbrowserwidget.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.py again *
|
|
************************************************************************/
|
|
|
|
|
|
|
|
|
|
class QgsBrowserWidget : QgsPanelWidget
|
|
{
|
|
%Docstring(signature="appended")
|
|
A widget showing a browser tree view along with toolbar and toggleable
|
|
properties pane.
|
|
|
|
.. versionadded:: 3.22
|
|
%End
|
|
|
|
%TypeHeaderCode
|
|
#include "qgsbrowserwidget.h"
|
|
%End
|
|
public:
|
|
explicit QgsBrowserWidget( QgsBrowserGuiModel *browserModel, QWidget *parent /TransferThis/ = 0 );
|
|
%Docstring
|
|
Constructor for QgsBrowserWidget
|
|
|
|
:param browserModel: instance of the (shared) browser model
|
|
:param parent: parent widget
|
|
%End
|
|
~QgsBrowserWidget();
|
|
|
|
void setMessageBar( QgsMessageBar *bar );
|
|
%Docstring
|
|
Sets a message ``bar`` to use alongside the 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`
|
|
%End
|
|
|
|
QgsMessageBar *messageBar();
|
|
%Docstring
|
|
Returns the message bar associated with the widget.
|
|
|
|
.. seealso:: :py:func:`setMessageBar`
|
|
%End
|
|
|
|
void setMapCanvas( QgsMapCanvas *canvas );
|
|
%Docstring
|
|
Sets a map ``canvas`` to use alongside the widget.
|
|
|
|
Setting this allows items to utilize the canvas during GUI operations.
|
|
|
|
.. seealso:: :py:func:`mapCanvas`
|
|
|
|
.. versionadded:: 3.44
|
|
%End
|
|
|
|
QgsMapCanvas *mapCanvas();
|
|
%Docstring
|
|
Returns the map canvas associated with the widget.
|
|
|
|
.. seealso:: :py:func:`setMapCanvas`
|
|
|
|
.. versionadded:: 3.44
|
|
%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. Favorites). 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. Favorites, Home) have prefix
|
|
"special:"
|
|
|
|
Used in the proxy browser model to hide items
|
|
%End
|
|
|
|
public slots:
|
|
|
|
|
|
|
|
void refresh();
|
|
%Docstring
|
|
Refreshes the browser model and view.
|
|
%End
|
|
|
|
|
|
protected:
|
|
virtual void showEvent( QShowEvent *event );
|
|
|
|
|
|
};
|
|
|
|
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/gui/qgsbrowserwidget.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.py again *
|
|
************************************************************************/
|