1/************************************************************************ 2 * This file has been generated automatically from * 3 * * 4 * src/gui/layout/qgslayoutdesignerinterface.h * 5 * * 6 * Do not edit manually ! Edit header and run scripts/sipify.pl again * 7 ************************************************************************/ 8 9 10 11 12class QgsLayoutDesignerInterface: QObject 13{ 14%Docstring 15A common interface for layout designer dialogs and widgets. 16 17Provides a common interface and stable API for layout designer dialogs and widgets. 18This interface can be used by plugins and scripts to interact with 19open layout designer dialogs. 20 21.. note:: 22 23 Layout designer dialogs are transitory. They are created only on demand 24 (when a user opens the dialog) and are deleted as soon as the user closes the dialog. 25 There can be multiple designer dialogs open at any one time, and each is a separate 26 instance of the dialog and QgsLayoutDesignerInterface. Accordingly, plugins must 27 take care to react to newly created designer dialogs and apply their customizations 28 to all newly created dialogs. This can be done by listening for the QgisInterface.layoutDesignerOpened 29 signal. Plugins must also listen for the QgisInterface.layoutDesignerWillBeClosed 30 signal and gracefully cleanup any customizations before the designer dialog is 31 deleted. 32 33.. versionadded:: 3.0 34%End 35 36%TypeHeaderCode 37#include "qgslayoutdesignerinterface.h" 38%End 39%ConvertToSubClassCode 40 if ( qobject_cast<QgsLayoutDesignerInterface *>( sipCpp ) ) 41 sipType = sipType_QgsLayoutDesignerInterface; 42 else 43 sipType = NULL; 44%End 45 public: 46 47 enum StandardTool 48 { 49 ToolMoveItemContent, 50 ToolMoveItemNodes, 51 }; 52 53 QgsLayoutDesignerInterface( QObject *parent /TransferThis/ = 0 ); 54%Docstring 55Constructor for QgsLayoutDesignerInterface. 56%End 57 58 virtual QgsLayout *layout() = 0; 59%Docstring 60Returns the current layout displayed in the designer. 61 62.. seealso:: :py:func:`view` 63%End 64 65 virtual QgsMasterLayoutInterface *masterLayout() = 0; 66%Docstring 67Returns the master layout displayed in the designer. 68 69.. seealso:: :py:func:`layout` 70%End 71 72 virtual QWidget *window() = 0; 73%Docstring 74Returns a pointer to the designer window. 75 76.. versionadded:: 3.4 77%End 78 79 virtual QgsLayoutView *view() = 0; 80%Docstring 81Returns the layout view utilized by the designer. 82 83.. seealso:: :py:func:`layout` 84%End 85 86 virtual QgsMessageBar *messageBar() = 0; 87%Docstring 88Returns the designer's message bar. 89%End 90 91 virtual void selectItems( const QList< QgsLayoutItem * > &items ) = 0; 92%Docstring 93Selects the specified ``items``. 94%End 95 96 virtual void setAtlasPreviewEnabled( bool enabled ) = 0; 97%Docstring 98Toggles whether the atlas preview mode should be ``enabled`` in the designer. 99 100.. seealso:: :py:func:`atlasPreviewEnabled` 101 102.. versionadded:: 3.4 103%End 104 105 virtual bool atlasPreviewEnabled() const = 0; 106%Docstring 107Returns whether the atlas preview mode is enabled in the designer. 108 109.. seealso:: :py:func:`setAtlasPreviewEnabled` 110 111.. versionadded:: 3.4 112%End 113 114 virtual void setAtlasFeature( const QgsFeature &feature ) = 0; 115%Docstring 116Sets the specified feature as the current atlas feature 117 118.. warning:: 119 120 it is the caller's responsibility to ensure that ``feature`` is a feature from the layout's current atlas coverage layer. 121 122.. versionadded:: 3.14 123%End 124 125 virtual void showItemOptions( QgsLayoutItem *item, bool bringPanelToFront = true ) = 0; 126%Docstring 127Shows the configuration widget for the specified layout ``item``. 128 129If ``bringPanelToFront`` is ``True``, then the item properties panel will be automatically 130shown and raised to the top of the interface. 131 132.. versionadded:: 3.4 133%End 134 135 136 virtual QMenu *layoutMenu() = 0; 137%Docstring 138Returns a reference to the designer's "Layout" menu. 139 140.. note:: 141 142 See class documentation for notes regarding handling customization of designer dialogs. 143 144.. seealso:: :py:func:`editMenu` 145 146.. seealso:: :py:func:`viewMenu` 147 148.. seealso:: :py:func:`itemsMenu` 149 150.. seealso:: :py:func:`atlasMenu` 151 152.. seealso:: :py:func:`reportMenu` 153 154.. seealso:: :py:func:`settingsMenu` 155 156 157.. versionadded:: 3.4 158%End 159 160 virtual QMenu *editMenu() = 0; 161%Docstring 162Returns a reference to the designer's "Edit" menu. 163 164.. note:: 165 166 See class documentation for notes regarding handling customization of designer dialogs. 167 168.. seealso:: :py:func:`layoutMenu` 169 170.. seealso:: :py:func:`viewMenu` 171 172.. seealso:: :py:func:`itemsMenu` 173 174.. seealso:: :py:func:`atlasMenu` 175 176.. seealso:: :py:func:`reportMenu` 177 178.. seealso:: :py:func:`settingsMenu` 179 180 181.. versionadded:: 3.4 182%End 183 184 virtual QMenu *viewMenu() = 0; 185%Docstring 186Returns a reference to the designer's "View" menu. 187 188.. note:: 189 190 See class documentation for notes regarding handling customization of designer dialogs. 191 192.. seealso:: :py:func:`layoutMenu` 193 194.. seealso:: :py:func:`editMenu` 195 196.. seealso:: :py:func:`itemsMenu` 197 198.. seealso:: :py:func:`atlasMenu` 199 200.. seealso:: :py:func:`reportMenu` 201 202.. seealso:: :py:func:`settingsMenu` 203 204 205.. versionadded:: 3.4 206%End 207 208 virtual QMenu *itemsMenu() = 0; 209%Docstring 210Returns a reference to the designer's "Items" menu. 211 212.. note:: 213 214 See class documentation for notes regarding handling customization of designer dialogs. 215 216.. seealso:: :py:func:`layoutMenu` 217 218.. seealso:: :py:func:`editMenu` 219 220.. seealso:: :py:func:`viewMenu` 221 222.. seealso:: :py:func:`atlasMenu` 223 224.. seealso:: :py:func:`reportMenu` 225 226.. seealso:: :py:func:`settingsMenu` 227 228 229.. versionadded:: 3.4 230%End 231 232 virtual QMenu *atlasMenu() = 0; 233%Docstring 234Returns a reference to the designer's "Atlas" menu. 235 236Note that this may not exist or may be hidden if the designer is in report mode. 237 238.. note:: 239 240 See class documentation for notes regarding handling customization of designer dialogs. 241 242.. seealso:: :py:func:`layoutMenu` 243 244.. seealso:: :py:func:`editMenu` 245 246.. seealso:: :py:func:`viewMenu` 247 248.. seealso:: :py:func:`itemsMenu` 249 250.. seealso:: :py:func:`reportMenu` 251 252.. seealso:: :py:func:`settingsMenu` 253 254 255.. versionadded:: 3.4 256%End 257 258 virtual QMenu *reportMenu() = 0; 259%Docstring 260Returns a reference to the designer's "Report" menu. 261 262Note that this may not exist or may be hidden if the designer is not in report mode. 263 264.. note:: 265 266 See class documentation for notes regarding handling customization of designer dialogs. 267 268.. seealso:: :py:func:`layoutMenu` 269 270.. seealso:: :py:func:`editMenu` 271 272.. seealso:: :py:func:`viewMenu` 273 274.. seealso:: :py:func:`itemsMenu` 275 276.. seealso:: :py:func:`atlasMenu` 277 278.. seealso:: :py:func:`settingsMenu` 279 280 281.. versionadded:: 3.4 282%End 283 284 virtual QMenu *settingsMenu() = 0; 285%Docstring 286Returns a reference to the designer's "Settings" menu. 287 288.. note:: 289 290 See class documentation for notes regarding handling customization of designer dialogs. 291 292.. seealso:: :py:func:`layoutMenu` 293 294.. seealso:: :py:func:`editMenu` 295 296.. seealso:: :py:func:`viewMenu` 297 298.. seealso:: :py:func:`itemsMenu` 299 300.. seealso:: :py:func:`atlasMenu` 301 302.. seealso:: :py:func:`reportMenu` 303 304 305.. versionadded:: 3.4 306%End 307 308 virtual QToolBar *layoutToolbar() = 0; 309%Docstring 310Returns a reference to the designer's "Layout" toolbar. 311 312.. note:: 313 314 See class documentation for notes regarding handling customization of designer dialogs. 315 316.. seealso:: :py:func:`navigationToolbar` 317 318.. seealso:: :py:func:`actionsToolbar` 319 320.. seealso:: :py:func:`atlasToolbar` 321 322 323.. versionadded:: 3.4 324%End 325 326 virtual QToolBar *navigationToolbar() = 0; 327%Docstring 328Returns a reference to the designer's "Navigation" toolbar. 329 330.. note:: 331 332 See class documentation for notes regarding handling customization of designer dialogs. 333 334.. seealso:: :py:func:`layoutToolbar` 335 336.. seealso:: :py:func:`actionsToolbar` 337 338.. seealso:: :py:func:`atlasToolbar` 339 340 341.. versionadded:: 3.4 342%End 343 344 virtual QToolBar *actionsToolbar() = 0; 345%Docstring 346Returns a reference to the designer's "Actions" toolbar. 347 348.. note:: 349 350 See class documentation for notes regarding handling customization of designer dialogs. 351 352.. seealso:: :py:func:`layoutToolbar` 353 354.. seealso:: :py:func:`navigationToolbar` 355 356.. seealso:: :py:func:`atlasToolbar` 357 358 359.. versionadded:: 3.4 360%End 361 362 virtual QToolBar *atlasToolbar() = 0; 363%Docstring 364Returns a reference to the designer's "Atlas" toolbar. 365 366Note that this toolbar may not exist or may be hidden if the 367designer is in report mode. 368 369.. note:: 370 371 See class documentation for notes regarding handling customization of designer dialogs. 372 373.. seealso:: :py:func:`layoutToolbar` 374 375.. seealso:: :py:func:`navigationToolbar` 376 377.. seealso:: :py:func:`actionsToolbar` 378 379 380.. versionadded:: 3.4 381%End 382 383 virtual void addDockWidget( Qt::DockWidgetArea area, QDockWidget *dock ) = 0; 384%Docstring 385Adds a ``dock`` widget to the layout designer, in the specified dock ``area``. 386 387.. note:: 388 389 See class documentation for notes regarding handling customization of designer dialogs. 390 391.. seealso:: :py:func:`removeDockWidget` 392 393 394.. versionadded:: 3.4 395%End 396 397 virtual void removeDockWidget( QDockWidget *dock ) = 0; 398%Docstring 399Removes the specified ``dock`` widget from layout designer (without deleting it). 400 401.. note:: 402 403 See class documentation for notes regarding handling customization of designer dialogs. 404 405.. seealso:: :py:func:`addDockWidget` 406 407 408.. versionadded:: 3.4 409%End 410 411 virtual void activateTool( StandardTool tool ) = 0; 412%Docstring 413Activates a standard layout designer ``tool``. 414 415.. versionadded:: 3.6 416%End 417 418 public slots: 419 420 virtual void close() = 0; 421%Docstring 422Closes the layout designer. 423%End 424 425 virtual void showRulers( bool visible ) = 0; 426%Docstring 427Toggles whether or not the rulers should be ``visible`` in the designer. 428 429.. versionadded:: 3.4 430%End 431 432 433}; 434 435/************************************************************************ 436 * This file has been generated automatically from * 437 * * 438 * src/gui/layout/qgslayoutdesignerinterface.h * 439 * * 440 * Do not edit manually ! Edit header and run scripts/sipify.pl again * 441 ************************************************************************/ 442