Nyall Dawson
6d122f0038
Sipify
2025-03-30 20:48:07 +10:00
Nyall Dawson
ac71664a83
Fix multiparagraphs in initial class docstrings
2025-03-30 20:48:07 +10:00
Nyall Dawson
bdba8d6366
Refactor too long doxygen brief comments
...
These break the table of contents for the PyQGIS documentation
2025-03-30 20:48:07 +10:00
Julien Cabieces
ed64834106
api(deprecated): add message to deprecated SIP annotation
2024-12-17 09:06:42 +01:00
Nyall Dawson
b39f760cbc
Correctly handle multiline SIP_OUT param documentation
2024-09-10 11:11:25 +10:00
Nyall Dawson
ef0289f3ec
Fix formatting of Python ..deprecated annotations in docstrings
...
Fixes https://github.com/qgis/pyqgis-api-docs-builder/issues/174
2024-09-02 11:42:12 +10:00
Nyall Dawson
d318cdb992
Standardise some since annotations
2024-09-01 02:29:17 +10:00
Nyall Dawson
3a578d6712
Header update
2024-08-13 20:28:55 +10:00
Nyall Dawson
be8dce7d0d
Valid improvements from new sipify
2024-08-13 20:28:55 +10:00
Nyall Dawson
e8b2638c5c
Add processing parameter types for Area and Volume
...
Adds dedicated parameter types for Area and Volume values.
Modeled closely off the existing Distance paramter type.
2024-07-10 18:56:49 +10:00
Nyall Dawson
1c60403286
Add testOnly option to parameterAsOutputLayer
...
If true, then the evaluated result won't be treated as an actual layer to load
2024-06-07 18:44:29 +10:00
Even Rouault
15ea5c46bc
Header files: remove all mentions of '\since QGIS 3.0'
2024-02-18 20:57:23 +01:00
Nyall Dawson
ee53b9ae48
Port processing enums to enum class
...
A step towards a Qt6 compatible Processing framework
2024-02-10 17:25:22 +10:00
Nyall Dawson
6116319806
Move a processing enum to enum class in Qgis
2024-01-30 19:10:43 +10:00
Nyall Dawson
a36b203f30
Promote some processing enums to enum class, cleanups
2024-01-30 19:10:43 +10:00
Nyall Dawson
26798b84f4
Promote QgsFeatureRequest enums to enum class, move to Qgis
2024-01-30 19:10:43 +10:00
Alexander Bruy
f22efde645
add binary and boolean types to QgsFieldProxyModel to allow filtering
...
corresponding field types. Also expose these field types to Processing
field parameter (fix #53940 )
2023-09-22 09:40:28 +10:00
Marco Hugentobler
8f8cfa949c
Added since QGIS 3.34 in comment
2023-09-12 11:35:23 +10:00
Marco Hugentobler
3fbfba3715
Possibility to apply default values for the processing gui from the settings
2023-09-12 11:35:23 +10:00
Alexander Bruy
a1013f87c6
[processing] add vector tile destination parameter
2023-05-18 07:09:16 +10:00
Alexander Bruy
10b02e02ed
move expression type enum to qgis.h
2023-05-02 14:00:43 +02:00
Alexander Bruy
d93111ccec
[processing] add enum to expression parameter to make it possible
...
distinguish between native QGIS expressions and point cloud filter
expressions
2023-05-02 14:00:43 +02:00
Alexander Bruy
c5947e4e51
add SIP_DEPRECATED
2023-04-10 11:57:39 +03:00
Alexander Bruy
89ddbc3863
fix typos, add Q_DECL_DEPRECATED
2023-04-07 14:00:05 +03:00
Alexander Bruy
1f77406f2d
[processing] new parameter type for point cloud attributes
2023-04-03 19:47:45 +03:00
Nyall Dawson
50c76929e1
Followup 30700f1, ensure links to Qgis members are set in docstrings
2023-03-31 10:46:24 +10:00
Alexey Karandashev
30700f1ef1
Fix GeometryType in documentation:
...
QgsWkbTypes::GeometryType to Qgis::GeometryType
and QgsWkbTypes::<geometry>Geometry to Qgis::GeometryType::<geometry>
2023-03-31 10:28:36 +10:00
Alexander Bruy
3104c10ad3
do not index input point cloud layers in pdal algorithms
2023-03-30 09:38:39 +02:00
Alexander Bruy
0325cf0c30
[processing] add layer options flag enum
...
This enum can be used in the QgsProcessingUtils::mapLayerFromString()
and parameterAsPointCloudLayer() calls to control layer loading, e.g.
skipping index generation or not applying default style, etc.
2023-03-29 06:06:09 +10:00
Nyall Dawson
30598b9ad9
Pass QgsProcessingContext on to all processing functions which
...
generate temporary file names
2023-03-21 03:50:08 +10:00
Nyall Dawson
3c1e4fe723
[processing] Allow filter expressions to be set for vector sources
...
This change adds a new "feature filter" option alongside the
existing feature limit and invalid geometry handling options
available for all vector inputs to processing layers.
It allows users to enter an expression to subset the layer dynamically
when running the tool, avoiding the need for separate steps to
set layer filters or create layer subsets.
Sponsored by City of Canning
2023-03-08 16:58:34 +10:00
Nyall Dawson
046883fa9c
Promote QgsWkbTypes enums to enum class, move to Qgis
2023-02-22 12:39:21 +10:00
Nyall Dawson
f9c3da1e06
Move unit enums to Qgis, promote to enum class
2023-02-19 13:29:06 +10:00
Nyall Dawson
6f072cfba9
Never try to handle base parameter type values as map layers
...
in QgsProcessingParameterDefinition::valueAs* methods
Avoids misleading log messages and a crash on macos
Fixes #48598
2022-09-26 16:39:56 +10:00
Nyall Dawson
d5856ec400
Allow enum parameters to have icons specified for values for parameter metadata
2022-01-31 21:01:44 +10:00
Nyall Dawson
e0dfc46916
Fix typos
2021-12-17 08:29:31 +10:00
Nyall Dawson
6315133c8b
Add method to convert parameter value to a list of strings
2021-12-17 08:29:31 +10:00
Nyall Dawson
ee3257b8e9
Add api to convert a processing parameter value to a string, if possible
...
Designed for use in converting an algorithm's parameters for
representation as a qgis_process command line
2021-12-17 08:29:31 +10:00
Nyall Dawson
e73d51d660
Add api to convert a processing parameter value to a value which
...
is compatible with storage in a JSON object
2021-12-17 08:29:31 +10:00
Alexander Bruy
88d7a62321
[processing] add point cloud output and point cloud destination parameter
...
to Processing. These are useful for 3rd party tools as outputs can be
automatically loaded on algorithm completion.
It is an API change not visible for users.
2021-11-26 15:37:27 +10:00
Juergen E. Fischer
c6008b7ee1
fix MSVC build: reverts fee62e4, dff05dd and e3a77b9484c effectivly
...
reverting 3fb0f66 (followup #45348 )
Using --no-public-is-protected (default on Windows) also works on Linux
and fixes #45331 too
2021-10-21 23:03:48 +02:00
nirvn
ef84e48a09
Run sipify_all.sh
2021-10-12 16:34:05 +10:00
Denis Rouzaud
ec16736306
run sipify
2021-10-12 16:34:05 +10:00
Antoine
68f003cb62
replace descriptionAsPythonString
2021-09-25 06:57:43 +10:00
Antoine
968db20b82
add \see and \since in comments
2021-09-25 06:57:43 +10:00
Antoine
968a5e8532
add method to get parameter description for python script
2021-09-25 06:57:43 +10:00
Nyall Dawson
45b886727b
Improve docs
2021-09-11 07:59:51 +10:00
Nyall Dawson
c2c0f2574d
[processing] Add parameter type for annotation layers
2021-09-11 07:59:51 +10:00
Alexander Bruy
f801cb6816
[processing] new pont cloud parameter for processing
2021-08-05 16:03:50 +03:00
Nyall Dawson
8f36cdfa44
[processing] Add API to allow a string parameter to show as a combobox
...
with preset choices in processing GUI
In some circumstances it is desirable to restrict the values available
when a user is asked to enter a string parameter to a list of predetermined
"valid" values, yet these values will vary installation by installation
(e.g. a "printer name" parameter, where you want users to pick from
printers installed on the system, but since the printer names will
vary install to install an enum parameter is not a valid choice)
This can now be done by setting the widget wrapper metadata
"value_hints" option, as demonstrated below. (While this provides a mechanism
for guiding users to select from valid string values when running a Processing
algorithm through the GUI, it does not place any limits on the string values
accepted via PyQGIS codes or when running the algorithm via other non-gui
means. Algorithms should gracefully handle other values accordingly.)
param = QgsProcessingParameterString( 'PRINTER_NAME', 'Printer name')
# show only printers which are available on the current system as options
# for the string input.
param.setMetadata( {'widget_wrapper':
{ 'value_hints': ['Inkjet printer', 'Laser printer'] }
})
2021-08-01 05:33:51 +10:00