projects / wxWidgets.git / blame
| Commit | Line | Data |
|---|---|---|
| 5f35b46a JS |
1 | \section{\class{wxRichTextStyleListBox}}\label{wxrichtextstylelistbox} |
| 2 | ||
| 3 | This is a listbox that can display the styles in a \helpref{wxRichTextStyleSheet}{wxrichtextstylesheet}, | |
| 4 | and apply the selection to an associated \helpref{wxRichTextCtrl}{wxrichtextctrl}. | |
| 5 | ||
| 6 | See {\tt samples/richtext} for an example of how to use it. | |
| 7 | ||
| 8 | \wxheading{Derived from} | |
| 9 | ||
| 10 | \helpref{wxHtmlListBox}{wxhtmllistbox} | |
| 11 | ||
| 12 | \wxheading{Include files} | |
| 13 | ||
| 14 | <wx/richtext/richtextstyles.h> | |
| 15 | ||
| 16 | \wxheading{Data structures} | |
| 17 | ||
| 18 | \latexignore{\rtfignore{\wxheading{Members}}} | |
| 19 | ||
| 20 | \membersection{wxRichTextStyleListBox::wxRichTextStyleListBox}\label{wxrichtextstylelistboxwxrichtextstylelistbox} | |
| 21 | ||
| 22 | \func{}{wxRichTextStyleListBox}{\param{wxWindow* }{parent}, \param{wxWindowID }{id = wxID\_ANY}, \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize}, \param{long }{style = 0}} | |
| 23 | ||
| 24 | Constructor. | |
| 25 | ||
| 26 | \membersection{wxRichTextStyleListBox::\destruct{wxRichTextStyleListBox}}\label{wxrichtextstylelistboxdtor} | |
| 27 | ||
| 28 | \func{}{\destruct{wxRichTextStyleListBox}}{\void} | |
| 29 | ||
| 30 | Destructor. | |
| 31 | ||
| 32 | \membersection{wxRichTextStyleListBox::ConvertTenthsMMToPixels}\label{wxrichtextstylelistboxconverttenthsmmtopixels} | |
| 33 | ||
| 34 | \constfunc{int}{ConvertTenthsMMToPixels}{\param{wxDC\& }{dc}, \param{int }{units}} | |
| 35 | ||
| 36 | Converts units in tenths of a millimetre to device units. | |
| 37 | ||
| 38 | \membersection{wxRichTextStyleListBox::CreateHTML}\label{wxrichtextstylelistboxcreatehtml} | |
| 39 | ||
| 40 | \constfunc{wxString}{CreateHTML}{\param{wxRichTextStyleDefinition* }{def}} | |
| 41 | ||
| 42 | Creates a suitable HTML fragment for a definition. | |
| 43 | ||
| 44 | \membersection{wxRichTextStyleListBox::GetRichTextCtrl}\label{wxrichtextstylelistboxgetrichtextctrl} | |
| 45 | ||
| 46 | \constfunc{wxRichTextCtrl*}{GetRichTextCtrl}{\void} | |
| 47 | ||
| 48 | Returns the \helpref{wxRichTextCtrl}{wxrichtextctrl} associated with this listbox. | |
| 49 | ||
| 50 | \membersection{wxRichTextStyleListBox::GetStyle}\label{wxrichtextstylelistboxgetstyle} | |
| 51 | ||
| 52 | \constfunc{wxRichTextStyleDefinition*}{GetStyle}{\param{size\_t }{i}} | |
| 53 | ||
| 54 | Gets a style for a listbox index. | |
| 55 | ||
| 56 | \membersection{wxRichTextStyleListBox::GetStyleSheet}\label{wxrichtextstylelistboxgetstylesheet} | |
| 57 | ||
| 58 | \constfunc{wxRichTextStyleSheet*}{GetStyleSheet}{\void} | |
| 59 | ||
| 60 | Returns the style sheet associated with this listbox. | |
| 61 | ||
| 62 | \membersection{wxRichTextStyleListBox::OnGetItem}\label{wxrichtextstylelistboxongetitem} | |
| 63 | ||
| 64 | \constfunc{wxString}{OnGetItem}{\param{size\_t }{n}} | |
| 65 | ||
| 66 | Returns the HTML for this item. | |
| 67 | ||
| 68 | \membersection{wxRichTextStyleListBox::OnLeftDown}\label{wxrichtextstylelistboxonleftdown} | |
| 69 | ||
| 70 | \func{void}{OnLeftDown}{\param{wxMouseEvent\& }{event}} | |
| 71 | ||
| 72 | Implements left click behaviour, applying the clicked style to the wxRichTextCtrl. | |
| 73 | ||
| 74 | \membersection{wxRichTextStyleListBox::OnSelect}\label{wxrichtextstylelistboxonselect} | |
| 75 | ||
| 76 | \func{void}{OnSelect}{\param{wxCommandEvent\& }{event}} | |
| 77 | ||
| 78 | Reacts to selection. | |
| 79 | ||
| 80 | \membersection{wxRichTextStyleListBox::SetRichTextCtrl}\label{wxrichtextstylelistboxsetrichtextctrl} | |
| 81 | ||
| 82 | \func{void}{SetRichTextCtrl}{\param{wxRichTextCtrl* }{ctrl}} | |
| 83 | ||
| 84 | Associates the listbox with a \helpref{wxRichTextCtrl}{wxrichtextctrl}. | |
| 85 | ||
| 86 | \membersection{wxRichTextStyleListBox::SetStyleSheet}\label{wxrichtextstylelistboxsetstylesheet} | |
| 87 | ||
| 88 | \func{void}{SetStyleSheet}{\param{wxRichTextStyleSheet* }{styleSheet}} | |
| 89 | ||
| 90 | Associates the control with a style sheet. | |
| 91 | ||
| 92 | \membersection{wxRichTextStyleListBox::UpdateStyles}\label{wxrichtextstylelistboxupdatestyles} | |
| 93 | ||
| 94 | \func{void}{UpdateStyles}{\void} | |
| 95 | ||
| 96 | Updates the list from the associated style sheet. |