*/
wxChoice();
- //@{
/**
Constructor, creating and showing a choice.
long style = 0,
const wxValidator& validator = wxDefaultValidator,
const wxString& name = wxChoiceNameStr );
- //@}
/**
Destructor, destroying the choice item.
/**
@class wxClientDataContainer
- This class is a mixin that provides storage and management of "client
- data." This data can either be of type void - in which case the data
+ This class is a mixin that provides storage and management of "client data".
+ This data can either be of type void - in which case the data
@e container does not take care of freeing the data again or it is of
type wxClientData or its derivatives. In that case the container will free
the memory itself later. Note that you @e must not assign both void data
*/
wxComboBox();
- //@{
/**
Constructor, creating and showing a combobox.
long style = 0,
const wxValidator& validator = wxDefaultValidator,
const wxString& name = wxComboBoxNameStr);
- //@}
/**
Destructor, destroying the combobox.
@since 2.9.1
*/
-class wxGridRowHeaderRendererDefault : public wxGridRowHeaderRendererDefault
+class wxGridRowHeaderRendererDefault : public wxGridRowHeaderRenderer
{
public:
/// Implement border drawing for the row labels.
/**
Returns tag's name. The name is always in uppercase and it doesn't contain
- " or '/' characters. (So the name of \<FONT SIZE=+2\> tag is "FONT"
+ " or '/' characters. (So the name of \<FONT SIZE=+2\> tag is "FONT"
and name of \</table\> is "TABLE").
*/
wxString GetName() const;
(although this is the most common case) -- it can be any value which can
be used to uniquely identify an item.
- @library{core}
+ @library{wxcore}
@category{events}
*/
class wxMouseEventsManager : public wxEvtHandler
*/
wxOwnerDrawnComboBox();
- //@{
/**
Constructor, creating and showing a owner-drawn combobox.
long style = 0,
const wxValidator& validator = wxDefaultValidator,
const wxString& name = "comboBox");
- //@}
/**
Destructor, destroying the owner-drawn combobox.
const wxSize& size = wxDefaultSize, long style = 0,
const wxString& name = wxStaticTextNameStr);
+ // NB: when writing docs for the following function remember that Doxygen
+ // will always expand HTML entities (e.g. ") and thus we need to
+ // write e.g. "&lt;" to have in the output the "<" string.
/**
- Escapes all the symbols of @a str that have a special meaning (<tt><>"'&</tt>) for
+ Escapes all the symbols of @a str that have a special meaning (<tt><>"'&</tt>) for
wxStaticText objects with the @c wxST_MARKUP style.
- Those symbols are replaced the corresponding entities (< > " ' &).
+
+ Those symbols are replaced the corresponding entities
+ (&lt; &gt; &quot; &apos; &amp;).
*/
static wxString EscapeMarkup(const wxString& str);
Here is an example function using this class which inserts hard line breaks
into a string of text at the positions where it would be wrapped:
+
@code
-wxString WrapText(wxWindow *win, const wxString& text, int widthMax)
-{
- class HardBreakWrapper : public wxTextWrapper
+ wxString WrapText(wxWindow *win, const wxString& text, int widthMax)
{
- public:
- HardBreakWrapper(wxWindow *win, const wxString& text, int widthMax)
- {
- Wrap(win, text, widthMax);
- }
-
- wxString const& GetWrapped() const { return m_wrapped; }
-
- protected:
- virtual void OnOutputLine(const wxString& line)
+ class HardBreakWrapper : public wxTextWrapper
{
- m_wrapped += line;
- }
-
- virtual void OnNewLine()
- {
- m_wrapped += '\n';
- }
-
- private:
- wxString m_wrapped;
- };
-
- HardBreakWrapper wrapper(win, text, widthMax);
- return wrapper.GetWrapped();
-}
+ public:
+ HardBreakWrapper(wxWindow *win, const wxString& text, int widthMax)
+ {
+ Wrap(win, text, widthMax);
+ }
+
+ wxString const& GetWrapped() const { return m_wrapped; }
+
+ protected:
+ virtual void OnOutputLine(const wxString& line)
+ {
+ m_wrapped += line;
+ }
+
+ virtual void OnNewLine()
+ {
+ m_wrapped += '\n';
+ }
+
+ private:
+ wxString m_wrapped;
+ };
+
+ HardBreakWrapper wrapper(win, text, widthMax);
+ return wrapper.GetWrapped();
+ }
@endcode
- @library{none}
+ @nolibrary
@category{gdi}
*/
class wxTextWrapper
/**
In this mode, the empty tokens in the middle of the string will be returned,
- i.e. @c "a::b:" will be tokenized in three tokens @c 'a', " and @c 'b'. Notice
- that all trailing delimiters are ignored in this mode, not just the last one,
+ i.e. @c "a::b:" will be tokenized in three tokens @c 'a', @c '' and @c 'b'.
+ Notice that all trailing delimiters are ignored in this mode, not just the last one,
i.e. a string @c "a::b::" would still result in the same set of tokens.
*/
wxTOKEN_RET_EMPTY,
The tool to be added.
@remarks After you have added tools to a toolbar, you must call
- Realize() in order to have the tools appear.
+ Realize() in order to have the tools appear.
@see AddSeparator(), AddCheckTool(), AddRadioTool(),
InsertTool(), DeleteTool(), Realize(), SetDropdownMenu()
projects / wxWidgets.git / commitdiff
