File: qgsprocessingoutputdestinationwidget.sip.in

package info (click to toggle)
qgis 3.40.10%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 1,183,672 kB
  • sloc: cpp: 1,595,771; python: 372,544; xml: 23,474; sh: 3,761; perl: 3,664; ansic: 2,257; sql: 2,137; yacc: 1,068; lex: 577; javascript: 540; lisp: 411; makefile: 161
file content (110 lines) | stat: -rw-r--r-- 3,344 bytes parent folder | download | duplicates (12)
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
/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/gui/processing/qgsprocessingoutputdestinationwidget.h            *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.py again   *
 ************************************************************************/




class QgsProcessingLayerOutputDestinationWidget : QWidget
{
%Docstring(signature="appended")
A widget which allows users to select the destination path for an output
style Processing parameter.

.. note::

   Not stable API

.. versionadded:: 3.14
%End

%TypeHeaderCode
#include "qgsprocessingoutputdestinationwidget.h"
%End
  public:
    QgsProcessingLayerOutputDestinationWidget( const QgsProcessingDestinationParameter *parameter, bool defaultSelection, QWidget *parent /TransferThis/ = 0 );
%Docstring
Constructor for QgsProcessingLayerOutputDestinationWidget, associated
with the specified ``parameter``.
%End

    bool outputIsSkipped() const;
%Docstring
Returns ``True`` if the output is set to be skipped.
%End

    void setValue( const QVariant &value );
%Docstring
Sets the ``value`` to show in the widget.
%End

    QVariant value() const;
%Docstring
Returns the widgets current value.
%End

    void setWidgetContext( const QgsProcessingParameterWidgetContext &context );
%Docstring
Sets the ``context`` in which the widget is shown, e.g., the parent
model algorithm, a linked map canvas, and other relevant information
which allows the widget to fine-tune its behavior.
%End

    void setContext( QgsProcessingContext *context );
%Docstring
Sets the processing ``context`` in which this widget is being shown.
%End

    void registerProcessingParametersGenerator( QgsProcessingParametersGenerator *generator );
%Docstring
Registers a Processing parameters ``generator`` class that will be used
to retrieve algorithm parameters for the widget when required.

.. versionadded:: 3.14
%End

    void addOpenAfterRunningOption();
%Docstring
Adds the "Open output file after running" option to the widget.
%End

    bool openAfterRunning() const;
%Docstring
Returns ``True`` if the widget has the "Open output file after running"
option checked.
%End

  signals:

    void skipOutputChanged( bool skipped );
%Docstring
Emitted whenever the "skip output" option is toggled in the widget.
%End

    void destinationChanged();
%Docstring
Emitted whenever the destination value is changed in the widget.
%End

  protected:
    virtual void dragEnterEvent( QDragEnterEvent *event );

    virtual void dragLeaveEvent( QDragLeaveEvent *event );

    virtual void dropEvent( QDropEvent *event );


};


/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/gui/processing/qgsprocessingoutputdestinationwidget.h            *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.py again   *
 ************************************************************************/