summaryrefslogtreecommitdiffstats
path: root/python/pyqt/sip/qt/qcstring.sip
blob: 64b3b2ab572965705cc0b8280a193b878f82cd15 (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
// This is the SIP interface definition for QCString.
//
// 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>QCString (Qt v2+)</Title>
<Para>
A Python string can be used whenever a <Literal>QCString</Literal> can be used.
A <Literal>QCString</Literal> can be converted to a Python string using the
Python <Literal>str()</Literal> function.
</Para>

<FuncSynopsis>
	<FuncDef>QCString &amp;<Function>sprintf</Function></FuncDef>
	<ParamDef>const char *<Parameter>format</Parameter></ParamDef>
	<ParamDef>...</ParamDef>
</FuncSynopsis>
<Para>
Not implemented.
</Para>

<FuncSynopsis>
	<FuncDef>short <Function>toShort</Function></FuncDef>
	<ParamDef>bool *<Parameter>ok</Parameter> = 0</ParamDef>
</FuncSynopsis>
<Para>
This returns a tuple of the <Literal>short</Literal> result and the
<Literal>ok</Literal> value.
</Para>

<FuncSynopsis>
	<FuncDef>ushort <Function>toUShort</Function></FuncDef>
	<ParamDef>bool *<Parameter>ok</Parameter> = 0</ParamDef>
</FuncSynopsis>
<Para>
This returns a tuple of the <Literal>ushort</Literal> result and the
<Literal>ok</Literal> value.
</Para>

<FuncSynopsis>
	<FuncDef>int <Function>toInt</Function></FuncDef>
	<ParamDef>bool *<Parameter>ok</Parameter> = 0</ParamDef>
</FuncSynopsis>
<Para>
This returns a tuple of the <Literal>int</Literal> result and the
<Literal>ok</Literal> value.
</Para>

<FuncSynopsis>
	<FuncDef>uint <Function>toUInt</Function></FuncDef>
	<ParamDef>bool *<Parameter>ok</Parameter> = 0</ParamDef>
</FuncSynopsis>
<Para>
This returns a tuple of the <Literal>uint</Literal> result and the
<Literal>ok</Literal> value.
</Para>

<FuncSynopsis>
	<FuncDef>long <Function>toLong</Function></FuncDef>
	<ParamDef>bool *<Parameter>ok</Parameter> = 0</ParamDef>
</FuncSynopsis>
<Para>
This returns a tuple of the <Literal>long</Literal> result and the
<Literal>ok</Literal> value.
</Para>

<FuncSynopsis>
	<FuncDef>ulong <Function>toULong</Function></FuncDef>
	<ParamDef>bool *<Parameter>ok</Parameter> = 0</ParamDef>
</FuncSynopsis>
<Para>
This returns a tuple of the <Literal>ulong</Literal> result and the
<Literal>ok</Literal> value.
</Para>

<FuncSynopsis>
	<FuncDef>float <Function>toFloat</Function></FuncDef>
	<ParamDef>bool *<Parameter>ok</Parameter> = 0</ParamDef>
</FuncSynopsis>
<Para>
This returns a tuple of the <Literal>float</Literal> result and the
<Literal>ok</Literal> value.
</Para>

<FuncSynopsis>
	<FuncDef>double <Function>toDouble</Function></FuncDef>
	<ParamDef>bool *<Parameter>ok</Parameter> = 0</ParamDef>
</FuncSynopsis>
<Para>
This returns a tuple of the <Literal>double</Literal> result and the
<Literal>ok</Literal> value.
</Para>
</Sect2>
%End


%If (Qt_2_00 -)

class QCString : QByteArray
{
%TypeHeaderCode
#include <qcstring.h>
%End

public:
	QCString();
	QCString(int);
	QCString(const QCString &);
	QCString(const char *);
	QCString(const char *,uint);

	bool isNull() const;
	bool isEmpty() const;
	uint length() const;
	bool resize(uint);
	bool truncate(uint);
	bool fill(char,int = -1);
	QCString copy() const;
//	QCString &sprintf(const char *,...);
//	int find(char,int = 0,bool = 1) const;
	int find(const char *,int = 0,bool = 1) const;
	int find(const QRegExp &,int = 0) const;
//	int findRev(char,int = -1,bool = 1) const;
	int findRev(const char *,int = -1,bool = 1) const;
	int findRev(const QRegExp &,int = -1) const;
//	int contains(char,bool = 1) const;
	int contains(const char *,bool = 1) const;
	int contains(const QRegExp &) const;
	QCString left(uint) const;
	QCString right(uint) const;
	QCString mid(uint,uint = 0xffffffff) const;
	QCString leftJustify(uint,char = ' ',bool = 0) const;
	QCString rightJustify(uint,char = ' ',bool = 0) const;
	QCString lower() const;
	QCString upper() const;
	QCString stripWhiteSpace() const;
	QCString simplifyWhiteSpace() const;
	QCString &insert(uint,const char *);
//	QCString &insert(uint,char);
	QCString &append(const char *);
	QCString &prepend(const char *);
	QCString &remove(uint,uint);
	QCString &replace(uint,uint,const char *);
	QCString &replace(const QRegExp &,const char *);
%If (Qt_3_1_0 -)
//	QCString &replace(char,const char *);
	QCString &replace(const char *,const char *);
//	QCString &replace(char,char);
%End

	short toShort(bool * = 0) const;
	ushort toUShort(bool * = 0) const;
	int toInt(bool * = 0) const;
	uint toUInt(bool * = 0) const;
	long toLong(bool * = 0) const;
	ulong toULong(bool * = 0) const;
	float toFloat(bool * = 0) const;
	double toDouble(bool * = 0) const;

	QCString &setStr(const char *);
//	QCString &setNum(short);
//	QCString &setNum(ushort);
	QCString &setNum(int /Constrained/);
//	QCString &setNum(uint);
//	QCString &setNum(long);
//	QCString &setNum(ulong);
//	QCString &setNum(float,char = 'g',int = 6);
	QCString &setNum(double,char = 'g',int = 6);
	bool setExpand(uint,char);

	SIP_PYOBJECT __str__();
%MethodCode
		const char *s;
 
		Py_BEGIN_ALLOW_THREADS
		s = *sipCpp;
		Py_END_ALLOW_THREADS

		if (s == NULL)
			s = "";
 
		sipRes = PyString_FromString(s);
%End

%ConvertToTypeCode
	// Allow a Python string whenever a QCString is expected.

	if (sipIsErr == NULL)
		return (PyString_Check(sipPy) ||
			sipCanConvertToInstance(sipPy,sipClass_QCString,SIP_NO_CONVERTORS));

	if (PyString_Check(sipPy))
	{
		*sipCppPtr = new QCString(PyString_AS_STRING(sipPy));

		return sipGetState(sipTransferObj);
	}

	*sipCppPtr = reinterpret_cast<QCString *>(sipConvertToInstance(sipPy,sipClass_QCString,sipTransferObj,SIP_NO_CONVERTORS,0,sipIsErr));

	return 0;
%End
};

%End