summaryrefslogtreecommitdiffstats
path: root/python/pyqt/sip/qt/qmultilinedit.sip
blob: 1d407bae0e4c1c4d09fdf3acfaa7b8f8e6c86bde (plain)
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
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
// This is the SIP interface definition for QMultiLineEdit.
//
// Copyright (c) 2007
// 	Riverbank Computing Limited <info@riverbankcomputing.co.uk>
// 
// This file is part of PyQt.
// 
// This copy of PyQt is free software; you can redistribute it and/or modify it
// under the terms of the GNU General Public License as published by the Free
// Software Foundation; either version 2, or (at your option) any later
// version.
// 
// PyQt is supplied 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
// PyQt; see the file LICENSE.  If not, write to the Free Software Foundation,
// Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.


%ExportedDoc
<Sect2><Title>QMultiLineEdit</Title>
<FuncSynopsis>
        <FuncDef>void <Function>cursorPosition</Function> const</FuncDef>
        <ParamDef>int *<Parameter>line</Parameter></ParamDef>
        <ParamDef>int *<Parameter>col</Parameter></ParamDef>
</FuncSynopsis>
<Para>
This takes no parameters and returns a tuple of the <Literal>line</Literal> and
<Literal>col</Literal> values.  (Qt v1.x, Qt v2.x)
</Para>

<FuncSynopsis>
        <FuncDef>virtual void <Function>del</Function></FuncDef>
        <ParamDef></ParamDef>
</FuncSynopsis>
<Para>
This has been renamed <Literal>delChar</Literal> in Python.  (Qt v1.x, Qt v2.x)
</Para>

<FuncSynopsis>
        <FuncDef>void <Function>getCursorPosition</Function> const</FuncDef>
        <ParamDef>int *<Parameter>line</Parameter></ParamDef>
        <ParamDef>int *<Parameter>col</Parameter></ParamDef>
</FuncSynopsis>
<Para>
This takes no parameters and returns a tuple of the <Literal>line</Literal> and
<Literal>col</Literal> values.  (Qt v1.x, Qt v2.x)
</Para>

<FuncSynopsis>
        <FuncDef>bool <Function>getMarkedRegion</Function></FuncDef>
        <ParamDef>int *<Parameter>line1</Parameter></ParamDef>
        <ParamDef>int *<Parameter>col1</Parameter></ParamDef>
        <ParamDef>int *<Parameter>line2</Parameter></ParamDef>
        <ParamDef>int *<Parameter>col2</Parameter></ParamDef>
</FuncSynopsis>
<Para>
This takes no parameters and returns a tuple of the bool result and the
<Literal>line1</Literal>, <Literal>col1</Literal>, <Literal>line2</Literal> and
<Literal>col2</Literal> values.
</Para>
</Sect2>
%End


%If (Qt_3_0_0 -)

class QMultiLineEdit : QTextEdit
{
%TypeHeaderCode
#include <qmultilineedit.h>
%End

public:
	QMultiLineEdit(QWidget * /TransferThis/ = 0,const char * = 0);

	QString textLine(int) const;
	int numLines() const;

	virtual void insertLine(const QString &,int = -1);
%If (Qt_3_1_0 -)
	virtual void insertAt(const QString &,int,int);
	virtual void insertAt(const QString &,int,int,bool);
%End
%If (- Qt_3_1_0)
	virtual void insertAt(const QString &,int,int,bool = 0);
%End
	virtual void removeLine(int);

%If (Qt_3_1_0 -)
	virtual void setCursorPosition(int,int);
	virtual void setCursorPosition(int,int,bool);
%End
%If (- Qt_3_1_0)
	virtual void setCursorPosition(int,int,bool = 0);
%End
	bool atBeginning() const;
	bool atEnd() const;

	void setAlignment(int);
	int alignment() const;

	void setEdited(bool);
	bool edited() const;

	bool hasMarkedText() const;
	QString markedText() const;

	void cursorWordForward(bool);
	void cursorWordBackward(bool);

	bool autoUpdate() const;
	virtual void setAutoUpdate(bool);

	int totalWidth() const;
	int totalHeight() const;

	int maxLines() const;
	void setMaxLines(int);

public slots:
	void deselect();

protected:
	QPoint cursorPoint() const;
	virtual void insertAndMark(const QString &,bool);
	virtual void newLine();
	virtual void killLine();
	virtual void pageUp(bool = 0);
	virtual void pageDown(bool = 0);
	virtual void cursorLeft(bool = 0,bool = 1);
	virtual void cursorRight(bool = 0,bool = 1);
	virtual void cursorUp(bool = 0);
	virtual void cursorDown(bool = 0);
	virtual void backspace();
	virtual void home(bool = 0);
	virtual void end(bool = 0);
	bool getMarkedRegion(int *,int *,int *,int *) const;
	int lineLength(int) const;

private:
	QMultiLineEdit(const QMultiLineEdit &);
};

%End


%If (- Qt_3_0_0)

class QMultiLineEdit : QTableView
{
%TypeHeaderCode
#include <qmultilinedit.h>
%End

public:
	QMultiLineEdit(QWidget * /TransferThis/ = 0,const char * = 0);

	int numLines() const;
	virtual void removeLine(int);

	void cursorPosition(int *,int *) const;
	void getCursorPosition(int *,int *) const;

	bool atBeginning() const;
	bool atEnd() const;
	int maxLineWidth() const;
	bool autoUpdate() const;
	bool isReadOnly() const;
	bool isOverwriteMode() const;
	QString text() const;

%If (- Qt_2_00)
	const char *textLine(int) const;
	void setFont(const QFont &);
	virtual void insertLine(const char *,int = -1);
	virtual void insertAt(const char *,int,int);
	void setCursorPosition(int,int,bool = 0);
	void setFixedVisibleLines(int);
	void setAutoUpdate(bool);
%End

%If (Qt_2_00 -)
	QString textLine(int) const;
	QSize sizeHint() const;
	QSize minimumSizeHint() const;
	QSizePolicy sizePolicy() const;
	virtual void setFont(const QFont &);
	virtual void insertLine(const QString &,int = -1);
	virtual void insertAt(const QString &,int,int,bool = 0);
	virtual void setCursorPosition(int,int,bool = 0);
	virtual void setFixedVisibleLines(int);
	void setAlignment(int);
	int alignment() const;
	virtual void setValidator(const QValidator *);
	const QValidator *validator() const;
	void setEdited(bool);
	bool edited() const;
	void cursorWordForward(bool);
	void cursorWordBackward(bool);

	enum EchoMode
	{
		Normal,
		NoEcho,
		Password
	};

	virtual void setEchoMode(EchoMode);
	EchoMode echoMode() const;
	virtual void setMaxLineLength(int);
	int maxLineLength() const;
	virtual void setMaxLines(int);
	int maxLines() const;
	virtual void setHMargin(int);
	int hMargin() const;
	virtual void setSelection(int,int,int,int);
	virtual void setAutoUpdate(bool);
%End

%If (Qt_2_1_0 -)
	void setMaxLength(int);
	int maxLength() const;

	enum WordWrap {
		NoWrap,
		WidgetWidth,
		FixedPixelWidth,
		FixedColumnWidth
	};

	void setWordWrap(WordWrap);
	WordWrap wordWrap() const;
	void setWrapColumnOrWidth(int);
	int wrapColumnOrWidth() const;
 
	enum WrapPolicy {
		AtWhiteSpace,
		Anywhere
	};

	void setWrapPolicy(WrapPolicy);
	WrapPolicy wrapPolicy() const;
	void setUndoEnabled(bool);
	bool isUndoEnabled() const;
	void setUndoDepth(int);
	int undoDepth() const;
	int length() const;
	static void setDefaultTabStop(int);
	static int defaultTabStop();
%End

public slots:
	void clear();
	void deselect();
	void selectAll();
%If (Qt_CLIPBOARD)
	void paste();
%If (Qt_2_2_0 -)
	void pasteSubType(const QCString &);
%End
	void cut();
%End
%If (- Qt_2_00)
	void setText(const char *);
	void setReadOnly(bool);
	void setOverwriteMode(bool);
	void append(const char *);
	void copyText();
%End
%If (Qt_2_00 -)
	virtual void setText(const QString &);
	virtual void setReadOnly(bool);
	virtual void setOverwriteMode(bool);
	void append(const QString &);
%If (Qt_CLIPBOARD)
	void copyText() const;
	void copy() const;
%End
	void insert(const QString &);
%End
%If (Qt_2_1_0 -)
	void undo();
	void redo();
%End

signals:
	void textChanged();
	void returnPressed();
%If (Qt_2_1_0 -)
	void undoAvailable(bool);
	void redoAvailable(bool);
%End
%If (Qt_2_2_0 -)
	void copyAvailable(bool);
%End

protected:
	void paintCell(QPainter *,int,int);
%If (Qt_2_2_0 -)
	bool event(QEvent *);
%End
	void mousePressEvent(QMouseEvent *);
	void mouseMoveEvent(QMouseEvent *);
	void mouseReleaseEvent(QMouseEvent *);
	void mouseDoubleClickEvent(QMouseEvent *);
%If (Qt_2_00 -)
	void wheelEvent(QWheelEvent *);
%End
	void keyPressEvent(QKeyEvent *);
	void focusInEvent(QFocusEvent *);
	void focusOutEvent(QFocusEvent *);
	void timerEvent(QTimerEvent *);
	void leaveEvent(QEvent *);
	void resizeEvent(QResizeEvent *);
%If (Qt_DRAGANDDROP)
%If (Qt_2_00 -)
	void dragMoveEvent(QDragMoveEvent *);
%End
%If (Qt_2_1_0 -)
	void dragEnterEvent(QDragEnterEvent *);
%End
%If (Qt_2_00 -)
	void dropEvent(QDropEvent *);
	void dragLeaveEvent(QDragLeaveEvent *);
%End
%End
	bool hasMarkedText() const;
	QString markedText() const;
	int textWidth(int);
%If (- Qt_2_00)
	int textWidth(QString *);
%End
%If (Qt_2_00 -)
	int textWidth(const QString &);
%End
	QPoint cursorPoint() const;
%If (- Qt_2_00)
	virtual void insertChar(char);
%End
%If (Qt_2_00 -)
	virtual void insert(const QString &,bool);
%End
	virtual void newLine();
	virtual void killLine();
	virtual void pageUp(bool = 0);
	virtual void pageDown(bool = 0);
	virtual void cursorLeft(bool = 0,bool = 1);
	virtual void cursorRight(bool = 0,bool = 1);
	virtual void cursorUp(bool = 0);
	virtual void cursorDown(bool = 0);
	virtual void backspace();
	virtual void del() /PyName=delChar/;
	virtual void home(bool = 0);
	virtual void end(bool = 0);
	bool getMarkedRegion(int *,int *,int *,int *) const;
	int lineLength(int) const;
	QString *getString(int) const;
%If (Qt_2_1_0 -)
	bool isEndOfParagraph(int) const;
%End
%If (Qt_2_00 -)
	QString stringShown(int) const;
	void insertChar(QChar);
%End

private:
	QMultiLineEdit(const QMultiLineEdit &);
};

%End