1\section{\class{wxRichTextStyleOrganiserDialog}}\label{wxrichtextstyleorganiserdialog}
2
3This class shows a style sheet and allows the user to edit, add and remove styles.
4It can also be used as a style browser, for example if the application is not
5using a permanent \helpref{wxRichTextStyleComboCtrl}{wxrichtextstylecomboctrl} or \helpref{wxRichTextStyleListCtrl}{wxrichtextstylelistctrl} to
6present styles.
7 
8\wxheading{Derived from}
9
10\helpref{wxDialog}{wxdialog}
11
12\wxheading{Include files}
13
14<wx/richtext/richtextstyledlg.h>
15
16\latexignore{\rtfignore{\wxheading{Members}}}
17
18\membersection{wxRichTextStyleOrganiserDialog::wxRichTextStyleOrganiserDialog}\label{wxrichtextstyleorganiserdialogwxrichtextstyleorganiserdialog}
19
20\func{}{wxRichTextStyleOrganiserDialog}{\param{int }{flags}, \param{wxRichTextStyleSheet* }{sheet}, \param{wxRichTextCtrl* }{ctrl}, \param{wxWindow* }{parent}, \param{wxWindowID }{id = wxID\_ANY}, \param{const wxString\& }{caption = \_("Style Organiser")}, \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize}, \param{long }{style = wxDEFAULT\_DIALOG\_STYLE|wxRESIZE\_BORDER|wxSYSTEM\_MENU|wxCLOSE\_BOX}}
21
22\func{}{wxRichTextStyleOrganiserDialog}{\void}
23
24Constructors.
25
26To create a dialog, pass a bitlist of {\it flags} (see below), a style sheet, a text control to apply a selected style to (or NULL), followed by the usual window parameters.
27
28To specify the operations available to the user, pass a combination of these values to {\it flags}:
29
30\twocolwidtha{7cm}
31\begin{twocollist}\itemsep=0pt
32\twocolitem{\windowstyle{wxRICHTEXT\_ORGANISER\_DELETE\_STYLES}}{Provides a button for deleting styles.}
33\twocolitem{\windowstyle{wxRICHTEXT\_ORGANISER\_CREATE\_STYLES}}{Provides buttons for creating styles.}
34\twocolitem{\windowstyle{wxRICHTEXT\_ORGANISER\_APPLY\_STYLES}}{Provides a button for applying the currently selected style to the selection.}
35\twocolitem{\windowstyle{wxRICHTEXT\_ORGANISER\_EDIT\_STYLES}}{Provides a button for editing styles.}
36\twocolitem{\windowstyle{wxRICHTEXT\_ORGANISER\_RENAME\_STYLES}}{Provides a button for renaming styles.}
37\twocolitem{\windowstyle{wxRICHTEXT\_ORGANISER\_OK\_CANCEL}}{Provides OK and Cancel buttons.}
38\twocolitem{\windowstyle{wxRICHTEXT\_ORGANISER\_RENUMBER}}{Provides a checkbox for specifying that the selection should be renumbered.}
39\end{twocollist}
40
41The following flags determine what will be displayed in the style list:
42
43\twocolwidtha{7cm}
44\begin{twocollist}\itemsep=0pt
45\twocolitem{\windowstyle{wxRICHTEXT\_ORGANISER\_SHOW\_CHARACTER}}{Displays character styles only.}
46\twocolitem{\windowstyle{wxRICHTEXT\_ORGANISER\_SHOW\_PARAGRAPH}}{Displays paragraph styles only.}
47\twocolitem{\windowstyle{wxRICHTEXT\_ORGANISER\_SHOW\_LIST}}{Displays list styles only.}
48\twocolitem{\windowstyle{wxRICHTEXT\_ORGANISER\_SHOW\_ALL}}{Displays all styles.}
49\end{twocollist}
50
51The following symbols define commonly-used combinations of flags:
52
53\twocolwidtha{7cm}
54\begin{twocollist}\itemsep=0pt
55\twocolitem{\windowstyle{wxRICHTEXT\_ORGANISER\_ORGANISE}}{Enable all style editing operations so the dialog behaves as a style organiser.}
56\twocolitem{\windowstyle{wxRICHTEXT\_ORGANISER\_BROWSE}}{Show a list of all styles and their previews, but only allow application of a style or
57cancellation of the dialog. This makes the dialog behave as a style browser.}
58\twocolitem{\windowstyle{wxRICHTEXT\_ORGANISER\_BROWSE\_NUMBERING}}{Enables only list style browsing, plus a control to specify renumbering. This
59allows the dialog to be used for applying list styles to the selection.}
60\end{twocollist}
61
62\membersection{wxRichTextStyleOrganiserDialog::ApplyStyle}\label{wxrichtextstyleorganiserdialogapplystyle}
63
64\func{bool}{ApplyStyle}{\param{wxRichTextCtrl* }{ctrl = NULL}}
65
66Applies the selected style to selection in the given control or the control passed to the constructor.
67
68\membersection{wxRichTextStyleOrganiserDialog::Create}\label{wxrichtextstyleorganiserdialogcreate}
69
70\func{bool}{Create}{\param{int }{flags}, \param{wxRichTextStyleSheet* }{sheet}, \param{wxRichTextCtrl* }{ctrl}, \param{wxWindow* }{parent}, \param{wxWindowID }{id = wxID\_ANY}, \param{const wxString\& }{caption = \_("Style Organiser")}, \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize}, \param{long }{style = wxDEFAULT\_DIALOG\_STYLE|wxRESIZE\_BORDER|wxSYSTEM\_MENU|wxCLOSE\_BOX}}
71
72Creates the dialog. See \membersection{wxRichTextStyleOrganiserDialog::wxRichTextStyleOrganiserDialog}{wxrichtextstyleorganiserdialogwxrichtextstyleorganiserdialog} for details.
73
74\membersection{wxRichTextStyleOrganiserDialog::GetFlags}\label{wxrichtextstyleorganiserdialoggetflags}
75
76\constfunc{int}{GetFlags}{\void}
77
78Returns the flags used to control the interface presented to the user.
79
80\membersection{wxRichTextStyleOrganiserDialog::GetRestartNumbering}\label{wxrichtextstyleorganiserdialoggetrestartnumbering}
81
82\constfunc{bool}{GetRestartNumbering}{\void}
83
84Returns \true if the user has opted to restart numbering.
85
86\membersection{wxRichTextStyleOrganiserDialog::GetRichTextCtrl}\label{wxrichtextstyleorganiserdialoggetrichtextctrl}
87
88\constfunc{wxRichTextCtrl*}{GetRichTextCtrl}{\void}
89
90Returns the associated rich text control (if any).
91
92\membersection{wxRichTextStyleOrganiserDialog::GetSelectedStyle}\label{wxrichtextstyleorganiserdialoggetselectedstyle}
93
94\constfunc{wxString}{GetSelectedStyle}{\void}
95
96Returns selected style name.
97
98\membersection{wxRichTextStyleOrganiserDialog::GetSelectedStyleDefinition}\label{wxrichtextstyleorganiserdialoggetselectedstyledefinition}
99
100\constfunc{wxRichTextStyleDefinition*}{GetSelectedStyleDefinition}{\void}
101
102Returns selected style definition.
103
104\membersection{wxRichTextStyleOrganiserDialog::GetStyleSheet}\label{wxrichtextstyleorganiserdialoggetstylesheet}
105
106\constfunc{wxRichTextStyleSheet*}{GetStyleSheet}{\void}
107
108Returns the associated style sheet.
109
110\membersection{wxRichTextStyleOrganiserDialog::SetFlags}\label{wxrichtextstyleorganiserdialogsetflags}
111
112\func{void}{SetFlags}{\param{int }{flags}}
113
114Sets the flags used to control the interface presented to the user.
115
116\membersection{wxRichTextStyleOrganiserDialog::SetRestartNumbering}\label{wxrichtextstyleorganiserdialogsetrestartnumbering}
117
118\func{void}{SetRestartNumbering}{\param{bool }{restartNumbering}}
119
120Checks or unchecks the restart numbering checkbox.
121
122\membersection{wxRichTextStyleOrganiserDialog::SetRichTextCtrl}\label{wxrichtextstyleorganiserdialogsetrichtextctrl}
123
124\func{void}{SetRichTextCtrl}{\param{wxRichTextCtrl* }{ctrl}}
125
126Sets the control to be associated with the dialog, for the purposes of applying a style to the selection.
127
128\membersection{wxRichTextStyleOrganiserDialog::SetShowToolTips}\label{wxrichtextstyleorganiserdialogsetshowtooltips}
129
130\func{void}{SetShowToolTips}{\param{bool }{show}}
131
132Determines whether tooltips will be shown.
133
134\membersection{wxRichTextStyleOrganiserDialog::SetStyleSheet}\label{wxrichtextstyleorganiserdialogsetstylesheet}
135
136\func{void}{SetStyleSheet}{\param{wxRichTextStyleSheet* }{sheet}}
137
138Sets the associated style sheet.
139
140