Code

* Lots of documentation for the Inkscape::XML namespace
[inkscape.git] / src / jabber_whiteboard / inkboard-document.h
1 /**
2  * Inkscape::Whiteboard::InkboardDocument - Inkboard document implementation
3  *
4  * Authors:
5  * David Yip <yipdw@rose-hulman.edu>
6  *
7  * Copyright (c) 2005 Authors
8  *
9  * Released under GNU GPL, read the file 'COPYING' for more information
10  */
12 #ifndef __INKSCAPE_WHITEBOARD_INKBOARDDOCUMENT_H__
13 #define __INKSCAPE_WHITEBOARD_INKBOARDDOCUMENT_H__
15 #include <glibmm.h>
17 #include "document.h"
18 #include "xml/document.h"
19 #include "xml/simple-node.h"
20 #include "xml/node-observer.h"
21 #include "jabber_whiteboard/defines.h"
22 #include "jabber_whiteboard/keynode.h"
23 #include "jabber_whiteboard/session-manager.h"
25 namespace Inkscape {
27 namespace Whiteboard {
29 class InkboardDocument : public XML::SimpleNode,
30                          public XML::Document,
31                          public XML::NodeObserver
32 {
33 public:
34         
35     explicit InkboardDocument(int code, State::SessionType sessionType, Glib::ustring const& to);
37     XML::NodeType type() const
38     {
39         return Inkscape::XML::DOCUMENT_NODE;
40     }
42     State::SessionState state;
43     KeyNodeTable *tracker;
45     void setRecipient(Glib::ustring const& val);
46     Glib::ustring getRecipient() const;
48     void setSessionId(Glib::ustring const& val);
49     Glib::ustring getSessionId() const;
51     void startSessionNegotiation();
52     void terminateSession();
54     void recieve(Message::Wrapper &wrapper, Pedro::Element* data);
55     bool send(const Glib::ustring &destJid, Message::Wrapper &mwrapper, 
56             Message::Message &message);
58     void sendDocument(Inkscape::XML::Node* root);
60     bool handleOutgoingState(Message::Wrapper &wrapper,Glib::ustring const& message);
61     bool handleIncomingState(Message::Wrapper &wrapper,Pedro::Element* data);
63     bool handleState(State::SessionState expectedState, 
64             State::SessionState newstate);
66     void handleChange(Message::Wrapper &wrapper, Pedro::Element* data);
68     // 
69     // XML::Session methods
70     // 
71     bool inTransaction() 
72     {
73         return _in_transaction;
74     }
76     void beginTransaction();
77     void rollback();
78     void commit();
80     XML::Event* commitUndoable();
82     XML::Node* createElement(char const* name);
83     XML::Node* createTextNode(char const* content);
84     XML::Node* createComment(char const* content);
85     XML::Node* createPI(char const *target, char const* content);
87     //
88     // XML::NodeObserver methods
89     //
90     void notifyChildAdded(Inkscape::XML::Node &parent, Inkscape::XML::Node &child, Inkscape::XML::Node *prev);
92     void notifyChildRemoved(Inkscape::XML::Node &parent, Inkscape::XML::Node &child, Inkscape::XML::Node *prev);
94     void notifyChildOrderChanged(Inkscape::XML::Node &parent, Inkscape::XML::Node &child,
95                                  Inkscape::XML::Node *old_prev, Inkscape::XML::Node *new_prev);
97     void notifyContentChanged(Inkscape::XML::Node &node,
98                               Util::ptr_shared<char> old_content,
99                               Util::ptr_shared<char> new_content);
101     void notifyAttributeChanged(Inkscape::XML::Node &node, GQuark name,
102                                 Util::ptr_shared<char> old_value,
103                                 Util::ptr_shared<char> new_value);
105     /* Functions below are defined in inkboard-node.cpp */
106     Glib::ustring addNodeToTracker(Inkscape::XML::Node* node);
107     Message::Message composeNewMessage(Inkscape::XML::Node *node);
109     void changeConfigure(Glib::ustring target, unsigned int version,
110             Glib::ustring attribute, Glib::ustring value);
112     void changeNew(Glib::ustring target, Glib::ustring, 
113             signed int index, Pedro::Element* data);
115     void changeConfigureText(Glib::ustring target, unsigned int version,
116             Glib::ustring text);
118 protected:
119         /**
120          * Copy constructor.
121          * 
122          * \param orig Instance to copy.
123          */
124         InkboardDocument(InkboardDocument const& orig) :
125                 XML::Node(), XML::SimpleNode(orig),
126                 XML::Document(), XML::NodeObserver(),
127                 recipient(orig.recipient), _in_transaction(false)
128         {
129                 _initBindings();
130         }
132         XML::SimpleNode* _duplicate(XML::Document* /*xml_doc*/) const
133         {
134                 return new InkboardDocument(*this);
135         }
136         NodeObserver *logger() { return this; }
138 private:
139     void _initBindings();
141     SessionManager      *sm;
143     State::SessionType  sessionType;
145     Glib::ustring sessionId;
146     Glib::ustring recipient;
148     bool _in_transaction;
149 };
155 #endif
157 /*
158   Local Variables:
159   mode:c++
160   c-file-style:"stroustrup"
161   c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
162   indent-tabs-mode:nil
163   fill-column:99
164   End:
165 */
166 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=99 :