summaryrefslogtreecommitdiffstats
path: root/sip/kparts/part.sip
blob: 4b8ca8172eeb066807e457463683a5bf8dcf58e9 (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
//
//     Copyright 2006 Jim Bublitz <jbublitz@nwinternet.com>
//     Earlier copyrights 1998 - 2005 Jim Bublitz and/or Phil Thompson
//     may also apply


//                 Generated by preSip
//            module kparts  version KDE 3.5.3


// This software 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 of
// the License, or (at your option) any later version.
//
// This software 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 library; see the file COPYING.
// If not, write to the Free Software Foundation, Inc.,
// 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

namespace KParts
{

class PartBase : KXMLGUIClient
{
%TypeHeaderCode
#include <part.h>
%End


public:
                         PartBase ();
    void                 setPartObject (TQObject*);
    TQObject*             partObject () const;

protected:
    virtual void         setInstance (TDEInstance*);
    virtual void         setInstance (TDEInstance*, bool);

%If ( KDE_3_1_0 -  )
    void                 loadPlugins (TQObject* /Transfer/, KXMLGUIClient*, TDEInstance*);
//ig     void                 setPluginLoadingMode (KParts::PartBase::PluginLoadingMode);
%End


};  // class PartBase


class Part : TQObject, KParts::PartBase
{
%TypeHeaderCode
#include <part.h>
%End


public:
                         Part (TQObject* /TransferThis/ = 0, const char* = 0);
    virtual void         embed (TQWidget*);
    virtual TQWidget*     widget ();
    virtual void         setManager (KParts::PartManager*);
    KParts::PartManager* manager ();
    virtual KParts::Part* hitTest (TQWidget*, const TQPoint&);
    virtual void         setSelectable (bool);
    bool                 isSelectable () const;

signals:
    void                 setWindowCaption (const TQString&);
    void                 setStatusBarText (const TQString&);

protected:
    virtual void         setWidget (TQWidget*);
    virtual void         customEvent (TQCustomEvent*);
    virtual void         partActivateEvent (KParts::PartActivateEvent*);
    virtual void         partSelectEvent (KParts::PartSelectEvent*);
    virtual void         guiActivateEvent (KParts::GUIActivateEvent*);
    TQWidget*             hostContainer (const TQString&);

//force
%ConvertToSubClassCode
    // The table of Python class objects indexed by their names.  The table
    // must be sorted by name.

    static sipStringTypeClassMap map[] = {
        {sipName_BrowserExtension,        &sipClass_KParts_BrowserExtension},
        {sipName_BrowserHostExtension,    &sipClass_KParts_BrowserHostExtension},
        {sipName_BrowserInterface,        &sipClass_KParts_BrowserInterface},
        {sipName_BrowserRun,              &sipClass_KParts_BrowserRun},
        {sipName_Factory,                 &sipClass_KParts_Factory},
        {sipName_HistoryProvider,         &sipClass_KParts_HistoryProvider},
#if TDE_VERSION >= 0x030100
        {sipName_LiveConnectExtension,    &sipClass_KParts_LiveConnectExtension},
#endif
        {sipName_MainWindow,              &sipClass_KParts_MainWindow},
        {sipName_Part,                    &sipClass_KParts_Part},
        {sipName_PartManager,             &sipClass_KParts_PartManager},
        {sipName_Plugin,                  &sipClass_KParts_Plugin},
        {sipName_ReadOnlyPart,            &sipClass_KParts_ReadOnlyPart},
        {sipName_ReadWritePart,           &sipClass_KParts_ReadWritePart},
    };

    sipClass = sipMapStringToClass(sipCpp -> className(),map,sizeof (map)/sizeof (map[0]));
%End
//end

};  // class Part

//doc
// Even though this is an abstract class, you can use
// createReadOnlyPart (see below) without creating
// a concrete instance of this class.
//end

class ReadOnlyPart : KParts::Part
{
%TypeHeaderCode
#include <part.h>
%End


public:
                         ReadOnlyPart (TQObject* /TransferThis/ = 0, const char* = 0);
    void                 setProgressInfoEnabled (bool);
    bool                 isProgressInfoEnabled () const;
    void                 showProgressInfo (bool);

public slots:
    virtual bool         openURL (const KURL&);

public:
    KURL                 url () const;
    virtual bool         closeURL ();

public:
    bool                 openStream (const TQString&, const KURL&);
    bool                 writeStream (const TQByteArray&);
    bool                 closeStream ();

signals:
    void                 started (KIO::Job*);
    void                 completed ();
    void                 completed (bool);
    void                 canceled (const TQString&);

protected slots:
    void                 slotJobFinished (KIO::Job*);

protected:
    virtual bool         openFile ()  = 0;
    void                 abortLoad ();
    virtual void         guiActivateEvent (KParts::GUIActivateEvent*);

};  // class ReadOnlyPart

//doc
// Even though this is an abstract class, you can use
// createReadWritePart (see below) without creating a concrete instance
// of this class.
//end

class ReadWritePart : KParts::ReadOnlyPart
{
%TypeHeaderCode
#include <part.h>
%End


public:
                         ReadWritePart (TQObject* /TransferThis/ = 0, const char* = 0);
    bool                 isReadWrite () const;
    virtual void         setReadWrite (bool = 1);
    bool                 isModified () const;

%If ( KDE_3_1_3 -  )
    bool                 queryClose ();
%End

    virtual bool         closeURL ();

%If ( KDE_3_1_3 -  )
    bool                 closeURL (bool);
%End

    virtual bool         saveAs (const KURL&);
    virtual void         setModified (bool);

signals:

%If ( KDE_3_2_0 -  )
//ig     void                 sigQueryClose (bool*, bool*);
%End


public slots:
    virtual void         setModified ();
    virtual bool         save ();

%If ( KDE_3_2_0 -  )
    bool                 waitSaveComplete ();
%End


protected:
    virtual bool         saveFile ()  = 0;
    virtual bool         saveToURL ();

protected slots:
    void                 slotUploadFinished (KIO::Job*);

};  // class ReadWritePart

};  // namespace KParts

//force
//doc
// <para>
// This is a PyKDE-only function that handles the machinery necessary
// to create a KParts::ReadOnlyPart. It executes the following C++ code:
// </para>
// <pre class="PROGRAMLISTING">
// KParts::ReadOnlyPart *createReadOnlyPart (const TQString&amp; lib, TQObject *parent,
//                                           const TQString&amp; name, const char *className,
//                                           const TQStringList &amp;args)
// {
//    KLibFactory *factory = KLibLoader::self ()-&gt;factory ((const char *)lib);
//
//    if (factory)
//            return static_cast&lt;KParts::ReadOnlyPart*&gt; (factory-&gt;create (parent,
//                                               (const char *)name, className, args));
//        else
//                return NULL;
// </pre>
// <para>
// Notice that it takes care of creating the KLibFactory for you, and
// returns the part cast to type KParts::ReadOnlyPart.  The actual
// part has a different class (derived from KParts::ReadOnlyPart),
// and calls to openURL or openFile will use the part's overloaded
// methods. Currently it isn't possible to call KParts::ReadOnlyPart::openURL
// if it has been overloaded.
// </para>
// <para>
// Usage: KParts.createReadOnlyPart (lib, parent, name, className, args)
// </para>
//end
KParts::ReadOnlyPart* createReadOnlyPart (const TQString&, TQObject* = 0, const TQString& = TQString ::null , const char* = "KParts::ReadOnlyPart", const TQStringList& = TQStringList ());
//doc
// <para>
// This is a PyKDE-only function that handles the machinery necessary
// to create a KParts::ReadWritePart. It executes the following C++ code:
// </para>
// <pre class="PROGRAMLISTING">
// KParts::ReadWritePart *createReadWritePart (const TQString&amp; lib, TQObject *parent,
//                                           const TQString&amp; name, const char *className,
//                                           const TQStringList &amp;args)
// {
//     KLibFactory *factory = KLibLoader::self ()-&gt;factory ((const char *)lib);
//
//     if (factory)
//             return static_cast&lt;KParts::ReadWritePart*&gt; (factory-&gt;create (parent,
//                                                (const char *)name, className, args));
//         else
//                 return NULL;
// </pre>
// <para>
// Notice that it takes care of creating the KLibFactory for you, and
// returns the part cast to type KParts::ReadWritePart.  The actual
// part has a different class (derived from KParts::ReadWritePart),
// and calls to openURL or openFile will use the part's overloaded
// methods. Currently it isn't possible to call KParts::ReadWritePart::openURL
// if it has been overloaded.
// </para>
// <para>
// Usage: KParts.createReadWritePart (lib, parent, name, className, args)
// </para>
//end
KParts::ReadWritePart* createReadWritePart (const TQString&, TQObject* = 0, const TQString& = TQString ::null , const char* = "KParts::ReadWritePart", const TQStringList& = TQStringList ());
//end


%ModuleCode
#include <klibloader.h>

KParts::ReadOnlyPart *createReadOnlyPart (const TQString& lib, TQObject *parent, const TQString& name, const char *className,
                                          const TQStringList &args)
{
        KParts::ReadOnlyPart *res = NULL;

        KLibFactory *factory = KLibLoader::self ()->factory ((const char *)lib);

        if (factory)
                res = static_cast<KParts::ReadOnlyPart*> (factory->create (parent, (const char *)name, className, args));

        return res;
}

KParts::ReadWritePart *createReadWritePart (const TQString& lib, TQObject *parent, const TQString& name, const char *className,
                                          const TQStringList &args)
{
        KParts::ReadWritePart *res = NULL;

        KLibFactory *factory = KLibLoader::self ()->factory ((const char *)lib);

        if (factory)
                res = static_cast<KParts::ReadWritePart*> (factory->create (parent, (const char *)name, className, args));

        return res;
}
%End