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