Code

remember sticky_zoom toggle button state
[inkscape.git] / src / dom / views.h
index f7d26bcfa3398ad618b4f57887d31e7ca1fc961a..9e87dfbe7a1aff5ddecc055573f3cdd5cc8fe3d6 100644 (file)
  *  You should have received a copy of the GNU Lesser General Public
  *  License along with this library; if not, write to the Free Software
  *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+ *  
+ * =========================================================================
+ * NOTES
+ * 
+ * This is the Level 2 Views definition, which is very minimalist.  It is
+ * described here:
+ * http://www.w3.org/TR/2000/REC-DOM-Level-2-Views-20001113
+ * 
+ * Note that SVG uses the DOM Core and Events Level 3, but Level 2 CSS and Views.         
+ * 
+ * The level 3 version is much larger:
+ * http://www.w3.org/TR/2004/NOTE-DOM-Level-3-Views-20040226
+ * Be prepared in the future to adjust to this, if SVG ever switches .
  */
 
 
@@ -61,14 +74,14 @@ class AbstractView;
 #########################################################################*/
 
 /**
- *
+ * A base interface that all views shall derive from.
  */
 class AbstractView
 {
 public:
 
     /**
-     *
+     * The source DocumentView of which this is an AbstractView.
      */
     virtual DocumentView *getDocument()
         {
@@ -125,14 +138,16 @@ private:
 
 
 /**
- *
+ * The DocumentView interface is implemented by Document objects in DOM 
+ * implementations supporting DOM Views. It provides an attribute to retrieve the 
+ * default view of a document.
  */
 class DocumentView
 {
 public:
 
     /**
-     *
+     * The default AbstractView for this Document, or null if none available.
      */
     virtual AbstractView *getDefaultView()
         {