1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279
|
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/qgsbrowserdockwidget.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsBrowserDockWidget : QgsDockWidget
{
%Docstring(signature="appended")
A dock widget containing a :py:class:`QgsBrowserWidget` for navigating
and managing data sources.
%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();
QgsBrowserWidget *browserWidget();
%Docstring
Returns a pointer to the :py:class:`QgsBrowserWidget` used by the dock
widget.
.. versionadded:: 3.22
%End
void addFavoriteDirectory( const QString &favDir, const QString &name = QString() ) /Deprecated/;
%Docstring
Add directory to favorites.
.. deprecated:: 3.40
Will be removed in QGIS 4.0 - use the methods in :py:class:`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. 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
.. 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:: 3.40
Will be removed in QGIS 4.0 - retrieve the :py:class:`QgsLayerItem` itself and manually add to project.
%End
void showContextMenu( QPoint ) /Deprecated/;
%Docstring
Show context menu.
.. deprecated:: 3.40
Will be removed in QGIS 4.0 -- this method is not intended for public use.
%End
void addFavorite() /Deprecated/;
%Docstring
Add current item to favorite.
.. deprecated:: 3.40
Will be removed in QGIS 4.0 - use the methods in :py:class:`QgsBrowserModel` instead.
%End
void addFavoriteDirectory() /Deprecated/;
%Docstring
Add directory from file dialog to favorite.
.. deprecated:: 3.40
Will be removed in QGIS 4.0 - use the methods in :py:class:`QgsBrowserModel` instead.
%End
void removeFavorite() /Deprecated/;
%Docstring
Remove from favorite.
.. deprecated:: 3.40
Will be removed in QGIS 4.0 - use the methods in :py:class:`QgsBrowserModel` instead.
%End
void refresh();
%Docstring
Refresh the browser model and view.
%End
void showFilterWidget( bool visible ) /Deprecated/;
%Docstring
Show/hide filter widget.
.. deprecated:: 3.40
Will be removed in QGIS 4.0 -- this method is not intended for public use.
%End
void enablePropertiesWidget( bool enable ) /Deprecated/;
%Docstring
Enable/disable properties widget.
.. deprecated:: 3.40
Will be removed in QGIS 4.0 -- this method is not intended for public use.
%End
void setFilterSyntax( QAction * ) /Deprecated/;
%Docstring
Sets filter syntax.
.. deprecated:: 3.40
Will be removed in QGIS 4.0 -- this method is not intended for public use.
%End
void setCaseSensitive( bool caseSensitive ) /Deprecated/;
%Docstring
Sets filter case sensitivity.
.. deprecated:: 3.40
Will be removed in QGIS 4.0 -- this method is not intended for public use.
%End
void setFilter() /Deprecated/;
%Docstring
Apply filter to the model.
.. deprecated:: 3.40
Will be removed in QGIS 4.0 -- this method is not intended for public use.
%End
void setActiveIndex( const QModelIndex &index ) /Deprecated/;
%Docstring
Sets the selection to ``index`` and expand it.
.. deprecated:: 3.40
Will be removed in QGIS 4.0 -- this method is not intended for public use.
%End
void updateProjectHome() /Deprecated/;
%Docstring
Update project home directory.
.. deprecated:: 3.40
Will be removed in QGIS 4.0 -- this method is not intended for public use.
%End
void addSelectedLayers() /Deprecated/;
%Docstring
Add selected layers to the project
.. deprecated:: 3.40
Will be removed in QGIS 4.0 -- this method is not intended for public use.
%End
void showProperties() /Deprecated/;
%Docstring
Show the layer properties.
.. deprecated:: 3.40
Will be removed in QGIS 4.0 -- this method is not intended for public use.
%End
void hideItem() /Deprecated/;
%Docstring
Hide current item.
.. deprecated:: 3.40
Will be removed in QGIS 4.0 -- this method is not intended for public use.
%End
void toggleFastScan() /Deprecated/;
%Docstring
Toggle fast scan
.. deprecated:: 3.40
Will be removed in QGIS 4.0.
%End
void selectionChanged( const QItemSelection &selected, const QItemSelection &deselected ) /Deprecated/;
%Docstring
Selection has changed.
.. deprecated:: 3.40
Will be removed in QGIS 4.0 -- this method is not intended for public use.
%End
void splitterMoved() /Deprecated/;
%Docstring
Splitter has been moved.
.. deprecated:: 3.40
No longer used.
%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 &uris );
%Docstring
Emitted when drop uri list needs to be handled
%End
void connectionsChanged();
%Docstring
Connections changed in the browser
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/qgsbrowserdockwidget.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
|