From c89165a82daea967ec79e528fd08bf7440bbd4ec Mon Sep 17 00:00:00 2001 From: Vadim Zeitlin Date: Mon, 28 Jun 1999 22:08:46 +0000 Subject: [PATCH] more files I forgot to commit git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@2926 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- docs/latex/wx/statline.tex | 83 ++++++++++++++++++++++++++++++++++++++ include/wx/tipdlg.h | 83 ++++++++++++++++++++++++++++++++++++++ 2 files changed, 166 insertions(+) create mode 100644 docs/latex/wx/statline.tex create mode 100644 include/wx/tipdlg.h diff --git a/docs/latex/wx/statline.tex b/docs/latex/wx/statline.tex new file mode 100644 index 0000000000..7e6a82fb89 --- /dev/null +++ b/docs/latex/wx/statline.tex @@ -0,0 +1,83 @@ +\section{\class{wxStaticLine}}\label{wxstaticline} + +A static line is just a line which may be used in a dialog to separate the +groups of controls. The line may be only vertical or horizontal. + +\wxheading{Derived from} + +\helpref{wxControl}{wxcontrol}\\ +\helpref{wxWindow}{wxwindow}\\ +\helpref{wxEvtHandler}{wxevthandler}\\ +\helpref{wxObject}{wxobject} + +\wxheading{Include files} + + + +\wxheading{Window styles} + +\twocolwidtha{5cm} +\begin{twocollist}\itemsep=0pt +\twocolitem{\windowstyle{wxLI\_HORIZONTAL}}{Creates a horizontal line.} +\twocolitem{\windowstyle{wxLI\_VERTICAL}}{Creates a vertical line.} +\end{twocollist} + +\wxheading{See also} + +\helpref{wxStaticBox}{wxstaticbox} + +\latexignore{\rtfignore{\wxheading{Members}}} + +\membersection{wxStaticLine::wxStaticLine}\label{wxstaticlinector} + +\func{}{wxStaticLine}{\void} + +Default constructor. + +\func{}{wxStaticLine}{\param{wxWindow* }{parent}, \param{wxWindowID }{id}, \param{const wxString\& }{label},\rtfsp +\param{const wxPoint\&}{ pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp +\param{long}{ style = wxLI\_HORIZONTAL}, \param{const wxString\& }{name = ``staticLine"}} + +Constructor, creating and showing a static line. + +\wxheading{Parameters} + +\docparam{parent}{Parent window. Must not be NULL.} + +\docparam{id}{Window identifier. A value of -1 indicates a default value.} + +\docparam{pos}{Window position. If the position (-1, -1) is specified then a default position is chosen.} + +\docparam{size}{Size. Note that either the height or the width (depending on +whether the line if horizontal or vertical) is ignored.} + +\docparam{style}{Window style (either wxLI\_HORIZONTAL or wxLI\_VERTICAL).} + +\docparam{name}{Window name.} + +\wxheading{See also} + +\helpref{wxStaticLine::Create}{wxstaticlinecreate} + +\membersection{wxStaticLine::Create}\label{wxstaticlinecreate} + +\func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID }{id}, \param{const wxString\& }{label},\rtfsp +\param{const wxPoint\&}{ pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp +\param{long}{ style = 0}, \param{const wxString\& }{name = ``staticLine"}} + +Creates the static line for two-step construction. See \helpref{wxStaticLine::wxStaticLine}{wxstaticlinector}\rtfsp +for further details. + +\membersection{wxStaticLine::IsVertical}\label{wxstaticlineisvertical} + +\constfunc{bool}{IsVertical}{\void} + +Returns TRUE if the line is vertical, FALSE if horizontal. + +\membersection{wxStaticLine::GetDefaultSize}\label{wxstaticlinegetdefaultsize} + +\func{int}{GetDefaultSize}{\void} + +This static function returns the size which will be given to the "lesser" +dimension of the static line, i.e. its height for a horizontal line or its +width for a vertical one. diff --git a/include/wx/tipdlg.h b/include/wx/tipdlg.h new file mode 100644 index 0000000000..9b02046705 --- /dev/null +++ b/include/wx/tipdlg.h @@ -0,0 +1,83 @@ +/////////////////////////////////////////////////////////////////////////////// +// Name: 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_ + +#ifdef __GNUG__ + #pragma interface "tipdlg.h" +#endif + +// ---------------------------------------------------------------------------- +// 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 WXDLLEXPORT 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; } + + // 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! +WXDLLEXPORT wxTipProvider *wxCreateFileTipProvider(const wxString& filename, + size_t currentTip); + +// ---------------------------------------------------------------------------- +// 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. +WXDLLEXPORT bool wxShowTip(wxWindow *parent, + wxTipProvider *tipProvider, + bool showAtStartup = TRUE); + +#endif // wxUSE_STARTUP_TIPS + +#endif // _WX_TIPDLG_H_ -- 2.47.2