wxWidgets/docs/latex/wx/richtextstylelistbox.tex
Julian Smart 62a268cc71 Added some missing newlines to ends of files (necessary for linear RTF)
Added rich text control formatting and symbol dialogs
API changes for wxRichTextCtrl


git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@41898 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2006-10-10 16:48:47 +00:00

184 lines
6.4 KiB
TeX

\section{\class{wxRichTextStyleComboCtrl}}\label{wxrichtextstylecomboctrl}
This is a combo control that can display the styles in a \helpref{wxRichTextStyleSheet}{wxrichtextstylesheet},
and apply the selection to an associated \helpref{wxRichTextCtrl}{wxrichtextctrl}.
See {\tt samples/richtext} for an example of how to use it.
\wxheading{Derived from}
\helpref{wxComboCtrl}{wxcomboctrl}
\wxheading{Include files}
<wx/richtext/richtextstyles.h>
\wxheading{See also}
\helpref{wxRichTextStyleListBox}{wxrichtextstylelistbox}, \helpref{wxRichTextCtrl overview}{wxrichtextctrloverview}
\latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxRichTextStyleComboCtrl::wxRichTextStyleComboCtrl}\label{wxrichtextstylecomboctrlwxrichtextstylecomboctrl}
\func{}{wxRichTextStyleComboCtrl}{\param{wxWindow* }{parent}, \param{wxWindowID }{id = wxID\_ANY}, \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize}, \param{long }{style = 0}}
Constructor.
\membersection{wxRichTextStyleComboCtrl::\destruct{wxRichTextStyleComboCtrl}}\label{wxrichtextstylecomboctrldtor}
\func{}{\destruct{wxRichTextStyleComboCtrl}}{\void}
Destructor.
\membersection{wxRichTextStyleComboCtrl::GetRichTextCtrl}\label{wxrichtextstylecomboctrlgetrichtextctrl}
\constfunc{wxRichTextCtrl*}{GetRichTextCtrl}{\void}
Returns the \helpref{wxRichTextCtrl}{wxrichtextctrl} associated with this control.
\membersection{wxRichTextStyleComboCtrl::GetStyleSheet}\label{wxrichtextstylecomboctrlgetstylesheet}
\constfunc{wxRichTextStyleSheet*}{GetStyleSheet}{\void}
Returns the style sheet associated with this control.
\membersection{wxRichTextStyleComboCtrl::SetRichTextCtrl}\label{wxrichtextstylecomboctrlsetrichtextctrl}
\func{void}{SetRichTextCtrl}{\param{wxRichTextCtrl* }{ctrl}}
Associates the control with a \helpref{wxRichTextCtrl}{wxrichtextctrl}.
\membersection{wxRichTextStyleComboCtrl::SetStyleSheet}\label{wxrichtextstylecomboctrlsetstylesheet}
\func{void}{SetStyleSheet}{\param{wxRichTextStyleSheet* }{styleSheet}}
Associates the control with a style sheet.
\membersection{wxRichTextStyleComboCtrl::UpdateStyles}\label{wxrichtextstylecomboctrlupdatestyles}
\func{void}{UpdateStyles}{\void}
Updates the combo control from the associated style sheet.
\section{\class{wxRichTextStyleListBox}}\label{wxrichtextstylelistbox}
This is a listbox that can display the styles in a \helpref{wxRichTextStyleSheet}{wxrichtextstylesheet},
and apply the selection to an associated \helpref{wxRichTextCtrl}{wxrichtextctrl}.
See {\tt samples/richtext} for an example of how to use it.
\wxheading{Derived from}
\helpref{wxHtmlListBox}{wxhtmllistbox}
\wxheading{Include files}
<wx/richtext/richtextstyles.h>
\wxheading{See also}
\helpref{wxRichTextStyleComboCtrl}{wxrichtextstylecomboctrl}, \helpref{wxRichTextCtrl overview}{wxrichtextctrloverview}
\latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxRichTextStyleListBox::wxRichTextStyleListBox}\label{wxrichtextstylelistboxwxrichtextstylelistbox}
\func{}{wxRichTextStyleListBox}{\param{wxWindow* }{parent}, \param{wxWindowID }{id = wxID\_ANY}, \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize}, \param{long }{style = 0}}
Constructor.
\membersection{wxRichTextStyleListBox::\destruct{wxRichTextStyleListBox}}\label{wxrichtextstylelistboxdtor}
\func{}{\destruct{wxRichTextStyleListBox}}{\void}
Destructor.
\membersection{wxRichTextStyleListBox::ApplyStyle}\label{wxrichtextstylelistboxapplystyle}
\func{void}{ApplyStyle}{\param{int }{i}}
Applies the {\it i}th style to the associated rich text control.
\membersection{wxRichTextStyleListBox::ConvertTenthsMMToPixels}\label{wxrichtextstylelistboxconverttenthsmmtopixels}
\constfunc{int}{ConvertTenthsMMToPixels}{\param{wxDC\& }{dc}, \param{int }{units}}
Converts units in tenths of a millimetre to device units.
\membersection{wxRichTextStyleListBox::CreateHTML}\label{wxrichtextstylelistboxcreatehtml}
\constfunc{wxString}{CreateHTML}{\param{wxRichTextStyleDefinition* }{def}}
Creates a suitable HTML fragment for a definition.
\membersection{wxRichTextStyleListBox::GetApplyOnSelection}\label{wxrichtextstylelistboxgetapplyonselection}
\constfunc{bool}{GetApplyOnSelection}{\void}
If the return value is \true, clicking on a style name in the list will immediately
apply the style to the associated rich text control.
\membersection{wxRichTextStyleListBox::GetRichTextCtrl}\label{wxrichtextstylelistboxgetrichtextctrl}
\constfunc{wxRichTextCtrl*}{GetRichTextCtrl}{\void}
Returns the \helpref{wxRichTextCtrl}{wxrichtextctrl} associated with this listbox.
\membersection{wxRichTextStyleListBox::GetStyle}\label{wxrichtextstylelistboxgetstyle}
\constfunc{wxRichTextStyleDefinition*}{GetStyle}{\param{size\_t }{i}}
Gets a style for a listbox index.
\membersection{wxRichTextStyleListBox::GetStyleSheet}\label{wxrichtextstylelistboxgetstylesheet}
\constfunc{wxRichTextStyleSheet*}{GetStyleSheet}{\void}
Returns the style sheet associated with this listbox.
\membersection{wxRichTextStyleListBox::OnGetItem}\label{wxrichtextstylelistboxongetitem}
\constfunc{wxString}{OnGetItem}{\param{size\_t }{n}}
Returns the HTML for this item.
\membersection{wxRichTextStyleListBox::OnLeftDown}\label{wxrichtextstylelistboxonleftdown}
\func{void}{OnLeftDown}{\param{wxMouseEvent\& }{event}}
Implements left click behaviour, applying the clicked style to the wxRichTextCtrl.
\membersection{wxRichTextStyleListBox::OnSelect}\label{wxrichtextstylelistboxonselect}
\func{void}{OnSelect}{\param{wxCommandEvent\& }{event}}
Reacts to selection.
\membersection{wxRichTextStyleListBox::SetApplyOnSelection}\label{wxrichtextstylelistboxsetapplyonselection}
\func{void}{SetApplyOnSelection}{\param{bool }{applyOnSelection}}
If {\it applyOnSelection} is \true, clicking on a style name in the list will immediately
apply the style to the associated rich text control.
\membersection{wxRichTextStyleListBox::SetRichTextCtrl}\label{wxrichtextstylelistboxsetrichtextctrl}
\func{void}{SetRichTextCtrl}{\param{wxRichTextCtrl* }{ctrl}}
Associates the listbox with a \helpref{wxRichTextCtrl}{wxrichtextctrl}.
\membersection{wxRichTextStyleListBox::SetStyleSheet}\label{wxrichtextstylelistboxsetstylesheet}
\func{void}{SetStyleSheet}{\param{wxRichTextStyleSheet* }{styleSheet}}
Associates the control with a style sheet.
\membersection{wxRichTextStyleListBox::UpdateStyles}\label{wxrichtextstylelistboxupdatestyles}
\func{void}{UpdateStyles}{\void}
Updates the list from the associated style sheet.