]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/richtext/richtextstyles.h
Added wxPGChoices::Copy(), tweaked related documentation
[wxWidgets.git] / include / wx / richtext / richtextstyles.h
index 997d3e97445963a4ddf2aca0cef759f2c7794ec1..fb5557b6fde6f2fbc97e12acd568a182073d7f45 100644 (file)
@@ -1,10 +1,10 @@
 /////////////////////////////////////////////////////////////////////////////
-// Name:        richtextstyles.h
+// Name:        wx/richtext/richtextstyles.h
 // Purpose:     Style management for wxRichTextCtrl
 // Author:      Julian Smart
 // Modified by:
 // Created:     2005-09-30
-// RCS-ID:
+// RCS-ID:      $Id$
 // Copyright:   (c) Julian Smart
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
  * Includes
  */
 
-#include "wx/richtext/richtextbuffer.h"
+#include "wx/defs.h"
 
 #if wxUSE_RICHTEXT
 
+#include "wx/richtext/richtextbuffer.h"
+
 #if wxUSE_HTML
 #include "wx/htmllbox.h"
 #endif
 #include "wx/combo.h"
 #endif
 
+#include "wx/choice.h"
+
 /*!
  * Forward declarations
  */
 
-class WXDLLIMPEXP_RICHTEXT wxRichTextCtrl;
-class WXDLLIMPEXP_RICHTEXT wxRichTextBuffer;
+class WXDLLIMPEXP_FWD_RICHTEXT wxRichTextCtrl;
+class WXDLLIMPEXP_FWD_RICHTEXT wxRichTextBuffer;
 
 /*!
  * wxRichTextStyleDefinition class declaration
@@ -45,30 +49,63 @@ class WXDLLIMPEXP_RICHTEXT wxRichTextStyleDefinition: public wxObject
     DECLARE_CLASS(wxRichTextStyleDefinition)
 public:
 
-// Constructors
+    /// Copy constructors
+    wxRichTextStyleDefinition(const wxRichTextStyleDefinition& def)
+    : wxObject()
+    {
+        Init();
+        Copy(def);
+    }
 
+    /// Default constructor
     wxRichTextStyleDefinition(const wxString& name = wxEmptyString) { Init(); m_name = name; }
+
+    /// Destructor
     virtual ~wxRichTextStyleDefinition() {}
 
+    /// Initialises members
     void Init() {}
 
-    /// The name of the style.
+    /// Copies from def
+    void Copy(const wxRichTextStyleDefinition& def);
+
+    /// Equality test
+    bool Eq(const wxRichTextStyleDefinition& def) const;
+
+    /// Assignment operator
+    void operator =(const wxRichTextStyleDefinition& def) { Copy(def); }
+
+    /// Equality operator
+    bool operator ==(const wxRichTextStyleDefinition& def) const { return Eq(def); }
+
+    /// Override to clone the object
+    virtual wxRichTextStyleDefinition* Clone() const = 0;
+
+    /// Sets and gets the name of the style
     void SetName(const wxString& name) { m_name = name; }
     const wxString& GetName() const { return m_name; }
 
-    /// The name of the style that this style is based on.
+    /// Sets and gets the style description
+    void SetDescription(const wxString& descr) { m_description = descr; }
+    const wxString& GetDescription() const { return m_description; }
+
+    /// Sets and gets the name of the style that this style is based on
     void SetBaseStyle(const wxString& name) { m_baseStyle = name; }
     const wxString& GetBaseStyle() const { return m_baseStyle; }
 
-    /// The style.
-    void SetStyle(const wxRichTextAttr& style) { m_style = style; }
-    const wxRichTextAttr& GetStyle() const { return m_style; }
-    wxRichTextAttr& GetStyle() { return m_style; }
+    /// Sets and gets the style
+    void SetStyle(const wxTextAttr& style) { m_style = style; }
+    const wxTextAttr& GetStyle() const { return m_style; }
+    wxTextAttr& GetStyle() { return m_style; }
+
+    /// Gets the style combined with the base style
+    virtual wxTextAttr GetStyleMergedWithBase(const wxRichTextStyleSheet* sheet) const;
 
 protected:
     wxString        m_name;
     wxString        m_baseStyle;
-    wxRichTextAttr  m_style;
+    wxString        m_description;
+    wxTextAttr  m_style;
 };
 
 /*!
@@ -80,12 +117,19 @@ class WXDLLIMPEXP_RICHTEXT wxRichTextCharacterStyleDefinition: public wxRichText
     DECLARE_DYNAMIC_CLASS(wxRichTextCharacterStyleDefinition)
 public:
 
-// Constructors
+    /// Copy constructor
+    wxRichTextCharacterStyleDefinition(const wxRichTextCharacterStyleDefinition& def): wxRichTextStyleDefinition(def) {}
 
+    /// Default constructor
     wxRichTextCharacterStyleDefinition(const wxString& name = wxEmptyString):
         wxRichTextStyleDefinition(name) {}
+
+    /// Destructor
     virtual ~wxRichTextCharacterStyleDefinition() {}
 
+    /// Clones the object
+    virtual wxRichTextStyleDefinition* Clone() const { return new wxRichTextCharacterStyleDefinition(*this); }
+
 protected:
 };
 
@@ -98,22 +142,104 @@ class WXDLLIMPEXP_RICHTEXT wxRichTextParagraphStyleDefinition: public wxRichText
     DECLARE_DYNAMIC_CLASS(wxRichTextParagraphStyleDefinition)
 public:
 
-// Constructors
+    /// Copy constructor
+    wxRichTextParagraphStyleDefinition(const wxRichTextParagraphStyleDefinition& def): wxRichTextStyleDefinition(def) { m_nextStyle = def.m_nextStyle; }
 
+    /// Default constructor
     wxRichTextParagraphStyleDefinition(const wxString& name = wxEmptyString):
         wxRichTextStyleDefinition(name) {}
+
+    // Destructor
     virtual ~wxRichTextParagraphStyleDefinition() {}
 
-    /// The next style.
+    /// Sets and gets the next style
     void SetNextStyle(const wxString& name) { m_nextStyle = name; }
     const wxString& GetNextStyle() const { return m_nextStyle; }
 
+    /// Copies from def
+    void Copy(const wxRichTextParagraphStyleDefinition& def);
+
+    /// Assignment operator
+    void operator =(const wxRichTextParagraphStyleDefinition& def) { Copy(def); }
+
+    /// Equality operator
+    bool operator ==(const wxRichTextParagraphStyleDefinition& def) const;
+
+    /// Clones the object
+    virtual wxRichTextStyleDefinition* Clone() const { return new wxRichTextParagraphStyleDefinition(*this); }
+
 protected:
 
     /// The next style to use when adding a paragraph after this style.
     wxString    m_nextStyle;
 };
 
+/*!
+ * wxRichTextListStyleDefinition class declaration
+ */
+
+class WXDLLIMPEXP_RICHTEXT wxRichTextListStyleDefinition: public wxRichTextParagraphStyleDefinition
+{
+    DECLARE_DYNAMIC_CLASS(wxRichTextListStyleDefinition)
+public:
+
+    /// Copy constructor
+    wxRichTextListStyleDefinition(const wxRichTextListStyleDefinition& def): wxRichTextParagraphStyleDefinition(def) { Init(); Copy(def); }
+
+    /// Default constructor
+    wxRichTextListStyleDefinition(const wxString& name = wxEmptyString):
+        wxRichTextParagraphStyleDefinition(name) { Init(); }
+
+    /// Destructor
+    virtual ~wxRichTextListStyleDefinition() {}
+
+    /// Copies from def
+    void Copy(const wxRichTextListStyleDefinition& def);
+
+    /// Assignment operator
+    void operator =(const wxRichTextListStyleDefinition& def) { Copy(def); }
+
+    /// Equality operator
+    bool operator ==(const wxRichTextListStyleDefinition& def) const;
+
+    /// Clones the object
+    virtual wxRichTextStyleDefinition* Clone() const { return new wxRichTextListStyleDefinition(*this); }
+
+    /// Sets/gets the attributes for the given level
+    void SetLevelAttributes(int i, const wxTextAttr& attr);
+    wxTextAttr* GetLevelAttributes(int i);
+    const wxTextAttr* GetLevelAttributes(int i) const;
+
+    /// Convenience function for setting the major attributes for a list level specification
+    void SetAttributes(int i, int leftIndent, int leftSubIndent, int bulletStyle, const wxString& bulletSymbol = wxEmptyString);
+
+    /// Finds the level corresponding to the given indentation
+    int FindLevelForIndent(int indent) const;
+
+    /// Combine the base and list style with a paragraph style, using the given indent (from which
+    /// an appropriate level is found)
+    wxTextAttr CombineWithParagraphStyle(int indent, const wxTextAttr& paraStyle, wxRichTextStyleSheet* styleSheet = NULL);
+
+    /// Combine the base and list style, using the given indent (from which
+    /// an appropriate level is found)
+    wxTextAttr GetCombinedStyle(int indent, wxRichTextStyleSheet* styleSheet = NULL);
+
+    /// Combine the base and list style, using the given level from which
+    /// an appropriate level is found)
+    wxTextAttr GetCombinedStyleForLevel(int level, wxRichTextStyleSheet* styleSheet = NULL);
+
+    /// Gets the number of available levels
+    int GetLevelCount() const { return 10; }
+
+    /// Is this a numbered list?
+    bool IsNumbered(int i) const;
+
+protected:
+
+    /// The styles for each level (up to 10)
+    wxTextAttr m_levelStyles[10];
+};
+
 /*!
  * The style sheet
  */
@@ -124,45 +250,109 @@ class WXDLLIMPEXP_RICHTEXT wxRichTextStyleSheet: public wxObject
 
 public:
     /// Constructors
+    wxRichTextStyleSheet(const wxRichTextStyleSheet& sheet)
+    : wxObject()
+    {
+        Init();
+        Copy(sheet);
+    }
     wxRichTextStyleSheet() { Init(); }
-    virtual ~wxRichTextStyleSheet() { DeleteStyles(); }
+    virtual ~wxRichTextStyleSheet();
 
     /// Initialisation
     void Init();
 
+    /// Copy
+    void Copy(const wxRichTextStyleSheet& sheet);
+
+    /// Assignment
+    void operator=(const wxRichTextStyleSheet& sheet) { Copy(sheet); }
+
+    /// Equality
+    bool operator==(const wxRichTextStyleSheet& sheet) const;
+
     /// Add a definition to the character style list
-    bool AddCharacterStyle(wxRichTextCharacterStyleDefinition* def) { return AddStyle(m_characterStyleDefinitions, def); }
+    bool AddCharacterStyle(wxRichTextCharacterStyleDefinition* def);
 
     /// Add a definition to the paragraph style list
-    bool AddParagraphStyle(wxRichTextParagraphStyleDefinition* def) { return AddStyle(m_paragraphStyleDefinitions, def); }
+    bool AddParagraphStyle(wxRichTextParagraphStyleDefinition* def);
+
+    /// Add a definition to the list style list
+    bool AddListStyle(wxRichTextListStyleDefinition* def);
+
+    /// Add a definition to the appropriate style list
+    bool AddStyle(wxRichTextStyleDefinition* def);
 
     /// Remove a character style
     bool RemoveCharacterStyle(wxRichTextStyleDefinition* def, bool deleteStyle = false) { return RemoveStyle(m_characterStyleDefinitions, def, deleteStyle); }
 
     /// Remove a paragraph style
-    bool RemoveParagraphStyle(wxRichTextStyleDefinition* def, bool deleteStyle = false) { return RemoveStyle(m_characterStyleDefinitions, def, deleteStyle); }
+    bool RemoveParagraphStyle(wxRichTextStyleDefinition* def, bool deleteStyle = false) { return RemoveStyle(m_paragraphStyleDefinitions, def, deleteStyle); }
+
+    /// Remove a list style
+    bool RemoveListStyle(wxRichTextStyleDefinition* def, bool deleteStyle = false) { return RemoveStyle(m_listStyleDefinitions, def, deleteStyle); }
+
+    /// Remove a style
+    bool RemoveStyle(wxRichTextStyleDefinition* def, bool deleteStyle = false);
 
     /// Find a character definition by name
-    wxRichTextCharacterStyleDefinition* FindCharacterStyle(const wxString& name) const { return (wxRichTextCharacterStyleDefinition*) FindStyle(m_characterStyleDefinitions, name); }
+    wxRichTextCharacterStyleDefinition* FindCharacterStyle(const wxString& name, bool recurse = true) const { return (wxRichTextCharacterStyleDefinition*) FindStyle(m_characterStyleDefinitions, name, recurse); }
 
     /// Find a paragraph definition by name
-    wxRichTextParagraphStyleDefinition* FindParagraphStyle(const wxString& name) const { return (wxRichTextParagraphStyleDefinition*) FindStyle(m_characterStyleDefinitions, name); }
+    wxRichTextParagraphStyleDefinition* FindParagraphStyle(const wxString& name, bool recurse = true) const { return (wxRichTextParagraphStyleDefinition*) FindStyle(m_paragraphStyleDefinitions, name, recurse); }
+
+    /// Find a list definition by name
+    wxRichTextListStyleDefinition* FindListStyle(const wxString& name, bool recurse = true) const { return (wxRichTextListStyleDefinition*) FindStyle(m_listStyleDefinitions, name, recurse); }
+
+    /// Find any definition by name
+    wxRichTextStyleDefinition* FindStyle(const wxString& name, bool recurse = true) const;
 
-    /// Return the number of character styes.
+    /// Return the number of character styles
     size_t GetCharacterStyleCount() const { return m_characterStyleDefinitions.GetCount(); }
 
-    /// Return the number of paragraph styes.
+    /// Return the number of paragraph styles
     size_t GetParagraphStyleCount() const { return m_paragraphStyleDefinitions.GetCount(); }
 
+    /// Return the number of list styles
+    size_t GetListStyleCount() const { return m_listStyleDefinitions.GetCount(); }
+
     /// Return the nth character style
     wxRichTextCharacterStyleDefinition* GetCharacterStyle(size_t n) const { return (wxRichTextCharacterStyleDefinition*) m_characterStyleDefinitions.Item(n)->GetData(); }
 
     /// Return the nth paragraph style
     wxRichTextParagraphStyleDefinition* GetParagraphStyle(size_t n) const { return (wxRichTextParagraphStyleDefinition*) m_paragraphStyleDefinitions.Item(n)->GetData(); }
 
+    /// Return the nth list style
+    wxRichTextListStyleDefinition* GetListStyle(size_t n) const { return (wxRichTextListStyleDefinition*) m_listStyleDefinitions.Item(n)->GetData(); }
+
     /// Delete all styles
     void DeleteStyles();
 
+    /// Insert into list of style sheets
+    bool InsertSheet(wxRichTextStyleSheet* before);
+
+    /// Append to list of style sheets
+    bool AppendSheet(wxRichTextStyleSheet* after);
+
+    /// Unlink from the list of style sheets
+    void Unlink();
+
+    /// Get/set next sheet
+    wxRichTextStyleSheet* GetNextSheet() const { return m_nextSheet; }
+    void SetNextSheet(wxRichTextStyleSheet* sheet) { m_nextSheet = sheet; }
+
+    /// Get/set previous sheet
+    wxRichTextStyleSheet* GetPreviousSheet() const { return m_previousSheet; }
+    void SetPreviousSheet(wxRichTextStyleSheet* sheet) { m_previousSheet = sheet; }
+
+    /// Sets and gets the name of the style sheet
+    void SetName(const wxString& name) { m_name = name; }
+    const wxString& GetName() const { return m_name; }
+
+    /// Sets and gets the style description
+    void SetDescription(const wxString& descr) { m_description = descr; }
+    const wxString& GetDescription() const { return m_description; }
+
 /// Implementation
 
     /// Add a definition to one of the style lists
@@ -172,12 +362,19 @@ public:
     bool RemoveStyle(wxList& list, wxRichTextStyleDefinition* def, bool deleteStyle);
 
     /// Find a definition by name
-    wxRichTextStyleDefinition* FindStyle(const wxList& list, const wxString& name) const;
+    wxRichTextStyleDefinition* FindStyle(const wxList& list, const wxString& name, bool recurse = true) const;
 
 protected:
 
-    wxList  m_characterStyleDefinitions;
-    wxList  m_paragraphStyleDefinitions;
+    wxString                m_description;
+    wxString                m_name;
+
+    wxList                  m_characterStyleDefinitions;
+    wxList                  m_paragraphStyleDefinitions;
+    wxList                  m_listStyleDefinitions;
+
+    wxRichTextStyleSheet*   m_previousSheet;
+    wxRichTextStyleSheet*   m_nextSheet;
 };
 
 #if wxUSE_HTML
@@ -192,6 +389,15 @@ class WXDLLIMPEXP_RICHTEXT wxRichTextStyleListBox: public wxHtmlListBox
     DECLARE_EVENT_TABLE()
 
 public:
+    /// Which type of style definition is currently showing?
+    enum wxRichTextStyleType
+    {
+        wxRICHTEXT_STYLE_ALL,
+        wxRICHTEXT_STYLE_PARAGRAPH,
+        wxRICHTEXT_STYLE_CHARACTER,
+        wxRICHTEXT_STYLE_LIST
+    };
+
     wxRichTextStyleListBox()
     {
         Init();
@@ -204,6 +410,9 @@ public:
     {
         m_styleSheet = NULL;
         m_richTextCtrl = NULL;
+        m_applyOnSelection = false;
+        m_styleType = wxRICHTEXT_STYLE_PARAGRAPH;
+        m_autoSetSelection = true;
     }
 
     bool Create(wxWindow* parent, wxWindowID id = wxID_ANY, const wxPoint& pos = wxDefaultPosition,
@@ -212,7 +421,7 @@ public:
     /// Creates a suitable HTML fragment for a definition
     wxString CreateHTML(wxRichTextStyleDefinition* def) const;
 
-    /// Associates the control with a style manager
+    /// Associates the control with a style sheet
     void SetStyleSheet(wxRichTextStyleSheet* styleSheet) { m_styleSheet = styleSheet; }
     wxRichTextStyleSheet* GetStyleSheet() const { return m_styleSheet; }
 
@@ -232,29 +441,36 @@ public:
     /// Updates the list
     void UpdateStyles();
 
-    /// Do selection
-    void DoSelection(int i);
-
-    /// React to selection
-    void OnSelect(wxCommandEvent& event);
+    /// Apply the style
+    void ApplyStyle(int i);
 
     /// Left click
     void OnLeftDown(wxMouseEvent& event);
 
+    /// Left double-click
+    void OnLeftDoubleClick(wxMouseEvent& event);
+
     /// Auto-select from style under caret in idle time
     void OnIdle(wxIdleEvent& event);
 
-#if 0
-    virtual wxColour GetSelectedTextColour(const wxColour& colFg) const;
-    virtual wxColour GetSelectedTextBgColour(const wxColour& colBg) const;
-#endif
-
     /// Convert units in tends of a millimetre to device units
     int ConvertTenthsMMToPixels(wxDC& dc, int units) const;
 
     /// Can we set the selection based on the editor caret position?
     /// Need to override this if being used in a combobox popup
-    virtual bool CanAutoSetSelection() { return true; }
+    virtual bool CanAutoSetSelection() { return m_autoSetSelection; }
+    virtual void SetAutoSetSelection(bool autoSet) { m_autoSetSelection = autoSet; }
+
+    /// Set whether the style should be applied as soon as the item is selected (the default)
+    void SetApplyOnSelection(bool applyOnSel) { m_applyOnSelection = applyOnSel; }
+    bool GetApplyOnSelection() const { return m_applyOnSelection; }
+
+    /// Set the style type to display
+    void SetStyleType(wxRichTextStyleType styleType) { m_styleType = styleType; UpdateStyles(); }
+    wxRichTextStyleType GetStyleType() const { return m_styleType; }
+
+    /// Helper for listbox and combo control
+    static wxString GetStyleToShowInIdleTime(wxRichTextCtrl* ctrl, wxRichTextStyleType styleType);
 
 protected:
     /// Returns the HTML for this item
@@ -264,6 +480,89 @@ private:
 
     wxRichTextStyleSheet*   m_styleSheet;
     wxRichTextCtrl*         m_richTextCtrl;
+    bool                    m_applyOnSelection; // if true, applies style on selection
+    wxRichTextStyleType     m_styleType; // style type to display
+    bool                    m_autoSetSelection;
+    wxArrayString           m_styleNames;
+};
+
+/*!
+ * wxRichTextStyleListCtrl class declaration
+ * This is a container for the list control plus a combobox to switch between
+ * style types.
+ */
+
+#define wxRICHTEXTSTYLELIST_HIDE_TYPE_SELECTOR     0x1000
+
+class WXDLLIMPEXP_RICHTEXT wxRichTextStyleListCtrl: public wxControl
+{
+    DECLARE_CLASS(wxRichTextStyleListCtrl)
+    DECLARE_EVENT_TABLE()
+
+public:
+
+    /// Constructors
+    wxRichTextStyleListCtrl()
+    {
+        Init();
+    }
+
+    wxRichTextStyleListCtrl(wxWindow* parent, wxWindowID id = wxID_ANY, const wxPoint& pos = wxDefaultPosition,
+        const wxSize& size = wxDefaultSize, long style = 0);
+
+    /// Constructors
+    virtual ~wxRichTextStyleListCtrl();
+
+    /// Member initialisation
+    void Init()
+    {
+        m_styleListBox = NULL;
+        m_styleChoice = NULL;
+        m_dontUpdate = false;
+    }
+
+    /// Creates the windows
+    bool Create(wxWindow* parent, wxWindowID id = wxID_ANY, const wxPoint& pos = wxDefaultPosition,
+        const wxSize& size = wxDefaultSize, long style = 0);
+
+    /// Updates the style list box
+    void UpdateStyles();
+
+    /// Associates the control with a style sheet
+    void SetStyleSheet(wxRichTextStyleSheet* styleSheet);
+    wxRichTextStyleSheet* GetStyleSheet() const;
+
+    /// Associates the control with a wxRichTextCtrl
+    void SetRichTextCtrl(wxRichTextCtrl* ctrl);
+    wxRichTextCtrl* GetRichTextCtrl() const;
+
+    /// Set/get the style type to display
+    void SetStyleType(wxRichTextStyleListBox::wxRichTextStyleType styleType);
+    wxRichTextStyleListBox::wxRichTextStyleType GetStyleType() const;
+
+    /// Get the choice index for style type
+    int StyleTypeToIndex(wxRichTextStyleListBox::wxRichTextStyleType styleType);
+
+    /// Get the style type for choice index
+    wxRichTextStyleListBox::wxRichTextStyleType StyleIndexToType(int i);
+
+    /// Get the listbox
+    wxRichTextStyleListBox* GetStyleListBox() const { return m_styleListBox; }
+
+    /// Get the choice
+    wxChoice* GetStyleChoice() const { return m_styleChoice; }
+
+    /// React to style type choice
+    void OnChooseType(wxCommandEvent& event);
+
+    /// Lay out the controls
+    void OnSize(wxSizeEvent& event);
+
+private:
+
+    wxRichTextStyleListBox* m_styleListBox;
+    wxChoice*               m_styleChoice;
+    bool                    m_dontUpdate;
 };
 
 #if wxUSE_COMBOCTRL
@@ -281,12 +580,7 @@ public:
         m_value = -1;
     }
 
-    virtual bool Create( wxWindow* parent )
-    {
-        return wxRichTextStyleListBox::Create(parent, wxID_ANY,
-                                  wxPoint(0,0), wxDefaultSize,
-                                  wxSIMPLE_BORDER);
-    }
+    virtual bool Create( wxWindow* parent );
 
     virtual wxWindow *GetControl() { return this; }
 
@@ -353,7 +647,7 @@ public:
     /// Updates the list
     void UpdateStyles() { m_stylePopup->UpdateStyles(); }
 
-    /// Associates the control with a style manager
+    /// Associates the control with a style sheet
     void SetStyleSheet(wxRichTextStyleSheet* styleSheet) { m_stylePopup->SetStyleSheet(styleSheet); }
     wxRichTextStyleSheet* GetStyleSheet() const { return m_stylePopup->GetStyleSheet(); }