]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/richtext/richtextbuffer.h
Made toolbars sticky, i.e. you need to drag them
[wxWidgets.git] / include / wx / richtext / richtextbuffer.h
index 68e1fefd458d3f7d0ab501d90db80328242b492b..38c3b901c072eb0a59420b8e23babd7a61c85ad7 100644 (file)
@@ -9,6 +9,9 @@
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
+#ifndef _WX_RICHTEXTBUFFER_H_
+#define _WX_RICHTEXTBUFFER_H_
+
 /*
 
   Data structures
 
  */
 
-#ifndef _WX_RICHTEXTBUFFER_H_
-#define _WX_RICHTEXTBUFFER_H_
-
 /*!
  * Includes
  */
 
-#include "wx/list.h"
+#include "wx/defs.h"
 
 #if wxUSE_RICHTEXT
 
+#include "wx/list.h"
+#include "wx/textctrl.h"
+#include "wx/bitmap.h"
 #include "wx/image.h"
 #include "wx/cmdproc.h"
 #include "wx/txtstrm.h"
  * Forward declarations
  */
 
-class WXDLLIMPEXP_ADV wxRichTextCtrl;
-class WXDLLIMPEXP_ADV wxRichTextObject;
-class WXDLLIMPEXP_ADV wxRichTextCacheObject;
-class WXDLLIMPEXP_ADV wxRichTextObjectList;
-class WXDLLIMPEXP_ADV wxRichTextLine;
-class WXDLLIMPEXP_ADV wxRichTextParagraph;
-class WXDLLIMPEXP_ADV wxRichTextFragment;
-class WXDLLIMPEXP_ADV wxRichTextFileHandler;
-class WXDLLIMPEXP_ADV wxRichTextStyleSheet;
-class WXDLLIMPEXP_ADV wxTextAttrEx;
+class WXDLLIMPEXP_RICHTEXT wxRichTextCtrl;
+class WXDLLIMPEXP_RICHTEXT wxRichTextObject;
+class WXDLLIMPEXP_RICHTEXT wxRichTextCacheObject;
+class WXDLLIMPEXP_RICHTEXT wxRichTextObjectList;
+class WXDLLIMPEXP_RICHTEXT wxRichTextLine;
+class WXDLLIMPEXP_RICHTEXT wxRichTextParagraph;
+class WXDLLIMPEXP_RICHTEXT wxRichTextFragment;
+class WXDLLIMPEXP_RICHTEXT wxRichTextFileHandler;
+class WXDLLIMPEXP_RICHTEXT wxRichTextStyleSheet;
+class WXDLLIMPEXP_RICHTEXT wxTextAttrEx;
 
 /*!
  * Flags determining the available space, passed to Layout
@@ -199,7 +202,7 @@ class WXDLLIMPEXP_ADV wxTextAttrEx;
  * This stores beginning and end positions for a range of data.
  */
 
-class WXDLLIMPEXP_ADV wxRichTextRange
+class WXDLLIMPEXP_RICHTEXT wxRichTextRange
 {
 public:
 // Constructors
@@ -255,11 +258,12 @@ protected:
  * wxTextAttrEx is an extended version of wxTextAttr with more paragraph attributes.
  */
 
-class WXDLLIMPEXP_ADV wxTextAttrEx: public wxTextAttr
+class WXDLLIMPEXP_RICHTEXT wxTextAttrEx: public wxTextAttr
 {
 public:
     // ctors
     wxTextAttrEx(const wxTextAttrEx& attr);
+    wxTextAttrEx(const wxTextAttr& attr) { Init(); (*this) = attr; }
     wxTextAttrEx() { Init(); }
 
     // Initialise this object.
@@ -290,6 +294,12 @@ public:
     int GetBulletNumber() const { return m_bulletNumber; }
     wxChar GetBulletSymbol() const { return m_bulletSymbol; }
 
+    bool HasWeight() const { return (GetFlags() & wxTEXT_ATTR_FONT_WEIGHT) != 0; }
+    bool HasSize() const { return (GetFlags() & wxTEXT_ATTR_FONT_SIZE) != 0; }
+    bool HasItalic() const { return (GetFlags() & wxTEXT_ATTR_FONT_ITALIC) != 0; }
+    bool HasUnderlined() const { return (GetFlags() & wxTEXT_ATTR_FONT_UNDERLINE) != 0; }
+    bool HasFaceName() const { return (GetFlags() & wxTEXT_ATTR_FONT_FACE) != 0; }
+
     bool HasParagraphSpacingAfter() const { return HasFlag(wxTEXT_ATTR_PARA_SPACING_AFTER); }
     bool HasParagraphSpacingBefore() const { return HasFlag(wxTEXT_ATTR_PARA_SPACING_BEFORE); }
     bool HasLineSpacing() const { return HasFlag(wxTEXT_ATTR_LINE_SPACING); }
@@ -313,6 +323,14 @@ public:
                !HasParagraphSpacingAfter() && !HasParagraphSpacingBefore() && !HasLineSpacing() &&
                !HasCharacterStyleName() && !HasParagraphStyleName() && !HasBulletNumber() && !HasBulletStyle() && !HasBulletSymbol();
     }
+
+    // return the attribute having the valid font and colours: it uses the
+    // attributes set in attr and falls back first to attrDefault and then to
+    // the text control font/colours for those attributes which are not set
+    static wxTextAttrEx CombineEx(const wxTextAttrEx& attr,
+                              const wxTextAttrEx& attrDef,
+                              const wxTextCtrlBase *text);
+
 private:
     // Paragraph styles
     int                 m_paragraphSpacingAfter;
@@ -334,7 +352,7 @@ private:
  * efficient way to query styles.
  */
 
-class WXDLLIMPEXP_ADV wxRichTextAttr
+class WXDLLIMPEXP_RICHTEXT wxRichTextAttr
 {
 public:
     // ctors
@@ -454,6 +472,12 @@ public:
                !HasCharacterStyleName() && !HasParagraphStyleName() && !HasBulletNumber() && !HasBulletStyle() && !HasBulletSymbol();
     }
 
+    // return the attribute having the valid font and colours: it uses the
+    // attributes set in attr and falls back first to attrDefault and then to
+    // the text control font/colours for those attributes which are not set
+    static wxRichTextAttr Combine(const wxRichTextAttr& attr,
+                              const wxRichTextAttr& attrDef,
+                              const wxTextCtrlBase *text);
 private:
     long                m_flags;
 
@@ -489,20 +513,20 @@ private:
     wxString            m_paragraphStyleName;
 };
 
-#define wxTEXT_ATTR_CHARACTER (wxTEXT_ATTR_FONT) | wxTEXT_ATTR_BACKGROUND_COLOUR | wxTEXT_ATTR_TEXT_COLOUR
+#define wxTEXT_ATTR_CHARACTER (wxTEXT_ATTR_FONT | wxTEXT_ATTR_BACKGROUND_COLOUR | wxTEXT_ATTR_TEXT_COLOUR)
 
-#define wxTEXT_ATTR_PARAGRAPH  wxTEXT_ATTR_ALIGNMENT|wxTEXT_ATTR_LEFT_INDENT|wxTEXT_ATTR_RIGHT_INDENT|wxTEXT_ATTR_TABS|\
+#define wxTEXT_ATTR_PARAGRAPH (wxTEXT_ATTR_ALIGNMENT|wxTEXT_ATTR_LEFT_INDENT|wxTEXT_ATTR_RIGHT_INDENT|wxTEXT_ATTR_TABS|\
     wxTEXT_ATTR_PARA_SPACING_BEFORE|wxTEXT_ATTR_PARA_SPACING_AFTER|wxTEXT_ATTR_LINE_SPACING|\
-    wxTEXT_ATTR_BULLET_STYLE|wxTEXT_ATTR_BULLET_NUMBER|wxTEXT_ATTR_BULLET_SYMBOL
+    wxTEXT_ATTR_BULLET_STYLE|wxTEXT_ATTR_BULLET_NUMBER|wxTEXT_ATTR_BULLET_SYMBOL)
 
-#define wxTEXT_ATTR_ALL wxTEXT_ATTR_CHARACTER|wxTEXT_ATTR_PARAGRAPH
+#define wxTEXT_ATTR_ALL (wxTEXT_ATTR_CHARACTER|wxTEXT_ATTR_PARAGRAPH)
 
 /*!
  * wxRichTextObject class declaration
  * This is the base for drawable objects.
  */
 
-class WXDLLIMPEXP_ADV wxRichTextObject: public wxObject
+class WXDLLIMPEXP_RICHTEXT wxRichTextObject: public wxObject
 {
     DECLARE_CLASS(wxRichTextObject)
 public:
@@ -535,7 +559,7 @@ public:
 
     /// Get the object size for the given range. Returns false if the range
     /// is invalid for this object.
-    virtual bool GetRangeSize(const wxRichTextRange& range, wxSize& size, int& descent, wxDC& dc, int flags) const  = 0;
+    virtual bool GetRangeSize(const wxRichTextRange& range, wxSize& size, int& descent, wxDC& dc, int flags, wxPoint position = wxPoint(0,0)) const  = 0;
 
     /// Do a split, returning an object containing the second part, and setting
     /// the first part in 'this'.
@@ -648,14 +672,14 @@ protected:
     wxTextAttrEx            m_attributes;
 };
 
-WX_DECLARE_EXPORTED_LIST( wxRichTextObject, wxRichTextObjectList );
+WX_DECLARE_LIST_WITH_DECL( wxRichTextObject, wxRichTextObjectList, class WXDLLIMPEXP_RICHTEXT );
 
 /*!
  * wxRichTextCompositeObject class declaration
  * Objects of this class can contain other objects.
  */
 
-class WXDLLIMPEXP_ADV wxRichTextCompositeObject: public wxRichTextObject
+class WXDLLIMPEXP_RICHTEXT wxRichTextCompositeObject: public wxRichTextObject
 {
     DECLARE_CLASS(wxRichTextCompositeObject)
 public:
@@ -736,7 +760,7 @@ protected:
  * This defines a 2D space to lay out objects
  */
 
-class WXDLLIMPEXP_ADV wxRichTextBox: public wxRichTextCompositeObject
+class WXDLLIMPEXP_RICHTEXT wxRichTextBox: public wxRichTextCompositeObject
 {
     DECLARE_DYNAMIC_CLASS(wxRichTextBox)
 public:
@@ -755,7 +779,7 @@ public:
 
     /// Get/set the object size for the given range. Returns false if the range
     /// is invalid for this object.
-    virtual bool GetRangeSize(const wxRichTextRange& range, wxSize& size, int& descent, wxDC& dc, int flags) const;
+    virtual bool GetRangeSize(const wxRichTextRange& range, wxSize& size, int& descent, wxDC& dc, int flags, wxPoint position = wxPoint(0,0)) const;
 
 // Accessors
 
@@ -775,7 +799,7 @@ protected:
  * This box knows how to lay out paragraphs.
  */
 
-class WXDLLIMPEXP_ADV wxRichTextParagraphLayoutBox: public wxRichTextBox
+class WXDLLIMPEXP_RICHTEXT wxRichTextParagraphLayoutBox: public wxRichTextBox
 {
     DECLARE_DYNAMIC_CLASS(wxRichTextParagraphLayoutBox)
 public:
@@ -794,7 +818,7 @@ public:
 
     /// Get/set the object size for the given range. Returns false if the range
     /// is invalid for this object.
-    virtual bool GetRangeSize(const wxRichTextRange& range, wxSize& size, int& descent, wxDC& dc, int flags) const;
+    virtual bool GetRangeSize(const wxRichTextRange& range, wxSize& size, int& descent, wxDC& dc, int flags, wxPoint position = wxPoint(0,0)) const;
 
     /// Delete range
     virtual bool DeleteRange(const wxRichTextRange& range);
@@ -957,7 +981,7 @@ protected:
  * paragraphs for Undo/Redo, for example.
  */
 
-class WXDLLIMPEXP_ADV wxRichTextFragment: public wxRichTextParagraphLayoutBox
+class WXDLLIMPEXP_RICHTEXT wxRichTextFragment: public wxRichTextParagraphLayoutBox
 {
     DECLARE_DYNAMIC_CLASS(wxRichTextFragment)
 public:
@@ -998,7 +1022,7 @@ protected:
  * start and end positions of the line.
  */
 
-class WXDLLIMPEXP_ADV wxRichTextLine
+class WXDLLIMPEXP_RICHTEXT wxRichTextLine
 {
 public:
 // Constructors
@@ -1071,14 +1095,14 @@ protected:
     wxRichTextParagraph* m_parent;
 };
 
-WX_DECLARE_EXPORTED_LIST( wxRichTextLine, wxRichTextLineList );
+WX_DECLARE_LIST_WITH_DECL( wxRichTextLine, wxRichTextLineList , class WXDLLIMPEXP_RICHTEXT );
 
 /*!
  * wxRichTextParagraph class declaration
  * This object represents a single paragraph (or in a straight text editor, a line).
  */
 
-class WXDLLIMPEXP_ADV wxRichTextParagraph: public wxRichTextBox
+class WXDLLIMPEXP_RICHTEXT wxRichTextParagraph: public wxRichTextBox
 {
     DECLARE_DYNAMIC_CLASS(wxRichTextParagraph)
 public:
@@ -1099,7 +1123,7 @@ public:
 
     /// Get/set the object size for the given range. Returns false if the range
     /// is invalid for this object.
-    virtual bool GetRangeSize(const wxRichTextRange& range, wxSize& size, int& descent, wxDC& dc, int flags) const;
+    virtual bool GetRangeSize(const wxRichTextRange& range, wxSize& size, int& descent, wxDC& dc, int flags, wxPoint position = wxPoint(0,0)) const;
 
     /// Finds the absolute position and row height for the given character position
     virtual bool FindPosition(wxDC& dc, long index, wxPoint& pt, int* height, bool forceLineStart);
@@ -1175,7 +1199,7 @@ protected:
  * This object represents a single piece of text.
  */
 
-class WXDLLIMPEXP_ADV wxRichTextPlainText: public wxRichTextObject
+class WXDLLIMPEXP_RICHTEXT wxRichTextPlainText: public wxRichTextObject
 {
     DECLARE_DYNAMIC_CLASS(wxRichTextPlainText)
 public:
@@ -1194,7 +1218,7 @@ public:
 
     /// Get/set the object size for the given range. Returns false if the range
     /// is invalid for this object.
-    virtual bool GetRangeSize(const wxRichTextRange& range, wxSize& size, int& descent, wxDC& dc, int flags) const;
+    virtual bool GetRangeSize(const wxRichTextRange& range, wxSize& size, int& descent, wxDC& dc, int flags, wxPoint position/* = wxPoint(0,0)*/) const;
 
     /// Get any text in this object for the given range
     virtual wxString GetTextForRange(const wxRichTextRange& range) const;
@@ -1237,6 +1261,8 @@ public:
 
     /// Clone
     virtual wxRichTextObject* Clone() const { return new wxRichTextPlainText(*this); }
+private:
+    bool DrawTabbedString(wxDC& dc,const wxRect& rect,wxString& str, wxCoord& x, wxCoord& y, bool selected);
 
 protected:
     wxString    m_text;
@@ -1249,7 +1275,7 @@ protected:
 class WXDLLIMPEXP_BASE wxDataInputStream;
 class WXDLLIMPEXP_BASE wxDataOutputStream;
 
-class WXDLLIMPEXP_ADV wxRichTextImageBlock: public wxObject
+class WXDLLIMPEXP_RICHTEXT wxRichTextImageBlock: public wxObject
 {
 public:
     wxRichTextImageBlock();
@@ -1326,7 +1352,7 @@ protected:
  * This object represents an image.
  */
 
-class WXDLLIMPEXP_ADV wxRichTextImage: public wxRichTextObject
+class WXDLLIMPEXP_RICHTEXT wxRichTextImage: public wxRichTextObject
 {
     DECLARE_DYNAMIC_CLASS(wxRichTextImage)
 public:
@@ -1347,7 +1373,7 @@ public:
 
     /// Get the object size for the given range. Returns false if the range
     /// is invalid for this object.
-    virtual bool GetRangeSize(const wxRichTextRange& range, wxSize& size, int& descent, wxDC& dc, int flags) const;
+    virtual bool GetRangeSize(const wxRichTextRange& range, wxSize& size, int& descent, wxDC& dc, int flags, wxPoint position = wxPoint(0,0)) const;
 
     /// Returns true if the object is empty
     virtual bool IsEmpty() const { return !m_image.Ok(); }
@@ -1390,10 +1416,10 @@ protected:
  * This is a kind of box, used to represent the whole buffer
  */
 
-class WXDLLIMPEXP_ADV wxRichTextCommand;
-class WXDLLIMPEXP_ADV wxRichTextAction;
+class WXDLLIMPEXP_RICHTEXT wxRichTextCommand;
+class WXDLLIMPEXP_RICHTEXT wxRichTextAction;
 
-class WXDLLIMPEXP_ADV wxRichTextBuffer: public wxRichTextParagraphLayoutBox
+class WXDLLIMPEXP_RICHTEXT wxRichTextBuffer: public wxRichTextParagraphLayoutBox
 {
     DECLARE_DYNAMIC_CLASS(wxRichTextBuffer)
 public:
@@ -1489,7 +1515,7 @@ public:
     virtual void ClearStyleStack();
 
     /// Get the size of the style stack, for example to check correct nesting
-    virtual int GetStyleStackSize() const { return m_attributeStack.GetCount(); }
+    virtual size_t GetStyleStackSize() const { return m_attributeStack.GetCount(); }
 
     /// Begin using bold
     bool BeginBold();
@@ -1691,8 +1717,8 @@ enum wxRichTextCommandId
  *
  */
 
-class WXDLLIMPEXP_ADV wxRichTextAction;
-class WXDLLIMPEXP_ADV wxRichTextCommand: public wxCommand
+class WXDLLIMPEXP_RICHTEXT wxRichTextAction;
+class WXDLLIMPEXP_RICHTEXT wxRichTextCommand: public wxCommand
 {
 public:
     // Ctor for one action
@@ -1722,7 +1748,7 @@ protected:
  * There can be more than one action in a command.
  */
 
-class WXDLLIMPEXP_ADV wxRichTextAction: public wxObject
+class WXDLLIMPEXP_RICHTEXT wxRichTextAction: public wxObject
 {
 public:
     wxRichTextAction(wxRichTextCommand* cmd, const wxString& name, wxRichTextCommandId id, wxRichTextBuffer* buffer,
@@ -1788,7 +1814,7 @@ protected:
  * Base class for file handlers
  */
 
-class WXDLLIMPEXP_ADV wxRichTextFileHandler: public wxObject
+class WXDLLIMPEXP_RICHTEXT wxRichTextFileHandler: public wxObject
 {
     DECLARE_CLASS(wxRichTextFileHandler)
 public:
@@ -1819,15 +1845,22 @@ public:
     virtual bool IsVisible() const { return m_visible; }
     virtual void SetVisible(bool visible) { m_visible = visible; }
 
+    /// The name of the nandler
     void SetName(const wxString& name) { m_name = name; }
     wxString GetName() const { return m_name; }
 
+    /// The default extension to recognise
     void SetExtension(const wxString& ext) { m_extension = ext; }
     wxString GetExtension() const { return m_extension; }
 
+    /// The handler type
     void SetType(int type) { m_type = type; }
     int GetType() const { return m_type; }
 
+    /// Encoding to use when saving a file. If empty, a suitable encoding is chosen
+    void SetEncoding(const wxString& encoding) { m_encoding = encoding; }
+    const wxString& GetEncoding() const { return m_encoding; }
+
 protected:
 
 #if wxUSE_STREAMS
@@ -1836,6 +1869,7 @@ protected:
 #endif
 
     wxString  m_name;
+    wxString  m_encoding;
     wxString  m_extension;
     int       m_type;
     bool      m_visible;
@@ -1846,7 +1880,7 @@ protected:
  * Plain text handler
  */
 
-class WXDLLIMPEXP_ADV wxRichTextPlainTextHandler: public wxRichTextFileHandler
+class WXDLLIMPEXP_RICHTEXT wxRichTextPlainTextHandler: public wxRichTextFileHandler
 {
     DECLARE_CLASS(wxRichTextPlainTextHandler)
 public: