35 Commits

Author SHA1 Message Date
Denis Rouzaud
758d7cff4a run sipify to update deprecation annotations 2019-10-15 13:17:38 +02:00
Denis Rouzaud
86550e9837 create a method in QgsGui to determine if running Python macros is allowed 2019-10-02 15:53:15 +02:00
Denis Rouzaud
abb08c2988
[locator] allow to trigger locator search from the API (#32017) 2019-09-27 09:58:47 +02:00
Denis Rouzaud
13119193ba fix API doc and init values 2019-09-19 09:05:40 +02:00
Denis Rouzaud
838dbef3c0 [layer tree] dedicated method in QgisApp to determine insertion point
and create bindings to get the current insertion point in QgisInterface
2019-09-17 20:55:40 +02:00
Nyall Dawson
423b779411 [needs-docs] Add iface.pluginHelpMenu()
Returns a reference to the main window "Plugin Help" sub-menu.

Plugins are encouraged to insert help and about actions in this submenu instead of creating
a submenu under the pluginMenu() which solely contains Plugin Help or About actions.

For example, a plugin which only implements a processing provider should not
create additional ui menus just to link to the plugin help pages. Rather, they
should use this new submenu (available under the Help menu) to insert
their help links.
2019-09-12 11:27:42 +10:00
Peter Petrik
62d615c2cd [QEP 149] Introduce static data providers [API BREAK]
- adds QgsProviderGuiRegistry and QgsProviderGuiMetadata
- adds QgsProjectStorageGuiRegistry
- requires providerMetadataFactory for dynamic data providers
- requires providerMetadataGuiFactory for dynamic data providers (GUI only)
- removes QgsProviderRegistry::WidgetMode
2019-06-18 15:15:36 +02:00
Denis Rouzaud
375a0aa253 create scope based enum for QgsMapLayer::LayerType >> QgsMapLayerType
the enum is moved out of the class
this will allow forward declaration more easily since the enum is not nested in the class
2019-03-24 21:40:33 -05:00
Harrissou Sant-anna
53a717a41b Fix formatting in pyqgis documentation (#9396)
* Fix API documentation

* Fix sip doc
2019-03-06 20:09:26 +01:00
Nyall Dawson
107b48a430 Add NULLPTR macro for use in doxygen comments
For the c++ api dox this expands to "\c nullptr" (the
\c directive indicates a code literal value), and for sipify/Python
it expands to ``None`` (`` is sphinx annotation for literal values)

Makes for nicer dox for both c++ and Python!
2019-02-27 09:41:11 +10:00
Nyall Dawson
a7ca08784c Nullptr consistency in dox 2019-02-27 09:41:11 +10:00
Nyall Dawson
b6d66becab Sipify 2019-02-27 09:41:11 +10:00
Nyall Dawson
519a30f10c Standardise dox for signals 2019-02-26 03:24:31 +10:00
Nyall Dawson
7eab74f803 Fix use of trailing */ in dox, which messes with sipify Python documentation output 2019-02-25 19:02:12 +10:00
donvincenzo
e4e0948a3d Add actionVertexToolActiveLayer to iface 2019-02-07 11:17:56 +11:00
Denis Rouzaud
0b22508fe6 give a few references in QgisInterface API docs 2018-10-24 07:54:06 -08:00
Nyall Dawson
f23b09b845 [needs-docs][layouts] Expose menus and toolbars (and some other goodies) to stable
layout designer interface API

This commit adds more methods to the public, stable API for the layout
designer dialog, allowing plugins and scripts greater flexibility
in extending and hooking into the layout designer.

New API includes:
- access to the main menus shown in the dialog, allowing custom actions
to be added to the dialog
- access to the dialog's toolbars
- methods for adding (and removing) additional dock widgets to the designer
- the method used to show/hide rulers in the designer
2018-10-19 11:53:04 +10:00
Nyall Dawson
4459c9a6f8 Dox 2018-10-17 06:19:06 +10:00
Nyall Dawson
8b5bf3c17c Remove some redundant dox from QgisAppInterface 2018-10-17 06:19:06 +10:00
Nyall Dawson
905031945f Expose application browser model instance to iface
Reusing the existing browser model is more efficient then reconstructing
new models, so it's useful for plugins to have access to this instance
too.
2018-10-17 06:19:06 +10:00
Denis Rouzaud
77bfec68c3 fix typo 2018-10-05 09:01:32 -04:00
Denis Rouzaud
046f915c24 more doc 2018-10-04 14:01:31 -04:00
Denis Rouzaud
ffdf617277 take screenshots in app for user documentation 2018-10-04 14:01:31 -04:00
Harrissou Sant-anna
f5bf15bed9 Update some documentation formatting 2018-09-06 17:10:17 +10:00
Martin Dobias
6614d89643 Add missing interface method for Data Source Manager toolbar 2018-07-23 15:19:57 +02:00
Peter Petrik
e135b9cf9f [feature] addMeshLayer to qgsinterface 2018-07-13 10:28:40 +02:00
Denis Rouzaud
a15d8903ed [locator] add a way to invalidate results from python API
otherwise if you access the config of the filter (or change app settings) from outside the main application settings dialog, results are not invalidate

for instance, if you update a URL of a service, results won't be updated
2018-06-01 03:31:39 -08:00
Denis Rouzaud
65bb60e96c run sipify 2018-05-28 10:39:34 -08:00
Nyall Dawson
38850bdb94 [pyqgis] Ensure that multiline param tags are indented for additional lines 2018-05-27 18:54:09 +10:00
Nyall Dawson
c864d22d1f Add "get ..." to doxygen compliance blacklist
Should be "gets ..." for consistent tense, or better yet
"returns ..." for consistency.
2018-05-27 14:05:06 +10:00
Nyall Dawson
17500c455f Fix some interface doxygen 2018-05-27 14:05:06 +10:00
Nyall Dawson
5e360f90e8 Add unit test to prevent deprecated methods without description
And add missing descriptions
2018-05-25 16:31:03 +10:00
Nyall Dawson
1c615c15cc More documentation compliance
Use Qt style "returns .." tense instead of "return ..", and lock
this in with a documentation compliance unit test
2018-05-25 15:09:00 +10:00
Nyall Dawson
2cb8a33884 Fix broken see also links 2018-05-25 11:16:18 +10:00
Denis Rouzaud
9ed1548494 move auto generated sip file in dedicated folder (gui) 2018-05-14 10:31:17 -04:00