File: qgsmodeldesignerdialog.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 (158 lines) | stat: -rw-r--r-- 4,191 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
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
/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/gui/processing/models/qgsmodeldesignerdialog.h                   *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.py again   *
 ************************************************************************/







class QgsModelDesignerDialog : QMainWindow
{
%Docstring(signature="appended")
Model designer dialog base class

.. warning::

   Not stable API

.. versionadded:: 3.14
%End

%TypeHeaderCode
#include "qgsmodeldesignerdialog.h"
%End
  public:
    QgsModelDesignerDialog( QWidget *parent /TransferThis/ = 0, Qt::WindowFlags flags = Qt::WindowFlags() );
    ~QgsModelDesignerDialog();

    virtual void closeEvent( QCloseEvent *event );


    void beginUndoCommand( const QString &text, int id = 0 );
%Docstring
Starts an undo command. This should be called before any changes are
made to the model.
%End

    void endUndoCommand();
%Docstring
Ends the current undo command. This should be called after changes are
made to the model.
%End

    QgsProcessingModelAlgorithm *model();
%Docstring
Returns the model shown in the dialog.
%End

    void setModel( QgsProcessingModelAlgorithm *model /Transfer/ );
%Docstring
Sets the ``model`` shown in the dialog.

Ownership of ``model`` is transferred to the dialog.
%End

    void loadModel( const QString &path );
%Docstring
Loads a model into the designer from the specified file ``path``.
%End

    void setModelScene( QgsModelGraphicsScene *scene /Transfer/ );
%Docstring
Sets the related ``scene``.
%End

    enum class SaveAction
    {
      SaveAsFile,
      SaveInProject,
    };

  public slots:

    void activate();
%Docstring
Raise, unminimize and activate this window.

.. versionadded:: 3.24
%End

  protected:

    virtual void repaintModel( bool showControls = true ) = 0;
    virtual void addAlgorithm( const QString &algorithmId, const QPointF &pos ) = 0;

    virtual void addInput( const QString &inputId, const QPointF &pos ) = 0;

    virtual void exportAsScriptAlgorithm() = 0;

    virtual bool saveModel( bool saveAs = false ) = 0;

    virtual QgsProcessingAlgorithmDialogBase *createExecutionDialog() = 0 /TransferBack/;

    QToolBar *toolbar();
    QAction *actionOpen();
    QAction *actionSaveInProject();
    QAction *actionRun();
    QgsMessageBar *messageBar();
    QGraphicsView *view();

    void setDirty( bool dirty );

    bool validateSave( SaveAction action );
%Docstring
Checks if the model can current be saved, and returns ``True`` if it
can.
%End

    bool checkForUnsavedChanges();
%Docstring
Checks if there are unsaved changes in the model, and if so, prompts the
user to save them.

Returns ``False`` if the cancel option was selected
%End

    void setLastRunResult( const QgsProcessingModelResult &result );
%Docstring
Sets the ``result`` of the last run of the model through the designer
window.
%End

    void setModelName( const QString &name );
%Docstring
Sets the model ``name``.

Updates both the name text edit and the model name itself.

.. versionadded:: 3.24
%End

};


class QgsModelChildDependenciesWidget : QWidget
{

%TypeHeaderCode
#include "qgsmodeldesignerdialog.h"
%End
  public:
    QgsModelChildDependenciesWidget( QWidget *parent, QgsProcessingModelAlgorithm *model, const QString &childId );
    QList<QgsProcessingModelChildDependency> value() const;
    void setValue( const QList<QgsProcessingModelChildDependency> &value );
};

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