wxrichtextstyleorganiserdialog

this class shows a style sheet and allows the user to edit, add and remove styles. it can also be used as a style browser, for example if the application is not using a permanent wxrichtextstylecomboctrl or wxrichtextstylelistctrl to present styles. derived from

wxdialog

include files

members

wxrichtextstyleorganiserdialog::wxrichtextstyleorganiserdialog

wxrichtextstyleorganiserdialog(int flags, wxrichtextstylesheet* sheet, wxrichtextctrl* ctrl, wxwindow* parent, wxwindowid id = wxid_any, const wxstring& caption = _("style organiser"), const wxpoint& pos = wxdefaultposition, const wxsize& size = wxdefaultsize, long style = wxdefault_dialog_style|wxresize_border|wxsystem_menu|wxclose_box)

wxrichtextstyleorganiserdialog()

constructors.

to create a dialog, pass a bitlist of flags (see below), a style sheet, a text control to apply a selected style to (or null), followed by the usual window parameters.

to specify the operations available to the user, pass a combination of these values to flags:

wxrichtext_organiser_delete_styles	provides a button for deleting styles.
wxrichtext_organiser_create_styles	provides buttons for creating styles.
wxrichtext_organiser_apply_styles	provides a button for applying the currently selected style to the selection.
wxrichtext_organiser_edit_styles	provides a button for editing styles.
wxrichtext_organiser_rename_styles	provides a button for renaming styles.
wxrichtext_organiser_ok_cancel	provides ok and cancel buttons.
wxrichtext_organiser_renumber	provides a checkbox for specifying that the selection should be renumbered.

the following flags determine what will be displayed in the style list:

wxrichtext_organiser_show_character	displays character styles only.
wxrichtext_organiser_show_paragraph	displays paragraph styles only.
wxrichtext_organiser_show_list	displays list styles only.
wxrichtext_organiser_show_all	displays all styles.

the following symbols define commonly-used combinations of flags:

wxrichtext_organiser_organise	enable all style editing operations so the dialog behaves as a style organiser.
wxrichtext_organiser_browse	show a list of all styles and their previews, but only allow application of a style or cancellation of the dialog. this makes the dialog behave as a style browser.
wxrichtext_organiser_browse_numbering	enables only list style browsing, plus a control to specify renumbering. this allows the dialog to be used for applying list styles to the selection.

wxrichtextstyleorganiserdialog::applystyle

bool applystyle(wxrichtextctrl* ctrl = null)

applies the selected style to selection in the given control or the control passed to the constructor.

wxrichtextstyleorganiserdialog::create

bool create(int flags, wxrichtextstylesheet* sheet, wxrichtextctrl* ctrl, wxwindow* parent, wxwindowid id = wxid_any, const wxstring& caption = _("style organiser"), const wxpoint& pos = wxdefaultposition, const wxsize& size = wxdefaultsize, long style = wxdefault_dialog_style|wxresize_border|wxsystem_menu|wxclose_box)

creates the dialog. see

wxrichtextstyleorganiserdialog::wxrichtextstyleorganiserdialog

wxrichtextstyleorganiserdialogwxrichtextstyleorganiserdialog for details.

wxrichtextstyleorganiserdialog::getflags

int getflags() const

returns the flags used to control the interface presented to the user.

wxrichtextstyleorganiserdialog::getrestartnumbering

bool getrestartnumbering() const

returns true if the user has opted to restart numbering.

wxrichtextstyleorganiserdialog::getrichtextctrl

wxrichtextctrl* getrichtextctrl() const

returns the associated rich text control (if any).

wxrichtextstyleorganiserdialog::getselectedstyle

wxstring getselectedstyle() const

returns selected style name.

wxrichtextstyleorganiserdialog::getselectedstyledefinition

wxrichtextstyledefinition* getselectedstyledefinition() const

returns selected style definition.

wxrichtextstyleorganiserdialog::getstylesheet

wxrichtextstylesheet* getstylesheet() const

returns the associated style sheet.

wxrichtextstyleorganiserdialog::setflags

void setflags(int flags)

sets the flags used to control the interface presented to the user.

wxrichtextstyleorganiserdialog::setrestartnumbering

void setrestartnumbering(bool restartnumbering)

checks or unchecks the restart numbering checkbox.

wxrichtextstyleorganiserdialog::setrichtextctrl

void setrichtextctrl(wxrichtextctrl* ctrl)

sets the control to be associated with the dialog, for the purposes of applying a style to the selection.

wxrichtextstyleorganiserdialog::setshowtooltips

void setshowtooltips(bool show)

determines whether tooltips will be shown.

wxrichtextstyleorganiserdialog::setstylesheet

void setstylesheet(wxrichtextstylesheet* sheet)

sets the associated style sheet.