1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188
|
/////////////////////////////////////////////////////////////////////////////
// Name: richtext/richtextsymboldlg.h
// Purpose: interface of wxSymbolPickerDialog
// Author: wxWidgets team
// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
/**
@class wxSymbolPickerDialog
wxSymbolPickerDialog presents the user with a choice of fonts and a grid
of available characters. This modal dialog provides the application with
a selected symbol and optional font selection.
Although this dialog is contained in the rich text library, the dialog
is generic and can be used in other contexts.
To use the dialog, pass a default symbol specified as a string, an initial font
name, and a current font name. The difference between the initial font and
current font is that the initial font determines what the font control will be
set to when the dialog shows - an empty string will show the selection
@e normal text.
The current font, on the other hand, is used by the dialog to determine what
font to display the characters in, even when no initial font is selected.
This allows the user (and application) to distinguish between inserting a
symbol in the current font, and inserting it with a specified font.
When the dialog is dismissed, the application can get the selected symbol
with wxSymbolPickerDialog::GetSymbol and test whether a font was specified
with wxSymbolPickerDialog::UseNormalFont,fetching the specified font with
wxSymbolPickerDialog::GetFontName.
Here's a realistic example, inserting the supplied symbol into a
rich text control in either the current font or specified font.
@code
wxRichTextCtrl* ctrl = (wxRichTextCtrl*) FindWindow(ID_RICHTEXT_CTRL);
wxTextAttr attr;
attr.SetFlags(wxTEXT_ATTR_FONT);
ctrl-GetStyle(ctrl->GetInsertionPoint(), attr);
wxString currentFontName;
if (attr.HasFont() && attr.GetFont().IsOk())
currentFontName = attr.GetFont().GetFaceName();
// Don't set the initial font in the dialog (so the user is choosing
// 'normal text', i.e. the current font) but do tell the dialog
// what 'normal text' is.
wxSymbolPickerDialog dlg("*", wxEmptyString, currentFontName, this);
if (dlg.ShowModal() == wxID_OK)
{
if (dlg.HasSelection())
{
long insertionPoint = ctrl-GetInsertionPoint();
ctrl->WriteText(dlg.GetSymbol());
if (!dlg.UseNormalFont())
{
wxFont font(attr.GetFont());
font.SetFaceName(dlg.GetFontName());
attr.SetFont(font);
ctrl-SetStyle(insertionPoint, insertionPoint+1, attr);
}
}
}
@endcode
@library{wxrichtext}
@category{cmndlg}
*/
class wxSymbolPickerDialog : public wxDialog
{
public:
/**
Default ctor.
*/
wxSymbolPickerDialog();
/**
Constructor.
@param symbol
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.
@param normalTextFont
The font the dialog will use to display the symbols if the
initial font is empty.
@param parent
The dialog's parent.
@param id
The dialog's identifier.
@param title
The dialog's caption.
@param pos
The dialog's position.
@param size
The dialog's size.
@param style
The dialog's window style.
*/
wxSymbolPickerDialog(const wxString& symbol,
const wxString& initialFont,
const wxString& normalTextFont,
wxWindow* parent,
wxWindowID id = wxID_ANY,
const wxString& title = _("Symbols"),
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
long 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,
const wxString& caption = wxGetTranslation("Symbols"), const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxSize(400, 300), long style = wxDEFAULT_DIALOG_STYLE|wxRESIZE_BORDER|wxCLOSE_BOX);
/**
Returns the font name (the font reflected in the font list).
*/
wxString GetFontName() const;
/**
Returns @true if the dialog is showing the full range of Unicode characters.
*/
bool GetFromUnicode() const;
/**
Gets the font name used for displaying symbols in the absence of a selected font.
*/
wxString GetNormalTextFontName() const;
/**
Gets the current or initial symbol as a string.
*/
wxString GetSymbol() const;
/**
Gets the selected symbol character as an integer.
*/
int GetSymbolChar() const;
/**
Returns @true if a symbol is selected.
*/
bool HasSelection() const;
/**
Sets the initial/selected font name.
*/
void SetFontName(wxString value);
/**
Sets the internal flag indicating that the full Unicode range should be
displayed.
*/
void SetFromUnicode(bool value);
/**
Sets the name of the font to be used in the absence of a selected font.
*/
void SetNormalTextFontName(wxString value);
/**
Sets the symbol as a one or zero character string.
*/
void SetSymbol(wxString value);
/**
Sets Unicode display mode.
*/
void SetUnicodeMode(bool unicodeMode);
/**
Returns @true if the has specified normal text - that is, there is no selected font.
*/
bool UseNormalFont() const;
};
|