no message

[wxWidgets.git] / user / wxLayout / wxllist.h

diff --git a/user/wxLayout/wxllist.h b/user/wxLayout/wxllist.h
index d7d5d4b4977b0f15f015b6d03a3945fd06467cd5..4916b960b4ed40aadf87554c450580460fd909ee 100644 (file)
--- a/user/wxLayout/wxllist.h
+++ b/user/wxLayout/wxllist.h
@@ -14,13 +14,22 @@
 
 #include   "kbList.h"
 
 
 #include   "kbList.h"
 

-#include   <wx/wx.h>
+#include   "wx/wx.h"
+#include "wx/print.h"
+#include "wx/printdlg.h"
+#include "wx/generic/printps.h"
+#include "wx/generic/prntdlgg.h"

 
 // skip the following defines if embedded in M application
 
 // skip the following defines if embedded in M application

-#ifndef   MCONFIG_H
-// for testing only:
+#ifdef   M_BASEDIR
+#   ifdef   DEBUG
+//#      define   WXLAYOUT_DEBUG
+#   endif
+#else
+    // for testing only:

 #   define WXLAYOUT_DEBUG
 #   define WXLAYOUT_DEBUG

-#   cdefine USE_STD_STRING
+    // The wxLayout classes can be compiled with std::string instead of wxString
+    //#   define USE_STD_STRING

 #endif
 
 #ifdef USE_STD_STRING
 #endif
 
 #ifdef USE_STD_STRING


@@ -32,20 +41,28 @@
 #   define    Str(str) str
 #endif
 
 #   define    Str(str) str
 #endif
 

-enum wxLayoutObjectType { WXLO_TYPE_INVALID, WXLO_TYPE_TEXT, WXLO_TYPE_CMD, WXLO_TYPE_ICON, WXLO_TYPE_LINEBREAK };
+/// Types of currently supported layout objects.
+enum wxLayoutObjectType
+{ WXLO_TYPE_INVALID = 0, WXLO_TYPE_TEXT, WXLO_TYPE_CMD, WXLO_TYPE_ICON, WXLO_TYPE_LINEBREAK };

 
 

+/// Type used for coordinates in drawing.

 typedef long CoordType;
 
 class wxLayoutList;
 class wxLayoutObjectBase;
 
 typedef long CoordType;
 
 class wxLayoutList;
 class wxLayoutObjectBase;
 

-KBLIST_DEFINE(wxLayoutObjectList, wxLayoutObjectBase);
-KBLIST_DEFINE(wxLayoutOLinesList, wxLayoutObjectList::iterator);
-
+class wxDC;
+class wxColour;
+class wxFont;

 
 

+/** The base class defining the interface to each object which can be
+    part of the layout. Each object needs to draw itself and calculate 
+    its size.
+*/

 class wxLayoutObjectBase
 {
 public:
 class wxLayoutObjectBase
 {
 public:

+   /// return the type of this object

    virtual wxLayoutObjectType GetType(void) const { return WXLO_TYPE_INVALID; } ;
    /** Draws an object.
        @param dc the wxDC to draw on
    virtual wxLayoutObjectType GetType(void) const { return WXLO_TYPE_INVALID; } ;
    /** Draws an object.
        @param dc the wxDC to draw on


@@ -56,24 +73,41 @@ public:
    virtual void Draw(wxDC &dc, wxPoint position, CoordType baseLine,
                      bool draw = true) {};
 
    virtual void Draw(wxDC &dc, wxPoint position, CoordType baseLine,
                      bool draw = true) {};
 

+   /** Calculates and returns the size of the object. May need to be
+       called twice to work.
+       @param baseLine pointer where to store the baseline position of 
+       this object (i.e. the height from the top of the box to the
+       baseline)
+       @return the size of the object's box in pixels
+   */

    virtual wxPoint GetSize(CoordType *baseLine) const { return
                                                            wxPoint(0,0); };
    /// returns the number of cursor positions occupied by this object
    virtual CoordType CountPositions(void) const { return 1; }
 
    virtual wxPoint GetSize(CoordType *baseLine) const { return
                                                            wxPoint(0,0); };
    /// returns the number of cursor positions occupied by this object
    virtual CoordType CountPositions(void) const { return 1; }
 

+   /// constructor

    wxLayoutObjectBase() { m_UserData = NULL; }
    wxLayoutObjectBase() { m_UserData = NULL; }

+   /// note: any user data will be freed at the time the object is deleted

    virtual ~wxLayoutObjectBase() { if(m_UserData) delete m_UserData; }
 #ifdef WXLAYOUT_DEBUG
    virtual void Debug(void);
 #endif
 
    virtual ~wxLayoutObjectBase() { if(m_UserData) delete m_UserData; }
 #ifdef WXLAYOUT_DEBUG
    virtual void Debug(void);
 #endif
 

+   /** Tells the object about some user data. This data is associated
+       with the object and will be deleted at destruction time.
+   */

    void   SetUserData(void *data) { m_UserData = data; }
    void   SetUserData(void *data) { m_UserData = data; }

+   /** Return the user data. */

    void * GetUserData(void) const { return m_UserData; }
 private:
    /// optional data for application's use
    void * m_UserData;
 };
 
    void * GetUserData(void) const { return m_UserData; }
 private:
    /// optional data for application's use
    void * m_UserData;
 };
 

+/// Define a list type of wxLayoutObjectBase pointers.
+KBLIST_DEFINE(wxLayoutObjectList, wxLayoutObjectBase);
+
+

 /// object for text block
 class wxLayoutObjectText : public wxLayoutObjectBase
 {
 /// object for text block
 class wxLayoutObjectText : public wxLayoutObjectBase
 {


@@ -113,8 +147,9 @@ public:
                      bool draw = true);
    virtual wxPoint GetSize(CoordType *baseLine) const;
    wxLayoutObjectIcon(wxIcon *icon);
                      bool draw = true);
    virtual wxPoint GetSize(CoordType *baseLine) const;
    wxLayoutObjectIcon(wxIcon *icon);

+

 private:
 private:

-   wxIcon * m_Icon;
+   wxIcon *m_Icon;

 };
 
 /// for export to html:
 };
 
 /// for export to html:


@@ -137,8 +172,10 @@ public:
                 bool underline,
                 wxColour const *fg, wxColour const *bg);
    ~wxLayoutObjectCmd();
                 bool underline,
                 wxColour const *fg, wxColour const *bg);
    ~wxLayoutObjectCmd();

-   // caller must free pointer:
+   /// caller must free pointer:

    wxLayoutStyleInfo *GetStyle(void) const ;
    wxLayoutStyleInfo *GetStyle(void) const ;

+   /// return the background colour for setting colour of window
+   wxColour const *GetBGColour(void) const { return m_ColourBG; }

 private:
    /// the font to use
    wxFont *m_font;
 private:
    /// the font to use
    wxFont *m_font;


@@ -156,6 +193,8 @@ public:
 };
 
 
 };
 
 

+class wxLayoutPrintout;
+

 /**
    This class provides a high level abstraction to the wxFText
    classes.
 /**
    This class provides a high level abstraction to the wxFText
    classes.


@@ -182,27 +221,32 @@ public:
                 wxColour const *bg);
    void SetFont(int family=-1, int size = -1, int style=-1,
                 int weight=-1, int underline = -1,
                 wxColour const *bg);
    void SetFont(int family=-1, int size = -1, int style=-1,
                 int weight=-1, int underline = -1,

-                char const *fg = NULL,
-                char const *bg = NULL);
+                char const *fg = (const char *) NULL,
+                char const *bg = (const char *) NULL);

    inline void SetFontFamily(int family) { SetFont(family); }
    inline void SetFontSize(int size) { SetFont(-1,size); }
    inline void SetFontStyle(int style) { SetFont(-1,-1,style); }
    inline void SetFontWeight(int weight) { SetFont(-1,-1,-1,weight); }
    inline void SetFontUnderline(bool ul) { SetFont(-1,-1,-1,-1,(int)ul); }
    inline void SetFontFamily(int family) { SetFont(family); }
    inline void SetFontSize(int size) { SetFont(-1,size); }
    inline void SetFontStyle(int style) { SetFont(-1,-1,style); }
    inline void SetFontWeight(int weight) { SetFont(-1,-1,-1,weight); }
    inline void SetFontUnderline(bool ul) { SetFont(-1,-1,-1,-1,(int)ul); }

-   inline void SetFontColour(char const *fg, char const *bg = NULL) { SetFont(-1,-1,-1,-1,-1,fg,bg); }
+   inline void SetFontColour(char const *fg, char const *bg = (const char *) NULL) { SetFont(-1,-1,-1,-1,-1,fg,bg); }

       
    
    /** Draw the list on a given DC.
        @param findObject if true, return the object occupying the
        position specified by coords
        @param coords position where to find the object
       
    
    /** Draw the list on a given DC.
        @param findObject if true, return the object occupying the
        position specified by coords
        @param coords position where to find the object

+       @pageNo if > 0, print only that page of a document (for
+       printing)
+       @reallyDraw set this to false if you don't want to draw but just calculate the coordinates

        @return if findObject == true, the object or NULL
    */
    wxLayoutObjectBase *Draw(wxDC &dc, bool findObject = false,
        @return if findObject == true, the object or NULL
    */
    wxLayoutObjectBase *Draw(wxDC &dc, bool findObject = false,

-                       wxPoint const &coords = wxPoint(0,0));
+                            wxPoint const &coords = wxPoint(0,0),
+                            int pageNo = -1, bool reallyDraw = true);

 
 #ifdef WXLAYOUT_DEBUG
    void Debug(void);
 
 #ifdef WXLAYOUT_DEBUG
    void Debug(void);

+   void ShowCurrentObject();

 #endif
 
    
 #endif
 
    


@@ -210,13 +254,17 @@ public:
    void GetSize(CoordType *max_x, CoordType *max_y,
                 CoordType *lineHeight);
 
    void GetSize(CoordType *max_x, CoordType *max_y,
                 CoordType *lineHeight);
 

+   

    /**@name Functionality for editing */
    //@{
    /// set list editable or read only
    /**@name Functionality for editing */
    //@{
    /// set list editable or read only

-   void SetEditable(bool editable = true) { m_Editable = true; }
-   /// move cursor
-   void MoveCursor(int dx = 0, int dy = 0);
+   void SetEditable(bool editable = true) { m_Editable = editable; }
+   /// return true if list is editable
+   bool IsEditable(void) const { return m_Editable; }
+   /// move cursor, returns true if it could move to the desired position
+   bool MoveCursor(int dx = 0, int dy = 0);

    void SetCursor(wxPoint const &p) { m_CursorPosition = p; }
    void SetCursor(wxPoint const &p) { m_CursorPosition = p; }

+   wxPoint GetCursor(void) const { return m_CursorPosition; }

    /// delete one or more cursor positions
    void Delete(CoordType count = 1);
    void Insert(String const &text);
    /// delete one or more cursor positions
    void Delete(CoordType count = 1);
    void Insert(String const &text);


@@ -224,7 +272,17 @@ public:
    void Clear(int family = wxROMAN, int size=12, int style=wxNORMAL, int weight=wxNORMAL,
                     int underline=0, char const *fg="black", char const *bg="white");
 
    void Clear(int family = wxROMAN, int size=12, int style=wxNORMAL, int weight=wxNORMAL,
                     int underline=0, char const *fg="black", char const *bg="white");
 

-   //@}
+   /// return a pointer to the default settings:
+   wxLayoutObjectCmd const *GetDefaults(void) const { return m_DefaultSetting ; }
+
+   wxLayoutObjectList::iterator FindCurrentObject(CoordType *offset = (CoordType *) NULL);
+   // get the length of the line with the object pointed to by i, offs 
+   // only used to decide whether we are before or after linebreak
+   CoordType GetLineLength(wxLayoutObjectList::iterator i,
+                           CoordType offs = 0);
+   wxLayoutPrintout *MakePrintout(wxString const &name);
+
+//@}

 protected:
    /// font parameters:
    int m_FontFamily, m_FontStyle, m_FontWeight;
 protected:
    /// font parameters:
    int m_FontFamily, m_FontStyle, m_FontWeight;


@@ -258,11 +316,23 @@ protected:
    bool      m_Editable;
    /// find the object to the cursor position and returns the offset
    /// in there
    bool      m_Editable;
    /// find the object to the cursor position and returns the offset
    /// in there

-   wxLayoutObjectList::iterator FindObjectCursor(wxPoint const &cpos, CoordType *offset = NULL);
-   wxLayoutObjectList::iterator FindCurrentObject(CoordType *offset = NULL);
-   // get the length of the line with the object pointed to by i
-   CoordType GetLineLength(wxLayoutObjectList::iterator i);
+   wxLayoutObjectList::iterator FindObjectCursor(wxPoint *cpos, CoordType *offset = (CoordType *) NULL);

    
 };
 
    
 };
 

+class wxLayoutPrintout: public wxPrintout
+{
+ public:
+   wxLayoutPrintout(wxLayoutList &llist, wxString const & title = "My printout"):wxPrintout(title)
+      { m_llist = &llist; m_maxPage = 0; }
+  bool OnPrintPage(int page);
+  bool HasPage(int page);
+  bool OnBeginDocument(int startPage, int endPage);
+   void GetPageInfo(int *minPage, int *maxPage, int *selPageFrom, int
+                    *selPageTo);
+private:
+   wxLayoutList *m_llist;
+   int           m_maxPage;
+};
+

 #endif // WXLLIST_H
 #endif // WXLLIST_H