src/generic/tipdlg.cpp

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        tipdlg.cpp
   3 // Purpose:     implementation of wxTipDialog
   4 // Author:      Vadim Zeitlin
   5 // Modified by:
   6 // Created:     28.06.99
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Vadim Zeitlin
   9 // Licence:     wxWindows licence
  10 ///////////////////////////////////////////////////////////////////////////////
  11
  12 // ============================================================================
  13 // declarations
  14 // ============================================================================
  15
  16 // ----------------------------------------------------------------------------
  17 // headers
  18 // ----------------------------------------------------------------------------
  19
  20 #ifdef __GNUG__
  21     #pragma implementation "tipdlg.h"
  22 #endif
  23
  24 // For compilers that support precompilation, includes "wx.h".
  25 #include "wx/wxprec.h"
  26
  27 #ifdef __BORLANDC__
  28     #pragma hdrstop
  29 #endif
  30
  31 #if wxUSE_STARTUP_TIPS
  32
  33 #ifndef WX_PRECOMP
  34     #include "wx/button.h"
  35     #include "wx/checkbox.h"
  36     #include "wx/statbox.h"
  37     #include "wx/dialog.h"
  38     #include "wx/icon.h"
  39     #include "wx/intl.h"
  40     #include "wx/settings.h"
  41     #include "wx/textctrl.h"
  42     #include "wx/statbmp.h"
  43     #include "wx/stattext.h"
  44     #include "wx/sizer.h"
  45 #endif // WX_PRECOMP
  46
  47 #include "wx/statline.h"
  48 #include "wx/artprov.h"
  49
  50 #include "wx/tipdlg.h"
  51
  52 // ----------------------------------------------------------------------------
  53 // constants
  54 // ----------------------------------------------------------------------------
  55
  56 static const int wxID_NEXT_TIP = -100;  // whatever
  57
  58 // ----------------------------------------------------------------------------
  59 // private classes
  60 // ----------------------------------------------------------------------------
  61
  62 // an implementation which takes the tips from the text file - each line
  63 // represents a tip
  64 class WXDLLEXPORT wxFileTipProvider : public wxTipProvider
  65 {
  66 public:
  67     wxFileTipProvider(const wxString& filename, size_t currentTip);
  68
  69     virtual wxString GetTip();
  70
  71 private:
  72     wxTextFile m_textfile;
  73 };
  74
  75 #ifdef __WIN32__
  76 // TODO an implementation which takes the tips from the given registry key
  77 class WXDLLEXPORT wxRegTipProvider : public wxTipProvider
  78 {
  79 public:
  80     wxRegTipProvider(const wxString& keyname);
  81
  82     virtual wxString GetTip();
  83 };
  84
  85 // Empty implementation for now to keep the linker happy
  86 wxString wxRegTipProvider::GetTip()
  87 {
  88     return wxEmptyString;
  89 }
  90
  91 #endif // __WIN32__
  92
  93 // the dialog we show in wxShowTip()
  94 class WXDLLEXPORT wxTipDialog : public wxDialog
  95 {
  96 public:
  97     wxTipDialog(wxWindow *parent,
  98                 wxTipProvider *tipProvider,
  99                 bool showAtStartup);
 100
 101     // the tip dialog has "Show tips on startup" checkbox - return TRUE if it
 102     // was checked (or wasn't unchecked)
 103     bool ShowTipsOnStartup() const { return m_checkbox->GetValue(); }
 104
 105     // sets the (next) tip text
 106     void SetTipText() { m_text->SetValue(m_tipProvider->GetTip()); }
 107
 108     // "Next" button handler
 109     void OnNextTip(wxCommandEvent& WXUNUSED(event)) { SetTipText(); }
 110
 111 private:
 112     wxTipProvider *m_tipProvider;
 113
 114     wxTextCtrl *m_text;
 115     wxCheckBox *m_checkbox;
 116
 117     DECLARE_EVENT_TABLE()
 118 };
 119
 120 // ============================================================================
 121 // implementation
 122 // ============================================================================
 123
 124 // ----------------------------------------------------------------------------
 125 // wxFileTipProvider
 126 // ----------------------------------------------------------------------------
 127
 128 wxFileTipProvider::wxFileTipProvider(const wxString& filename,
 129                                      size_t currentTip)
 130                  : wxTipProvider(currentTip), m_textfile(filename)
 131 {
 132     m_textfile.Open();
 133 }
 134
 135 wxString wxFileTipProvider::GetTip()
 136 {
 137     size_t count = m_textfile.GetLineCount();
 138     if ( !count )
 139         return _("Tips not available, sorry!");
 140
 141     // notice that it may be greater, actually, if we remembered it from the
 142     // last time and the number of tips changed
 143     if ( m_currentTip == count )
 144     {
 145         // wrap
 146         m_currentTip = 0;
 147     }
 148
 149     return m_textfile.GetLine(m_currentTip++);
 150 }
 151
 152 // ----------------------------------------------------------------------------
 153 // wxTipDialog
 154 // ----------------------------------------------------------------------------
 155
 156 BEGIN_EVENT_TABLE(wxTipDialog, wxDialog)
 157     EVT_BUTTON(wxID_NEXT_TIP, wxTipDialog::OnNextTip)
 158 END_EVENT_TABLE()
 159
 160 wxTipDialog::wxTipDialog(wxWindow *parent,
 161                          wxTipProvider *tipProvider,
 162                          bool showAtStartup)
 163            : wxDialog(parent, -1, _("Tip of the Day"),
 164                       wxDefaultPosition, wxDefaultSize,
 165                       wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER)
 166 {
 167     m_tipProvider = tipProvider;
 168
 169     // 1) create all controls in tab order
 170
 171     wxButton *btnClose = new wxButton(this, wxID_CANCEL, _("&Close"));
 172
 173     m_checkbox = new wxCheckBox(this, -1, _("&Show tips at startup"));
 174     m_checkbox->SetValue(showAtStartup);
 175
 176     wxButton *btnNext = new wxButton(this, wxID_NEXT_TIP, _("&Next Tip"));
 177
 178     wxStaticText *text = new wxStaticText(this, -1, _("Did you know..."), wxDefaultPosition, wxSize(-1,30) );
 179 #if defined(__WXMSW__) || defined(__WXPM__)
 180     text->SetFont(wxFont(16, wxSWISS, wxNORMAL, wxBOLD));
 181 #else
 182     text->SetFont(wxFont(18, wxSWISS, wxNORMAL, wxBOLD));
 183 #endif
 184 //
 185 //    text->SetBackgroundColour(wxSystemSettings::GetColour(wxSYS_COLOUR_BTNFACE));
 186
 187     m_text = new wxTextCtrl(this, -1, wxT(""),
 188                             wxDefaultPosition, wxSize(200, 160),
 189                             wxTE_MULTILINE |
 190                             wxTE_READONLY |
 191                             wxTE_NO_VSCROLL |
 192                             wxTE_RICH | // a hack to get rid of vert scrollbar
 193                             wxSUNKEN_BORDER);
 194 #if defined(__WXMSW__)
 195     m_text->SetFont(wxFont(12, wxSWISS, wxNORMAL, wxNORMAL));
 196 #else
 197     m_text->SetFont(wxFont(14, wxSWISS, wxNORMAL, wxNORMAL));
 198 #endif
 199
 200 #if defined(__WXPM__)
 201     //
 202     // The only way to get icons into an OS/2 static bitmap control
 203     //
 204     wxBitmap                        vBitmap;
 205
 206     vBitmap.SetId(wxICON_TIP); // OS/2 specific bitmap method--OS/2 wxBitmaps all have an ID.
 207                                // and for StatBmp's under OS/2 it MUST be a valid resource ID.
 208
 209     wxStaticBitmap*                 bmp = new wxStaticBitmap(this, -1, vBitmap);
 210
 211 #else
 212
 213     wxIcon icon = wxArtProvider::GetIcon(wxART_TIP, wxART_CMN_DIALOG);
 214     wxStaticBitmap *bmp = new wxStaticBitmap(this, -1, icon);
 215
 216 #endif
 217
 218     // 2) put them in boxes
 219
 220     wxBoxSizer *topsizer = new wxBoxSizer( wxVERTICAL );
 221
 222     wxBoxSizer *icon_text = new wxBoxSizer( wxHORIZONTAL );
 223     icon_text->Add( bmp, 0, wxCENTER );
 224     icon_text->Add( text, 1, wxCENTER | wxLEFT, 20 );
 225     topsizer->Add( icon_text, 0, wxEXPAND | wxALL, 10 );
 226
 227     topsizer->Add( m_text, 1, wxEXPAND | wxLEFT|wxRIGHT, 10 );
 228
 229     wxBoxSizer *bottom = new wxBoxSizer( wxHORIZONTAL );
 230     bottom->Add( m_checkbox, 0, wxCENTER );
 231     bottom->Add( 10,10,1 );
 232     bottom->Add( btnNext, 0, wxCENTER | wxLEFT, 10 );
 233     bottom->Add( btnClose, 0, wxCENTER | wxLEFT, 10 );
 234     topsizer->Add( bottom, 0, wxEXPAND | wxALL, 10 );
 235
 236     SetTipText();
 237
 238     SetAutoLayout(TRUE);
 239     SetSizer( topsizer );
 240
 241     topsizer->SetSizeHints( this );
 242     topsizer->Fit( this );
 243
 244     Centre(wxBOTH | wxCENTER_FRAME);
 245
 246 }
 247
 248 // ----------------------------------------------------------------------------
 249 // our public interface
 250 // ----------------------------------------------------------------------------
 251
 252 wxTipProvider *wxCreateFileTipProvider(const wxString& filename,
 253                                        size_t currentTip)
 254 {
 255     return new wxFileTipProvider(filename, currentTip);
 256 }
 257
 258 bool wxShowTip(wxWindow *parent,
 259                wxTipProvider *tipProvider,
 260                bool showAtStartup)
 261 {
 262     wxTipDialog dlg(parent, tipProvider, showAtStartup);
 263     dlg.ShowModal();
 264
 265     return dlg.ShowTipsOnStartup();
 266 }
 267
 268 #endif // wxUSE_STARTUP_TIPS
 269