git.saurik.com Git - wxWidgets.git/blame_incremental

... / ...

Commit	Line	Data
	1	/////////////////////////////////////////////////////////////////////////////
	2	// Name: tipdlg.h
	3	// Purpose: interface of wxTipProvider
	4	// Author: wxWidgets team
	5	// Licence: wxWindows licence
	6	/////////////////////////////////////////////////////////////////////////////
	7
	8	/**
	9	@class wxTipProvider
	10
	11	This is the class used together with wxShowTip() function.
	12	It must implement wxTipProvider::GetTip function and return the
	13	current tip from it (different tip each time it is called).
	14
	15	You will never use this class yourself, but you need it to show startup tips
	16	with wxShowTip. Also, if you want to get the tips text from elsewhere than a
	17	simple text file, you will want to derive a new class from wxTipProvider and
	18	use it instead of the one returned by wxCreateFileTipProvider().
	19
	20	@library{wxadv}
	21	@category{misc}
	22
	23	@see @ref overview_tips, ::wxShowTip
	24	*/
	25	class wxTipProvider
	26	{
	27	public:
	28	/**
	29	Constructor.
	30
	31	@param currentTip
	32	The starting tip index.
	33	*/
	34	wxTipProvider(size_t currentTip);
	35
	36	virtual ~wxTipProvider();
	37
	38	/**
	39	Returns the index of the current tip (i.e.\ the one which would be returned by GetTip()).
	40
	41	The program usually remembers the value returned by this function after calling
	42	wxShowTip(). Note that it is not the same as the value which was passed to
	43	wxShowTip + 1 because the user might have pressed the "Next" button in
	44	the tip dialog.
	45	*/
	46	size_t GetCurrentTip() const;
	47
	48	/**
	49	Return the text of the current tip and pass to the next one.
	50	This function is pure virtual, it should be implemented in the derived classes.
	51	*/
	52	virtual wxString GetTip() = 0;
	53
	54	/**
	55	Returns a modified tip.
	56
	57	This function will be called immediately after read, and before being check
	58	whether it is a comment, an empty string or a string to translate.
	59	You can optionally override this in your custom user-derived class
	60	to optionally to modify the tip as soon as it is read. You can return any
	61	modification to the string. If you return wxEmptyString, then this tip is
	62	skipped, and the next one is read.
	63	*/
	64	virtual wxString PreprocessTip(const wxString& tip);
	65	};
	66
	67
	68
	69	// ============================================================================
	70	// Global functions/macros
	71	// ============================================================================
	72
	73	/** @addtogroup group_funcmacro_dialog */
	74	//@{
	75
	76	/**
	77	This function creates a wxTipProvider which may be used with wxShowTip().
	78
	79	@param filename
	80	The name of the file containing the tips, one per line.
	81	@param currentTip
	82	The index of the first tip to show. Normally this index is remembered
	83	between the 2 program runs.
	84
	85	@see @ref overview_tips
	86
	87	@header{wx/tipdlg.h}
	88	*/
	89	wxTipProvider* wxCreateFileTipProvider(const wxString& filename,
	90	size_t currentTip);
	91
	92	/**
	93	This function shows a "startup tip" to the user. The return value is the
	94	state of the "Show tips at startup" checkbox.
	95
	96	@param parent
	97	The parent window for the modal dialog.
	98	@param tipProvider
	99	An object which is used to get the text of the tips. It may be created
	100	with the wxCreateFileTipProvider() function.
	101	@param showAtStartup
	102	Should be true if startup tips are shown, false otherwise. This is
	103	used as the initial value for "Show tips at startup" checkbox which is
	104	shown in the tips dialog.
	105
	106	@see @ref overview_tips
	107
	108	@header{wx/tipdlg.h}
	109	*/
	110	bool wxShowTip(wxWindow *parent,
	111	wxTipProvider *tipProvider,
	112	bool showAtStartup = true);
	113
	114	//@}
	115