html_tip_dialog Class Reference

A startup tips dialog, similar to wxTipDialog, but that can handle html. More...

Inheritance diagram for html_tip_dialog:


Public Methods
	html_tip_dialog (wxWindow parent, wxTipProvider tip_provider, bool show_at_startup, const wxString &header_html=wxEmptyString, const wxString &footer_html=wxEmptyString, bool use_system_style=TRUE, wxSize html_window_size=wxSize(plkrHTML_TIP_DIALOG_CONTENT_WIDTH, plkrHTML_TIP_DIALOG_CONTENT_HEIGHT), int html_window_content_padding=0, const wxString &title=_("Tip of the day"))
	Constructor.
	~html_tip_dialog ()
	Destructor.
bool	show_tips_on_startup ()
	Query if user entered in the checkbox that s/he wants to "Show tips on startup".
void	set_tip_text ()
	Sets the (next) tip text.
void	on_next_tip_button (wxCommandEvent &WXUNUSED(event))
	"Next" button handler

Detailed Description

A startup tips dialog, similar to wxTipDialog, but that can handle html.

This class shouldn't be used directly. Just call the show_html_tip function--this is similar to the wxShowTip function in wxWindows library.

html_tip_dialog::html_tip_dialog	(	wxWindow *	parent,
		wxTipProvider *	tip_provider,
		bool	show_at_startup,
		const wxString &	header_html = wxEmptyString,
		const wxString &	footer_html = wxEmptyString,
		bool	use_system_style = TRUE,
		wxSize	html_window_size = wxSize(plkrHTML_TIP_DIALOG_CONTENT_WIDTH, plkrHTML_TIP_DIALOG_CONTENT_HEIGHT),
		int	html_window_content_padding = 0,
		const wxString &	title = _("Tip of the day")
	)

Constructor.

Parameters:

parent	The parent window.
tip_provider	The wxTipProvider that this dialog is associated with.
show_at_startup	TRUE to initially check the 'Show at startup' checkbox.
header_html	Optional HTML snippet to place before the tip.
header_html	Optional HTML snippet to place after the tip.
bool	use_system_style Use system's gui sytle for fonts and background color.
html_window_size	Size of the html window component of the dialog.
html_window_content_padding	Padding from the edge of the html window border to its contents (in pixels).-1 will just use the default setting for a wxHtmlWindow.
title	A title of the dialog (not in the content window though, just the dialog title).

bool html_tip_dialog::show_tips_on_startup

(

)

Query if user entered in the checkbox that s/he wants to "Show tips on startup".