summaryrefslogtreecommitdiffstats
path: root/lib/kofficecore/KoDocumentIface.h
blob: 546859ce3657052dfa360d563b3a085ea4de3249 (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
/* This file is part of the KDE project
   Copyright (C) 2000 David Faure <faure@kde.org>

   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Library General Public
   License as published by the Free Software Foundation; either
   version 2 of the License.

   This library 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
   Library General Public License for more details.

   You should have received a copy of the GNU Library General Public License
   along with this library; see the file COPYING.LIB.  If not, write to
   the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA 02110-1301, USA.
*/

#ifndef __KoDocumentIface_h__
#define __KoDocumentIface_h__

#include <dcopobject.h>
#include <tqvaluelist.h>
#include <dcopref.h>
#include <koffice_export.h>
class KoDocument;
class KDCOPActionProxy;

/**
 * DCOP interface for any KOffice document
 * Use KoApplicationIface to get hold of an existing document's interface,
 * or to create a document.
 *
 * Note: KOffice Applications may (and should) reimplement KoDocument::dcopObject()
 * In this case, don't look here... (unless the DCOP interface for the document
 * inherits KoDocumentIface, which is a good thing to do)
 */
class KOFFICECORE_EXPORT KoDocumentIface : public DCOPObject
{
    K_DCOP
public:

    KoDocumentIface( KoDocument * doc, const char * name = 0 );
    ~KoDocumentIface();

    /**
     * Generate a name for this interface. Automatically used if name=0 is
     * passed to the constructor
     */
    static TQCString newIfaceName();

k_dcop:
    /**
     * Returns the URL for this document (empty, real URL, or internal one)
     */
    TQString url();

    /**
     * Opens a document stored in @p url
     * Warning: this is asynchronous. The document might not be loaded yet when
     * this call returns. See isLoading.
     */
    void openURL( TQString url );

    /**
     * @return TRUE is the document is still loading
     */
    bool isLoading();

    /**
     * @return TRUE is the document has been modified
     */
    bool isModified();

    /**
     * @return the number of views this document is displayed in
     */
    int viewCount();

    /**
     * @return a DCOP reference (DCOPRef) to the view with index @p idx
     */
    DCOPRef view( int idx );

    /**
     * DCOP-action proxy
     */
    DCOPRef action( const TQCString &name );
    /**
     * @return list of actions
     */
    QCStringList actions();
    /**
     * @return a map of (action name, DCOP reference)
     */
    TQMap<TQCString,DCOPRef> actionMap();

    /**
     * Saves the document under its existing filename
     */
    void save();

    /**
     * Saves the document under a new name
     */
    void saveAs( const TQString & url );

    void setOutputMimeType( const TQCString & mimetype );

    TQString documentInfoAuthorName() const;
    TQString documentInfoEmail() const;
    TQString documentInfoCompanyName() const;
    TQString documentInfoTitle() const;
    TQString documentInfoAbstract() const;
    TQString documentInfoKeywords() const;
    TQString documentInfoSubject() const;
    TQString documentInfoTelephone() const;
    TQString documentInfoTelephoneWork() const;
    TQString documentInfoTelephoneHome() const;
    TQString documentInfoFax() const;
    TQString documentInfoCountry() const;
    TQString documentInfoPostalCode() const;
    TQString documentInfoCity() const;
    TQString documentInfoStreet() const;
    TQString documentInfoInitial() const;
    TQString documentInfoAuthorPostion() const;
    void setDocumentInfoAuthorName(const TQString & text);
    void setDocumentInfoEmail(const TQString &text);
    void setDocumentInfoCompanyName(const TQString &text);
    void setDocumentInfoTelephone(const TQString &text);
    void setDocumentInfoTelephoneWork(const TQString &text);
    void setDocumentInfoTelephoneHome(const TQString &text);
    void setDocumentInfoFax(const TQString &text);
    void setDocumentInfoCountry(const TQString &text);
    void setDocumentInfoTitle(const TQString & text);
    void setDocumentInfoPostalCode(const TQString &text);
    void setDocumentInfoCity(const TQString & text);
    void setDocumentInfoStreet(const TQString &text);
    void setDocumentInfoAbstract(const TQString &text);
    void setDocumentInfoInitial(const TQString & text);
    void setDocumentInfoKeywords(const TQString & text );
    void setDocumentInfoSubject(const TQString & text);
    void setDocumentInfoAuthorPosition(const TQString & text);

public:
    virtual QCStringList functionsDynamic();
    virtual bool processDynamic( const TQCString &fun, const TQByteArray &data,
                                 TQCString& replyType, TQByteArray &replyData );

protected:
    KoDocument * m_pDoc;
    KDCOPActionProxy *m_actionProxy;
};

#endif