80fdcdb90e
Fixed commented names (path, filename, and extension) of files in include/ and src/. Prepended the names in src/ with "src/" everywhere, while starting those in include/wx/ with "wx/". git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@67254 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
87 lines
3.4 KiB
C++
87 lines
3.4 KiB
C++
///////////////////////////////////////////////////////////////////////////////
|
|
// Name: wx/tipdlg.h
|
|
// Purpose: declaration of wxTipDialog
|
|
// Author: Vadim Zeitlin
|
|
// Modified by:
|
|
// Created: 28.06.99
|
|
// RCS-ID: $Id$
|
|
// Copyright: (c) Vadim Zeitlin
|
|
// Licence: wxWindows licence
|
|
///////////////////////////////////////////////////////////////////////////////
|
|
|
|
#ifndef _WX_TIPDLG_H_
|
|
#define _WX_TIPDLG_H_
|
|
|
|
// ----------------------------------------------------------------------------
|
|
// headers which we must include here
|
|
// ----------------------------------------------------------------------------
|
|
|
|
#include "wx/defs.h"
|
|
|
|
#if wxUSE_STARTUP_TIPS
|
|
|
|
#include "wx/textfile.h"
|
|
|
|
// ----------------------------------------------------------------------------
|
|
// wxTipProvider - a class which is used by wxTipDialog to get the text of the
|
|
// tips
|
|
// ----------------------------------------------------------------------------
|
|
|
|
// the abstract base class: it provides the tips, i.e. implements the GetTip()
|
|
// function which returns the new tip each time it's called. To support this,
|
|
// wxTipProvider evidently needs some internal state which is the tip "index"
|
|
// and which should be saved/restored by the program to not always show one and
|
|
// the same tip (of course, you may use random starting position as well...)
|
|
class WXDLLIMPEXP_ADV wxTipProvider
|
|
{
|
|
public:
|
|
wxTipProvider(size_t currentTip) { m_currentTip = currentTip; }
|
|
|
|
// get the current tip and update the internal state to return the next tip
|
|
// when called for the next time
|
|
virtual wxString GetTip() = 0;
|
|
|
|
// get the current tip "index" (or whatever allows the tip provider to know
|
|
// from where to start the next time)
|
|
size_t GetCurrentTip() const { return m_currentTip; }
|
|
|
|
// Allows any user-derived class to optionally override this function to
|
|
// modify the tip as soon as it is read. If return wxEmptyString, then
|
|
// the tip is skipped, and the next one is read.
|
|
virtual wxString PreprocessTip(const wxString& tip) { return tip; }
|
|
|
|
// virtual dtor for the base class
|
|
virtual ~wxTipProvider() { }
|
|
|
|
protected:
|
|
size_t m_currentTip;
|
|
};
|
|
|
|
// a function which returns an implementation of wxTipProvider using the
|
|
// specified text file as the source of tips (each line is a tip).
|
|
//
|
|
// NB: the caller is responsible for deleting the pointer!
|
|
#if wxUSE_TEXTFILE
|
|
WXDLLIMPEXP_ADV wxTipProvider *wxCreateFileTipProvider(const wxString& filename,
|
|
size_t currentTip);
|
|
#endif // wxUSE_TEXTFILE
|
|
|
|
// ----------------------------------------------------------------------------
|
|
// wxTipDialog
|
|
// ----------------------------------------------------------------------------
|
|
|
|
// A dialog which shows a "tip" - a short and helpful messages describing to
|
|
// the user some program characteristic. Many programs show the tips at
|
|
// startup, so the dialog has "Show tips on startup" checkbox which allows to
|
|
// the user to disable this (however, it's the program which should show, or
|
|
// not, the dialog on startup depending on its value, not this class).
|
|
//
|
|
// The function returns true if this checkbox is checked, false otherwise.
|
|
WXDLLIMPEXP_ADV bool wxShowTip(wxWindow *parent,
|
|
wxTipProvider *tipProvider,
|
|
bool showAtStartup = true);
|
|
|
|
#endif // wxUSE_STARTUP_TIPS
|
|
|
|
#endif // _WX_TIPDLG_H_
|