Version: 3.0.5
Loading...
Searching...
No Matches
tipdlg.h File Reference

Classes

class  wxTipProvider
 This is the class used together with wxShowTip() function. More...
 

Functions

wxTipProviderwxCreateFileTipProvider (const wxString &filename, size_t currentTip)
 This function creates a wxTipProvider which may be used with wxShowTip().
 
bool wxShowTip (wxWindow *parent, wxTipProvider *tipProvider, bool showAtStartup=true)
 This function shows a "startup tip" to the user.
 

Function Documentation

◆ wxCreateFileTipProvider()

wxTipProvider * wxCreateFileTipProvider ( const wxString filename,
size_t  currentTip 
)

This function creates a wxTipProvider which may be used with wxShowTip().

Parameters
filenameThe name of the file containing the tips, one per line.
currentTipThe index of the first tip to show. Normally this index is remembered between the 2 program runs.
See also
wxTipProvider Overview

Include file:

#include <wx/tipdlg.h> 

◆ wxShowTip()

bool wxShowTip ( wxWindow parent,
wxTipProvider tipProvider,
bool  showAtStartup = true 
)

This function shows a "startup tip" to the user.

The return value is the state of the "Show tips at startup" checkbox.

Parameters
parentThe parent window for the modal dialog.
tipProviderAn object which is used to get the text of the tips. It may be created with the wxCreateFileTipProvider() function.
showAtStartupShould be true if startup tips are shown, false otherwise. This is used as the initial value for "Show tips at startup" checkbox which is shown in the tips dialog.
See also
wxTipProvider Overview

Include file:

#include <wx/tipdlg.h>