summaryrefslogtreecommitdiffstats
path: root/chalk/plugins/viewplugins/scripting/chalkcore/krs_doc.h
blob: c06e530a8d98e180b65724547fc159fb7291757a (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
/*
 *  Copyright (c) 2005 Cyrille Berger <[email protected]>
 *
 *  This program 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, or
 *  (at your option) any later version.
 *
 *  This program 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 program; if not, write to the Free Software
 *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 */

#ifndef _KROSS_KRS_DOC_H_
#define _KROSS_KRS_DOC_H_

class KisDoc;

#include <api/class.h>

namespace Kross { namespace ChalkCore {

class Doc : public Kross::Api::Class<Doc>
{
    public:
        explicit Doc(::KisDoc* doc);
        virtual ~Doc();
        virtual const TQString getClassName() const;
    private:
        /**
         * This function return the Image associated with this Doc.
         * 
         * Example (in Ruby) :
         * @code
         * doc = krosschalkcore::get("ChalkDocument")
         * image = doc.getImage()
         * @endcode
         */
        Kross::Api::Object::Ptr getImage(Kross::Api::List::Ptr);
    private:
        KisDoc* m_doc;

};
}
}


#endif