/////////////////////////////////////////////////////////////////////////////
// Name: richtext/richtextsymboldlg.h
-// Purpose: documentation for wxSymbolPickerDialog class
+// Purpose: interface of wxSymbolPickerDialog
// Author: wxWidgets team
// RCS-ID: $Id$
// Licence: wxWindows license
Constructors.
@param symbol
- The initial symbol to show. Specify a single character in a string, or an empty
- string.
-
+ The initial symbol to show. Specify a single character in a string, or an
+ empty string.
@param initialFont
- The initial font to be displayed in the font list. If empty, the item normal
- text will be selected.
-
+ The initial font to be displayed in the font list. If empty, the item
+ normal text will be selected.
@param normalTextFont
- The font the dialog will use to display the symbols if the initial font is
+ The font the dialog will use to display the symbols if the initial font is
empty.
-
@param parent
- The dialog's parent.
-
+ The dialog's parent.
@param id
- The dialog's identifier.
-
+ The dialog's identifier.
@param title
- The dialog's caption.
-
+ The dialog's caption.
@param pos
- The dialog's position.
-
+ The dialog's position.
@param size
- The dialog's size.
-
+ The dialog's size.
@param style
- The dialog's window style.
+ The dialog's window style.
*/
wxSymbolPickerDialog(const wxString& symbol,
const wxString& initialFont,
//@}
/**
- , @b const wxPoint&@e pos = wxDefaultPosition, @b const wxSize&@e size =
- wxDefaultSize, @b long@e style = wxDEFAULT_DIALOG_STYLE|wxRESIZE_BORDER|wxCLOSE_BOX)
-
+ , wxPoint&@e pos = wxDefaultPosition, wxSize&@e size = wxDefaultSize, @b
+ long@e style = wxDEFAULT_DIALOG_STYLE|wxRESIZE_BORDER|wxCLOSE_BOX)
Creation: see @ref wxsymbolpickerdialog() "the constructor" for details about
the parameters.
*/
bool Create(const wxString& symbol, const wxString& initialFont,
const wxString& normalTextFont,
wxWindow* parent,
- wxWindowID id = wxID_ANY);
+ wxWindowID id = wxID_ANY) const;
/**
Returns the font name (the font reflected in the font list).
*/
- wxString GetFontName();
+ wxString GetFontName() const;
/**
Returns @true if the dialog is showing the full range of Unicode characters.
*/
- bool GetFromUnicode();
+ bool GetFromUnicode() const;
/**
Gets the font name used for displaying symbols in the absence of a selected
font.
*/
- wxString GetNormalTextFontName();
+ wxString GetNormalTextFontName() const;
/**
Gets the current or initial symbol as a string.
*/
- wxString GetSymbol();
+ wxString GetSymbol() const;
/**
Gets the selected symbol character as an integer.
*/
- int GetSymbolChar();
+ int GetSymbolChar() const;
/**
Returns @true if a symbol is selected.
*/
- bool HasSelection();
+ bool HasSelection() const;
/**
Sets the initial/selected font name.
Returns @true if the has specified normal text - that is, there is no selected
font.
*/
- bool UseNormalFont();
+ bool UseNormalFont() const;
};
+