]>
Commit | Line | Data |
---|---|---|
23324ae1 FM |
1 | ///////////////////////////////////////////////////////////////////////////// |
2 | // Name: richtext/richtextformatdlg.h | |
9e7ad1ca | 3 | // Purpose: interface of wxRichTextFormattingDialog* |
23324ae1 FM |
4 | // Author: wxWidgets team |
5 | // RCS-ID: $Id$ | |
6 | // Licence: wxWindows license | |
7 | ///////////////////////////////////////////////////////////////////////////// | |
8 | ||
9 | /** | |
10 | @class wxRichTextFormattingDialogFactory | |
7c913512 | 11 | |
23324ae1 FM |
12 | This class provides pages for wxRichTextFormattingDialog, and allows other |
13 | customization of the dialog. | |
9e7ad1ca FM |
14 | |
15 | A default instance of this class is provided automatically. | |
16 | If you wish to change the behaviour of the formatting dialog (for example add | |
17 | or replace a page), you may derive from this class, override one or more | |
18 | functions, and call the static function | |
23324ae1 | 19 | wxRichTextFormattingDialog::SetFormattingDialogFactory. |
7c913512 | 20 | |
23324ae1 | 21 | @library{wxrichtext} |
9e7ad1ca | 22 | @category{richtext} |
23324ae1 FM |
23 | */ |
24 | class wxRichTextFormattingDialogFactory : public wxObject | |
25 | { | |
26 | public: | |
27 | /** | |
28 | Constructor. | |
29 | */ | |
30 | wxRichTextFormattingDialogFactory(); | |
31 | ||
32 | /** | |
33 | Destructor. | |
34 | */ | |
adaaa686 | 35 | virtual ~wxRichTextFormattingDialogFactory(); |
23324ae1 FM |
36 | |
37 | /** | |
38 | Creates the main dialog buttons. | |
39 | */ | |
40 | virtual bool CreateButtons(wxRichTextFormattingDialog* dialog); | |
41 | ||
42 | /** | |
43 | Creates a page, given a page identifier. | |
44 | */ | |
45 | virtual wxPanel* CreatePage(int page, wxString& title, | |
46 | wxRichTextFormattingDialog* dialog); | |
47 | ||
48 | /** | |
9e7ad1ca | 49 | Creates all pages under the dialog's book control, also calling AddPage(). |
23324ae1 FM |
50 | */ |
51 | virtual bool CreatePages(long pages, | |
52 | wxRichTextFormattingDialog* dialog); | |
53 | ||
54 | /** | |
55 | Enumerate all available page identifiers. | |
56 | */ | |
328f5751 | 57 | virtual int GetPageId(int i) const; |
23324ae1 FM |
58 | |
59 | /** | |
60 | Gets the number of available page identifiers. | |
61 | */ | |
328f5751 | 62 | virtual int GetPageIdCount() const; |
23324ae1 FM |
63 | |
64 | /** | |
65 | Gets the image index for the given page identifier. | |
66 | */ | |
328f5751 | 67 | virtual int GetPageImage(int id) const; |
23324ae1 FM |
68 | |
69 | /** | |
70 | Set the property sheet style, called at the start of | |
71 | wxRichTextFormattingDialog::Create. | |
72 | */ | |
73 | virtual bool SetSheetStyle(wxRichTextFormattingDialog* dialog); | |
74 | ||
75 | /** | |
76 | Invokes help for the dialog. | |
77 | */ | |
78 | virtual bool ShowHelp(int page, | |
79 | wxRichTextFormattingDialog* dialog); | |
80 | }; | |
81 | ||
82 | ||
e54c96f1 | 83 | |
9e7ad1ca FM |
84 | #define wxRICHTEXT_FORMAT_STYLE_EDITOR 0x0001 |
85 | #define wxRICHTEXT_FORMAT_FONT 0x0002 | |
86 | #define wxRICHTEXT_FORMAT_TABS 0x0004 | |
87 | #define wxRICHTEXT_FORMAT_BULLETS 0x0008 | |
88 | #define wxRICHTEXT_FORMAT_INDENTS_SPACING 0x0010 | |
89 | ||
23324ae1 FM |
90 | /** |
91 | @class wxRichTextFormattingDialog | |
7c913512 | 92 | |
23324ae1 | 93 | This dialog allows the user to edit a character and/or paragraph style. |
7c913512 | 94 | |
9e7ad1ca FM |
95 | In the constructor, specify the pages that will be created. |
96 | Use wxRichTextFormattingDialog::GetStyle() to retrieve the common style | |
97 | for a given range, and then use wxRichTextFormattingDialog::ApplyStyle() | |
98 | to apply the user-selected formatting to a control. | |
7c913512 | 99 | |
9e7ad1ca | 100 | For example: |
23324ae1 | 101 | @code |
9e7ad1ca | 102 | wxRichTextRange range; |
23324ae1 FM |
103 | if (m_richTextCtrl-HasSelection()) |
104 | range = m_richTextCtrl-GetSelectionRange(); | |
105 | else | |
106 | range = wxRichTextRange(0, m_richTextCtrl-GetLastPosition()+1); | |
7c913512 | 107 | |
9e7ad1ca FM |
108 | int pages = wxRICHTEXT_FORMAT_FONT|wxRICHTEXT_FORMAT_INDENTS_SPACING| \ |
109 | wxRICHTEXT_FORMAT_TABS|wxRICHTEXT_FORMAT_BULLETS; | |
7c913512 | 110 | |
23324ae1 FM |
111 | wxRichTextFormattingDialog formatDlg(pages, this); |
112 | formatDlg.GetStyle(m_richTextCtrl, range); | |
7c913512 | 113 | |
23324ae1 FM |
114 | if (formatDlg.ShowModal() == wxID_OK) |
115 | { | |
116 | formatDlg.ApplyStyle(m_richTextCtrl, range); | |
117 | } | |
118 | @endcode | |
7c913512 | 119 | |
23324ae1 | 120 | @library{wxrichtext} |
21b447dc | 121 | @category{richtext} |
23324ae1 FM |
122 | */ |
123 | class wxRichTextFormattingDialog : public wxPropertySheetDialog | |
124 | { | |
125 | public: | |
9e7ad1ca FM |
126 | /** |
127 | Default ctor. | |
128 | */ | |
129 | wxRichTextFormattingDialog(); | |
130 | ||
23324ae1 FM |
131 | /** |
132 | Constructors. | |
9e7ad1ca | 133 | |
7c913512 | 134 | @param flags |
4cc4bfaf | 135 | The pages to show. |
7c913512 | 136 | @param parent |
4cc4bfaf | 137 | The dialog's parent. |
7c913512 | 138 | @param pos |
4cc4bfaf | 139 | The dialog's position. |
9e7ad1ca | 140 | @param sz |
4cc4bfaf | 141 | The dialog's size. |
7c913512 | 142 | @param style |
4cc4bfaf | 143 | The dialog's window style. |
23324ae1 | 144 | */ |
9e7ad1ca FM |
145 | wxRichTextFormattingDialog(long flags, wxWindow* parent, |
146 | const wxPoint& pos = wxDefaultPosition, | |
147 | const wxSize& sz = wxDefaultSize, | |
148 | long style = wxDEFAULT_DIALOG_STYLE); | |
23324ae1 FM |
149 | |
150 | /** | |
151 | Destructor. | |
152 | */ | |
adaaa686 | 153 | virtual ~wxRichTextFormattingDialog(); |
23324ae1 FM |
154 | |
155 | /** | |
9e7ad1ca FM |
156 | Apply attributes to the given range, only changing attributes that |
157 | need to be changed. | |
23324ae1 | 158 | */ |
0004982c FM |
159 | virtual bool ApplyStyle(wxRichTextCtrl* ctrl, const wxRichTextRange& range, |
160 | int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO|wxRICHTEXT_SETSTYLE_OPTIMIZE); | |
23324ae1 FM |
161 | |
162 | /** | |
9e7ad1ca | 163 | Creation: see wxRichTextFormattingDialog() "the constructor" for |
23324ae1 FM |
164 | details about the parameters. |
165 | */ | |
5267aefd FM |
166 | bool Create(long flags, wxWindow* parent, |
167 | const wxString& title = wxGetTranslation(wxT("Formatting")), wxWindowID id = wxID_ANY, const wxPoint& pos = wxDefaultPosition, const wxSize& sz = wxDefaultSize, long style = wxDEFAULT_DIALOG_STYLE); | |
23324ae1 FM |
168 | |
169 | //@{ | |
170 | /** | |
171 | Gets the attributes being edited. | |
172 | */ | |
9e7ad1ca FM |
173 | const wxTextAttr& GetAttributes() const; |
174 | wxTextAttr& GetAttributes(); | |
23324ae1 FM |
175 | //@} |
176 | ||
177 | /** | |
178 | Helper for pages to get the top-level dialog. | |
179 | */ | |
adaaa686 | 180 | static wxRichTextFormattingDialog* GetDialog(wxWindow* win); |
23324ae1 FM |
181 | |
182 | /** | |
183 | Helper for pages to get the attributes. | |
184 | */ | |
adaaa686 | 185 | static wxTextAttr* GetDialogAttributes(wxWindow* win); |
23324ae1 FM |
186 | |
187 | /** | |
188 | Helper for pages to get the style. | |
189 | */ | |
adaaa686 | 190 | static wxRichTextStyleDefinition* GetDialogStyleDefinition(wxWindow* win); |
23324ae1 FM |
191 | |
192 | /** | |
193 | Returns the object to be used to customize the dialog and provide pages. | |
194 | */ | |
adaaa686 | 195 | static wxRichTextFormattingDialogFactory* GetFormattingDialogFactory(); |
23324ae1 FM |
196 | |
197 | /** | |
198 | Returns the image list associated with the dialog, used for example if showing | |
199 | the dialog as a toolbook. | |
200 | */ | |
328f5751 | 201 | wxImageList* GetImageList() const; |
23324ae1 FM |
202 | |
203 | /** | |
9e7ad1ca FM |
204 | Gets common attributes from the given range and calls SetAttributes(). |
205 | Attributes that do not have common values in the given range | |
23324ae1 FM |
206 | will be omitted from the style's flags. |
207 | */ | |
adaaa686 | 208 | virtual bool GetStyle(wxRichTextCtrl* ctrl, const wxRichTextRange& range); |
23324ae1 FM |
209 | |
210 | /** | |
211 | Gets the associated style definition, if any. | |
212 | */ | |
adaaa686 | 213 | virtual wxRichTextStyleDefinition* GetStyleDefinition() const; |
23324ae1 FM |
214 | |
215 | /** | |
216 | Gets the associated style sheet, if any. | |
217 | */ | |
adaaa686 | 218 | virtual wxRichTextStyleSheet* GetStyleSheet() const; |
23324ae1 FM |
219 | |
220 | /** | |
221 | Sets the attributes to be edited. | |
222 | */ | |
223 | void SetAttributes(const wxTextAttr& attr); | |
224 | ||
225 | /** | |
226 | Sets the formatting factory object to be used for customization and page | |
227 | creation. | |
9e7ad1ca | 228 | |
23324ae1 FM |
229 | It deletes the existing factory object. |
230 | */ | |
adaaa686 | 231 | static void SetFormattingDialogFactory(wxRichTextFormattingDialogFactory* factory); |
23324ae1 FM |
232 | |
233 | /** | |
234 | Sets the image list associated with the dialog's property sheet. | |
235 | */ | |
236 | void SetImageList(wxImageList* imageList); | |
237 | ||
238 | /** | |
4cc4bfaf | 239 | Sets the attributes and optionally updates the display, if @a update is @true. |
23324ae1 | 240 | */ |
adaaa686 | 241 | virtual bool SetStyle(const wxTextAttr& style, bool update = true); |
23324ae1 FM |
242 | |
243 | /** | |
9e7ad1ca FM |
244 | Sets the style definition and optionally update the display, |
245 | if @a update is @true. | |
23324ae1 | 246 | */ |
adaaa686 FM |
247 | virtual bool SetStyleDefinition(const wxRichTextStyleDefinition& styleDef, |
248 | wxRichTextStyleSheet* sheet, | |
249 | bool update = true); | |
23324ae1 FM |
250 | |
251 | /** | |
252 | Updates the display. | |
253 | */ | |
adaaa686 | 254 | virtual bool UpdateDisplay(); |
23324ae1 | 255 | }; |
e54c96f1 | 256 |