File: document.sip

package info (click to toggle)
pykde4 4%3A4.14.0-1
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 30,864 kB
  • ctags: 18,431
  • sloc: python: 2,063; cpp: 327; makefile: 52; sh: 5
file content (279 lines) | stat: -rw-r--r-- 10,971 bytes parent folder | download | duplicates (2)
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
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
//
//     Copyright 2007 Jim Bublitz <jbublitz@nwinternet.com>
//     Earlier copyrights 1998 - 2006 Jim Bublitz also apply


//                 Generated by preSip


// This file is part of PyKDE4.

// PyKDE4 is free software; you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as
// published by the Free Software Foundation; either version 2.1 of
// the License, or (at your option) any later version.

// PyKDE4 is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.

// You should have received a copy of the GNU General Public License
// along with this program.  If not, see <http://www.gnu.org/licenses/>.

namespace KTextEditor
{

class Document : KParts::ReadWritePart
{
%TypeHeaderCode
#include <ktexteditor/document.h>

#include <ktexteditor/modificationinterface.h>
#include <ktexteditor/markinterface.h>
#include <ktexteditor/searchinterface.h>
#include <ktexteditor/sessionconfiginterface.h>
#include <ktexteditor/smartinterface.h>
#include <ktexteditor/templateinterface.h>
#include <ktexteditor/variableinterface.h>
#include <ktexteditor/movinginterface.h>
#include <ktexteditor/annotationinterface.h>
#include <ktexteditor/highlightinterface.h>
#include <ktexteditor/configinterface.h>
#include <ktexteditor/modeinterface.h>
#include <ktexteditor/sessionconfiginterface.h>
#include <ktexteditor/recoveryinterface.h>

%End


public:
                            Document (QObject* parent /TransferThis/ = 0);

    virtual KTextEditor::Editor*  editor ()=0;
    virtual KTextEditor::View*  createView (QWidget* parent /Transfer/)=0;
    virtual KTextEditor::View*  activeView () const=0;
    virtual const QList<KTextEditor::View*>&  views () const=0;

signals:
    void                    viewCreated (KTextEditor::Document* document, KTextEditor::View* view);

public:
    virtual const QString&  documentName () const=0;
    virtual QString         mimeType ()=0;

signals:
    void                    documentNameChanged (KTextEditor::Document* document);
    void                    documentUrlChanged (KTextEditor::Document* document);
    void                    modifiedChanged (KTextEditor::Document* document);

public:
    virtual bool            setEncoding (const QString& encoding)=0;
    virtual const QString&  encoding () const=0;

    virtual bool            documentReload ()=0;
    virtual bool            documentSave ()=0;
    virtual bool            documentSaveAs ()=0;

    virtual bool            startEditing ()=0;
    virtual bool            endEditing ()=0;

    virtual QString         text () const=0;
    virtual QString         text (const KTextEditor::Range& range, bool block = 0) const=0;
    virtual QChar           character (const KTextEditor::Cursor& position) const=0;
    virtual QStringList     textLines (const KTextEditor::Range& range, bool block = 0) const=0;
    virtual QString         line (int line) const=0;
    virtual int             lines () const=0;
    virtual KTextEditor::Cursor  documentEnd () const=0;
    KTextEditor::Range      documentRange () const;
    virtual int             totalCharacters () const=0;
    virtual bool            isEmpty () const;
    virtual int             lineLength (int line) const=0;
    KTextEditor::Cursor     endOfLine (int line) const;
    virtual bool            setText (const QString& text)=0;
    virtual bool            setText (const QStringList& text)=0;
    virtual bool            clear ()=0;
    virtual bool            insertText (const KTextEditor::Cursor& position, const QString& text, bool block = 0)=0;
    virtual bool            insertText (const KTextEditor::Cursor& position, const QStringList& text, bool block = 0)=0;
    virtual bool            replaceText (const KTextEditor::Range& range, const QString& text, bool block = 0);
    virtual bool            replaceText (const KTextEditor::Range& range, const QStringList& text, bool block = 0);
    virtual bool            removeText (const KTextEditor::Range& range, bool block = 0)=0;
    virtual bool            cursorInText (const KTextEditor::Cursor& cursor);
    virtual bool            insertLine (int line, const QString& text)=0;
    virtual bool            insertLines (int line, const QStringList& text)=0;
    virtual bool            removeLine (int line)=0;

signals:
    void                    textChanged (KTextEditor::Document* document);
    void                    textInserted (KTextEditor::Document* document, const KTextEditor::Range& range);
    void                    textRemoved (KTextEditor::Document* document, const KTextEditor::Range& range);
    void                    textChanged (KTextEditor::Document* document, const KTextEditor::Range& oldRange, const KTextEditor::Range& newRange);
    void                    aboutToClose (KTextEditor::Document* document);

public:
    virtual QString         mode () const=0;
    virtual QString         highlightingMode () const=0;
    virtual QStringList     modes () const=0;
    virtual QStringList     highlightingModes () const=0;
    virtual bool            setMode (const QString& name)=0;
    virtual bool            setHighlightingMode (const QString& name)=0;

    virtual QString         highlightingModeSection (int index) const=0;
    virtual QString         modeSection (int index) const=0;


signals:
    void                    modeChanged (KTextEditor::Document* document);
    void                    highlightingModeChanged (KTextEditor::Document* document);

public:
    void                    setSuppressOpeningErrorDialogs (bool suppress);
    bool                    suppressOpeningErrorDialogs () const;
    bool                    openingError () const;
    QString                 openingErrorMessage () const;

protected:
    void                    setOpeningError (bool errors);
    void                    setOpeningErrorMessage (const QString& message);

// Python cannot dynamic_cast, so methods are provided that attempt
// to convert the Document to the required interface. They return
// None on failure.
//     Why no annotationinterface.sip?
public:

//force
    KTextEditor::AnnotationInterface *annotationInterface();
%MethodCode
    Py_BEGIN_ALLOW_THREADS
    sipRes = dynamic_cast<KTextEditor::AnnotationInterface*>(sipCpp);
    Py_END_ALLOW_THREADS
%End

    KTextEditor::MarkInterface *markInterface();
%MethodCode
    Py_BEGIN_ALLOW_THREADS
    sipRes = dynamic_cast<KTextEditor::MarkInterface*>(sipCpp);
    Py_END_ALLOW_THREADS
%End
    
    KTextEditor::ModificationInterface *modificationInterface();
%MethodCode
    Py_BEGIN_ALLOW_THREADS
    sipRes = dynamic_cast<KTextEditor::ModificationInterface*>(sipCpp);
    Py_END_ALLOW_THREADS
%End
    
    KTextEditor::SearchInterface *searchInterface();
%MethodCode
    Py_BEGIN_ALLOW_THREADS
    sipRes = dynamic_cast<KTextEditor::SearchInterface*>(sipCpp);
    Py_END_ALLOW_THREADS
%End
    
    KTextEditor::VariableInterface *variableInterface();
%MethodCode
    Py_BEGIN_ALLOW_THREADS
    sipRes = dynamic_cast<KTextEditor::VariableInterface*>(sipCpp);
    Py_END_ALLOW_THREADS
%End

    KTextEditor::MovingInterface *movingInterface();
%MethodCode
    Py_BEGIN_ALLOW_THREADS
    sipRes = dynamic_cast<KTextEditor::MovingInterface*>(sipCpp);
    Py_END_ALLOW_THREADS
%End

    KTextEditor::HighlightInterface *highlightInterface();
%MethodCode
    Py_BEGIN_ALLOW_THREADS
    sipRes = dynamic_cast<KTextEditor::HighlightInterface*>(sipCpp);
    Py_END_ALLOW_THREADS
%End

    KTextEditor::ConfigInterface *configInterface();
%MethodCode
    Py_BEGIN_ALLOW_THREADS
    sipRes = dynamic_cast<KTextEditor::ConfigInterface*>(sipCpp);
    Py_END_ALLOW_THREADS
%End

    KTextEditor::ParameterizedSessionConfigInterface *parameterizedSessionConfigInterface();
%MethodCode
    Py_BEGIN_ALLOW_THREADS
    sipRes = dynamic_cast<KTextEditor::ParameterizedSessionConfigInterface*>(sipCpp);
    Py_END_ALLOW_THREADS
%End

    KTextEditor::SessionConfigInterface *sessionConfigInterface();
%MethodCode
    Py_BEGIN_ALLOW_THREADS
    sipRes = dynamic_cast<KTextEditor::SessionConfigInterface*>(sipCpp);
    Py_END_ALLOW_THREADS
%End

    KTextEditor::RecoveryInterface *recoveryInterface();
%MethodCode
    Py_BEGIN_ALLOW_THREADS
    sipRes = dynamic_cast<KTextEditor::RecoveryInterface*>(sipCpp);
    Py_END_ALLOW_THREADS
%End

//end

    virtual ~Document ();
signals:
    void                    documentSavedOrUploaded (KTextEditor::Document* document, bool saveAs);
    void                    textRemoved (KTextEditor::Document* document, const KTextEditor::Range& range, const QString& oldText);
    void                    textChanged (KTextEditor::Document* document, const KTextEditor::Range& oldRange, const QString& oldText, const KTextEditor::Range& newRange);
    void                    aboutToReload (KTextEditor::Document* document);
    void                    reloaded (KTextEditor::Document* document);
    void                    exclusiveEditStart (KTextEditor::Document* document);
    void                    exclusiveEditEnd (KTextEditor::Document* document);
%ConvertToSubClassCode
    // CTSCC for subclasses of 'QObject'
    sipType = NULL;

    if (dynamic_cast<KTextEditor::Document*>(sipCpp))
        sipType = sipType_KTextEditor_Document;
    else if (dynamic_cast<KTextEditor::AnnotationModel*>(sipCpp))
        sipType = sipType_KTextEditor_AnnotationModel;
    else if (dynamic_cast<KTextEditor::Editor*>(sipCpp))
        sipType = sipType_KTextEditor_Editor;
    else if (dynamic_cast<KTextEditor::LoadSaveFilterCheckPlugin*>(sipCpp))
        sipType = sipType_KTextEditor_LoadSaveFilterCheckPlugin;
    else if (dynamic_cast<KTextEditor::Plugin*>(sipCpp))
        sipType = sipType_KTextEditor_Plugin;
    else if (dynamic_cast<KTextEditor::CodeCompletionModel*>(sipCpp))
        {
        sipType = sipType_KTextEditor_CodeCompletionModel;
        if (dynamic_cast<KTextEditor::CodeCompletionModel2*>(sipCpp))
            sipType = sipType_KTextEditor_CodeCompletionModel2;
        }
    else if (dynamic_cast<KTextEditor::ConfigPage*>(sipCpp))
        sipType = sipType_KTextEditor_ConfigPage;
    else if (dynamic_cast<KTextEditor::EditorChooser*>(sipCpp))
        sipType = sipType_KTextEditor_EditorChooser;
    else if (dynamic_cast<KTextEditor::View*>(sipCpp))
        sipType = sipType_KTextEditor_View;
%End
};
// class Document

};
// namespace KTextEditor

%ModuleHeaderCode
//ctscc
#include <ktexteditor/annotationinterface.h>
#include <ktexteditor/codecompletionmodel.h>
#include <ktexteditor/configpage.h>
#include <ktexteditor/document.h>
#include <ktexteditor/editor.h>
#include <ktexteditor/editorchooser.h>
#include <ktexteditor/loadsavefiltercheckplugin.h>
#include <ktexteditor/plugin.h>
#include <qobject.h>
#include <ktexteditor/view.h>
%End