diff --git a/src/xml/log-builder.h b/src/xml/log-builder.h
index 1f1ea1959423d39d6f78da1e6e0a03b0be67b617..264c2ced72583995329ed47bc3beac7706e69e9d 100644 (file)
--- a/src/xml/log-builder.h
+++ b/src/xml/log-builder.h
-/*
- * Inkscape::XML::LogBuilder - NodeObserver which builds an event log
- *
- * Copyright 2005 MenTaLguY <mental@rydia.net>
+/** @file
+ * @brief Object building an event log
+ */
+/* Copyright 2005 MenTaLguY <mental@rydia.net>
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* of the License, or (at your option) any later version.
*
* See the file COPYING for details.
- *
*/
#ifndef SEEN_INKSCAPE_XML_LOG_BUILDER_H
#define SEEN_INKSCAPE_XML_LOG_BUILDER_H
#include "gc-managed.h"
+#include "xml/xml-forward.h"
#include "xml/node-observer.h"
namespace Inkscape {
namespace XML {
-class Event;
-
+/**
+ * @brief Event log builder
+ *
+ * This object records all events sent to it via the public methods in an internal event log.
+ * Calling detach() then returns the built log. Calling discard() will clear all the events
+ * recorded so far.
+ */
class LogBuilder {
public:
LogBuilder() : _log(NULL) {}
~LogBuilder() { discard(); }
+ /** @name Manipulate the recorded event log
+ * @{ */
+ /**
+ * @brief Clear the internal log
+ */
void discard();
+ /**
+ * @brief Get the internal event log
+ * @return The recorded event chain
+ */
Event *detach();
+ /*@}*/
+ /** @name Record events in the log
+ * @{ */
void addChild(Node &node, Node &child, Node *prev);
void removeChild(Node &node, Node &child, Node *prev);
Node *old_prev, Node *new_prev);
void setContent(Node &node,
- Util::SharedCStringPtr old_content,
- Util::SharedCStringPtr new_content);
+ Util::ptr_shared<char> old_content,
+ Util::ptr_shared<char> new_content);
void setAttribute(Node &node, GQuark name,
- Util::SharedCStringPtr old_value,
- Util::SharedCStringPtr new_value);
+ Util::ptr_shared<char> old_value,
+ Util::ptr_shared<char> new_value);
+ /*@}*/
private:
Event *_log;
fill-column:99
End:
*/
-// vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=99 :
+// vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:fileencoding=utf-8:textwidth=99 :