summaryrefslogtreecommitdiffstats
path: root/xparts/src/interfaces/xparthost.h
blob: 3d1d95f4bdd04d78eeec694cb35fb82d0b73be48 (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
#ifndef __xkparts_parthost_h__
#define __xkparts_parthost_h__

#include <dcopobject.h>
#include <dcopref.h>

class XPartHost : public DCOPObject
{
    K_DCOP
public:
    XPartHost(QCString name) : DCOPObject(name) {}
    
k_dcop:

    /** The XPart should register itself to its host when it is created */
    virtual DCOPRef registerXPart( const DCOPRef &part ) = 0;

    /** Returns the registered part */
    virtual DCOPRef part() = 0;

    /** The XPart informs its host about its available actions.
     * the actions are sent to the XPart using XPart::activateAction */
    virtual ASYNC createActions( const QCString &xmlActions ) = 0;

    /** DCOP signal emitted by the XPart and received here, to be 
     * forwarded to the KPartHost. See KParts documentation for
     * more details. */
    virtual ASYNC setWindowCaption( const QString &caption ) = 0;

    /** DCOP signal emitted by the XPart and received here, to be 
     * forwarded to the KPartHost. See KParts documentation for
     * more details. */
    virtual ASYNC setStatusBarText( const QString &text ) = 0;


    /** DCOP signal emitted by the XPart and received here, to be 
     * forwarded to the KPartHost. See KParts documentation for
     * more details. */
    virtual ASYNC started() = 0;

    /** DCOP signal emitted by the XPart and received here, to be 
     * forwarded to the KPartHost. See KParts documentation for
     * more details. */
    virtual ASYNC completed() = 0;

    /** DCOP signal emitted by the XPart and received here, to be 
     * forwarded to the KPartHost. See KParts documentation for
     * more details. */
    virtual ASYNC canceled( const QString &errMsg ) = 0;

};

#endif