added a period at the end of a sentence (test commit, really)

[wxWidgets.git] / samples / docview / doc.h

diff --git a/samples/docview/doc.h b/samples/docview/doc.h
index af9b272fbe131fb410b987bec0fe769e1b914b60..8365009d5cde04a245451558c2d32f72e007dc6f 100644 (file)
--- a/samples/docview/doc.h
+++ b/samples/docview/doc.h
@@ -1,106 +1,194 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        doc.h
+// Name:        samples/docview/doc.h

 // Purpose:     Document classes
 // Author:      Julian Smart
 // Purpose:     Document classes
 // Author:      Julian Smart

-// Modified by:
+// Modified by: Vadim Zeitlin: merge with the MDI version and general cleanup

 // Created:     04/01/98
 // RCS-ID:      $Id$
 // Created:     04/01/98
 // RCS-ID:      $Id$

-// Copyright:   (c) Julian Smart
+// Copyright:   (c) 1998 Julian Smart
+//              (c) 2008 Vadim Zeitlin

 // Licence:     wxWindows license
 /////////////////////////////////////////////////////////////////////////////
 
 // Licence:     wxWindows license
 /////////////////////////////////////////////////////////////////////////////
 

-#ifndef __DOCSAMPLEH__
-#define __DOCSAMPLEH__
+#ifndef _WX_SAMPLES_DOCVIEW_DOC_H_
+#define _WX_SAMPLES_DOCVIEW_DOC_H_

 
 #include "wx/docview.h"
 #include "wx/cmdproc.h"
 
 #include "wx/docview.h"
 #include "wx/cmdproc.h"

-
-// Plots a line from one point to the other
-class DoodleLine: public wxObject
+#include "wx/vector.h"
+
+// This sample is written to build both with wxUSE_STD_IOSTREAM==0 and 1, which
+// somewhat complicates its code but is necessary in order to support building
+// it under all platforms and in all build configurations
+//
+// In your own code you would normally use std::stream classes only and so
+// wouldn't need these typedefs
+#if wxUSE_STD_IOSTREAM
+    typedef wxSTD istream DocumentIstream;
+    typedef wxSTD ostream DocumentOstream;
+#else // !wxUSE_STD_IOSTREAM
+    typedef wxInputStream DocumentIstream;
+    typedef wxOutputStream DocumentOstream;
+#endif // wxUSE_STD_IOSTREAM/!wxUSE_STD_IOSTREAM
+
+// ----------------------------------------------------------------------------
+// The document class and its helpers
+// ----------------------------------------------------------------------------
+
+// Represents a line from one point to the other
+struct DoodleLine

 {
 {

-public:
+    DoodleLine() { /* leave fields uninitialized */ }
+
+    DoodleLine(const wxPoint& pt1, const wxPoint& pt2)
+        : x1(pt1.x), y1(pt1.y), x2(pt2.x), y2(pt2.y)
+    {
+    }
+

     wxInt32 x1;
     wxInt32 y1;
     wxInt32 x2;
     wxInt32 y2;
 };
 
     wxInt32 x1;
     wxInt32 y1;
     wxInt32 x2;
     wxInt32 y2;
 };
 

+typedef wxVector<DoodleLine> DoodleLines;
+

 // Contains a list of lines: represents a mouse-down doodle
 // Contains a list of lines: represents a mouse-down doodle

-class DoodleSegment: public wxObject
+class DoodleSegment

 {
 public:
 {
 public:

-    wxList lines;
+    DocumentOstream& SaveObject(DocumentOstream& stream);
+    DocumentIstream& LoadObject(DocumentIstream& stream);

 
 

-    DoodleSegment(void){};
-    DoodleSegment(const DoodleSegment& seg);
-    ~DoodleSegment(void);
-
-    void Draw(wxDC *dc);
-#if wxUSE_STD_IOSTREAM
-    wxSTD ostream& SaveObject(wxSTD ostream& text_stream);
-    wxSTD istream& LoadObject(wxSTD istream& text_stream);
-#else
-    wxOutputStream& SaveObject(wxOutputStream& stream);
-    wxInputStream& LoadObject(wxInputStream& stream);
-#endif
+    bool IsEmpty() const { return m_lines.empty(); }
+    void AddLine(const wxPoint& pt1, const wxPoint& pt2)
+    {
+        m_lines.push_back(DoodleLine(pt1, pt2));
+    }
+    const DoodleLines& GetLines() const { return m_lines; }

 
 

+private:
+    DoodleLines m_lines;

 };
 
 };
 

-class DrawingDocument: public wxDocument
+typedef wxVector<DoodleSegment> DoodleSegments;
+
+
+// The drawing document (model) class itself
+class DrawingDocument : public wxDocument

 {
 {

-    DECLARE_DYNAMIC_CLASS(DrawingDocument)
-private:

 public:
 public:

-    wxList doodleSegments;
+    DrawingDocument() : wxDocument() { }

 
 

-    DrawingDocument(void){};
-    ~DrawingDocument(void);
+    DocumentOstream& SaveObject(DocumentOstream& stream);
+    DocumentIstream& LoadObject(DocumentIstream& stream);

 
 

-#if wxUSE_STD_IOSTREAM
-    wxSTD ostream& SaveObject(wxSTD ostream& text_stream);
-    wxSTD istream& LoadObject(wxSTD istream& text_stream);
-#else
-    wxOutputStream& SaveObject(wxOutputStream& stream);
-    wxInputStream& LoadObject(wxInputStream& stream);
-#endif
-
-    inline wxList& GetDoodleSegments(void) const { return (wxList&) doodleSegments; };
+    // add a new segment to the document
+    void AddDoodleSegment(const DoodleSegment& segment);
+
+    // remove the last segment, if any, and copy it in the provided pointer if
+    // not NULL and return true or return false and do nothing if there are no
+    // segments
+    bool PopLastSegment(DoodleSegment *segment);
+
+    // get direct access to our segments (for DrawingView)
+    const DoodleSegments& GetSegments() const { return m_doodleSegments; }
+
+private:
+    void DoUpdate();
+
+    DoodleSegments m_doodleSegments;
+
+    DECLARE_DYNAMIC_CLASS(DrawingDocument)

 };
 
 };
 

-#define DOODLE_CUT          1
-#define DOODLE_ADD          2

 
 

-class DrawingCommand: public wxCommand
+// ----------------------------------------------------------------------------
+// Some operations (which can be done and undone by the view) on the document:
+// ----------------------------------------------------------------------------
+
+// Base class for all operations on DrawingDocument
+class DrawingCommand : public wxCommand

 {
 {

+public:
+    DrawingCommand(DrawingDocument *doc,
+                   const wxString& name,
+                   const DoodleSegment& segment = DoodleSegment())
+        : wxCommand(true, name),
+          m_doc(doc),
+          m_segment(segment)
+    {
+    }
+

 protected:
 protected:

-    DoodleSegment *segment;
-    DrawingDocument *doc;
-    int cmd;
+    bool DoAdd() { m_doc->AddDoodleSegment(m_segment); return true; }
+    bool DoRemove() { return m_doc->PopLastSegment(&m_segment); }
+
+private:
+    DrawingDocument * const m_doc;
+    DoodleSegment m_segment;
+};
+
+// The command for adding a new segment
+class DrawingAddSegmentCommand : public DrawingCommand
+{

 public:
 public:

-    DrawingCommand(const wxString& name, int cmd, DrawingDocument *ddoc, DoodleSegment *seg);
-    ~DrawingCommand(void);
+    DrawingAddSegmentCommand(DrawingDocument *doc, const DoodleSegment& segment)
+        : DrawingCommand(doc, "Add new segment", segment)
+    {
+    }

 
 

-    bool Do(void);
-    bool Undo(void);
+    virtual bool Do() { return DoAdd(); }
+    virtual bool Undo() { return DoRemove(); }

 };
 
 };
 

-class TextEditDocument: public wxDocument
+// The command for removing the last segment
+class DrawingRemoveSegmentCommand : public DrawingCommand

 {
 {

-    DECLARE_DYNAMIC_CLASS(TextEditDocument)
-private:

 public:
 public:

-/*
-wxSTD ostream& SaveObject(wxSTD ostream& stream);
-wxSTD istream& LoadObject(wxSTD istream& stream);
-    */
-    virtual bool OnSaveDocument(const wxString& filename);
-    virtual bool OnOpenDocument(const wxString& filename);
-    virtual bool IsModified(void) const;
+    DrawingRemoveSegmentCommand(DrawingDocument *doc)
+        : DrawingCommand(doc, "Remove last segment")
+    {
+    }
+
+    virtual bool Do() { return DoRemove(); }
+    virtual bool Undo() { return DoAdd(); }
+};
+
+
+// ----------------------------------------------------------------------------
+// wxTextDocument: wxDocument and wxTextCtrl married
+// ----------------------------------------------------------------------------
+
+class wxTextDocument : public wxDocument
+{
+public:
+    wxTextDocument() : wxDocument() { }
+    virtual wxTextCtrl* GetTextCtrl() const = 0;
+
+    virtual bool IsModified() const;

     virtual void Modify(bool mod);
 
     virtual void Modify(bool mod);
 

-    TextEditDocument(void) {}
-    ~TextEditDocument(void) {}
+protected:
+    virtual bool DoSaveDocument(const wxString& filename);
+    virtual bool DoOpenDocument(const wxString& filename);
+
+    wxDECLARE_NO_COPY_CLASS(wxTextDocument);
+    DECLARE_CLASS(wxTextDocument)

 };
 
 };
 

+// ----------------------------------------------------------------------------
+// A very simple text document class
+// ----------------------------------------------------------------------------
+
+class TextEditDocument : public wxTextDocument
+{
+public:
+    TextEditDocument() : wxTextDocument() { }
+    virtual wxTextCtrl* GetTextCtrl() const;
+
+    wxDECLARE_NO_COPY_CLASS(TextEditDocument);
+    DECLARE_DYNAMIC_CLASS(TextEditDocument)
+};

 
 

-#endif
+#endif // _WX_SAMPLES_DOCVIEW_DOC_H_