added a helper function to show the popup menu allowing to configure the columns...

[wxWidgets.git] / src / generic / tipdlg.cpp

diff --git a/src/generic/tipdlg.cpp b/src/generic/tipdlg.cpp
index 1b04b10df8bf9278a128273a6a0ff2d16d43fd7c..7b3ce8b0b72468cc93d419ed90d0ef99bb8b64ca 100644 (file)
--- a/src/generic/tipdlg.cpp
+++ b/src/generic/tipdlg.cpp
@@ -1,5 +1,5 @@
 ///////////////////////////////////////////////////////////////////////////////
 ///////////////////////////////////////////////////////////////////////////////

-// Name:        tipdlg.cpp
+// Name:        src/generic/tipdlg.cpp

 // Purpose:     implementation of wxTipDialog
 // Author:      Vadim Zeitlin
 // Modified by:
 // Purpose:     implementation of wxTipDialog
 // Author:      Vadim Zeitlin
 // Modified by:


@@ -17,10 +17,6 @@
 // headers
 // ----------------------------------------------------------------------------
 
 // headers
 // ----------------------------------------------------------------------------
 

-#ifdef __GNUG__
-    #pragma implementation "tipdlg.h"
-#endif
-

 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 


@@ -34,16 +30,18 @@
     #include "wx/button.h"
     #include "wx/checkbox.h"
     #include "wx/statbox.h"
     #include "wx/button.h"
     #include "wx/checkbox.h"
     #include "wx/statbox.h"

-    #include "wx/statbmp.h"

     #include "wx/dialog.h"
     #include "wx/icon.h"
     #include "wx/intl.h"
     #include "wx/dialog.h"
     #include "wx/icon.h"
     #include "wx/intl.h"

-    #include "wx/layout.h"
-    #include "wx/settings.h"

     #include "wx/textctrl.h"
     #include "wx/textctrl.h"

+    #include "wx/statbmp.h"
+    #include "wx/stattext.h"
+    #include "wx/sizer.h"
+    #include "wx/settings.h"

 #endif // WX_PRECOMP
 
 #include "wx/statline.h"
 #endif // WX_PRECOMP
 
 #include "wx/statline.h"

+#include "wx/artprov.h"

 
 #include "wx/tipdlg.h"
 
 
 #include "wx/tipdlg.h"
 


@@ -51,7 +49,21 @@
 // constants
 // ----------------------------------------------------------------------------
 
 // constants
 // ----------------------------------------------------------------------------
 

-static const int wxID_NEXT_TIP = -100;  // whatever
+static const int wxID_NEXT_TIP = 32000;  // whatever
+
+// ---------------------------------------------------------------------------
+// macros
+// ---------------------------------------------------------------------------
+
+/* Macro for avoiding #ifdefs when value have to be different depending on size of
+   device we display on - take it from something like wxDesktopPolicy in the future
+ */
+
+#if defined(__SMARTPHONE__)
+    #define wxLARGESMALL(large,small) small
+#else
+    #define wxLARGESMALL(large,small) large
+#endif

 
 // ----------------------------------------------------------------------------
 // private classes
 
 // ----------------------------------------------------------------------------
 // private classes


@@ -59,7 +71,8 @@ static const int wxID_NEXT_TIP = -100;  // whatever
 
 // an implementation which takes the tips from the text file - each line
 // represents a tip
 
 // an implementation which takes the tips from the text file - each line
 // represents a tip

-class WXDLLEXPORT wxFileTipProvider : public wxTipProvider
+#if wxUSE_TEXTFILE
+class WXDLLIMPEXP_ADV wxFileTipProvider : public wxTipProvider

 {
 public:
     wxFileTipProvider(const wxString& filename, size_t currentTip);
 {
 public:
     wxFileTipProvider(const wxString& filename, size_t currentTip);


@@ -68,11 +81,14 @@ public:
 
 private:
     wxTextFile m_textfile;
 
 private:
     wxTextFile m_textfile;

+
+    DECLARE_NO_COPY_CLASS(wxFileTipProvider)

 };
 };

+#endif // wxUSE_TEXTFILE

 
 #ifdef __WIN32__
 // TODO an implementation which takes the tips from the given registry key
 
 #ifdef __WIN32__
 // TODO an implementation which takes the tips from the given registry key

-class WXDLLEXPORT wxRegTipProvider : public wxTipProvider
+class WXDLLIMPEXP_ADV wxRegTipProvider : public wxTipProvider

 {
 public:
     wxRegTipProvider(const wxString& keyname);
 {
 public:
     wxRegTipProvider(const wxString& keyname);


@@ -83,20 +99,20 @@ public:
 // Empty implementation for now to keep the linker happy
 wxString wxRegTipProvider::GetTip()
 {
 // Empty implementation for now to keep the linker happy
 wxString wxRegTipProvider::GetTip()
 {

-    return "";
+    return wxEmptyString;

 }
 
 #endif // __WIN32__
 
 // the dialog we show in wxShowTip()
 }
 
 #endif // __WIN32__
 
 // the dialog we show in wxShowTip()

-class WXDLLEXPORT wxTipDialog : public wxDialog
+class WXDLLIMPEXP_ADV wxTipDialog : public wxDialog

 {
 public:
     wxTipDialog(wxWindow *parent,
                 wxTipProvider *tipProvider,
                 bool showAtStartup);
 
 {
 public:
     wxTipDialog(wxWindow *parent,
                 wxTipProvider *tipProvider,
                 bool showAtStartup);
 

-    // the tip dialog has "Show tips on startup" checkbox - return TRUE if it
+    // the tip dialog has "Show tips on startup" checkbox - return true if it

     // was checked (or wasn't unchecked)
     bool ShowTipsOnStartup() const { return m_checkbox->GetValue(); }
 
     // was checked (or wasn't unchecked)
     bool ShowTipsOnStartup() const { return m_checkbox->GetValue(); }
 


@@ -113,6 +129,7 @@ private:
     wxCheckBox *m_checkbox;
 
     DECLARE_EVENT_TABLE()
     wxCheckBox *m_checkbox;
 
     DECLARE_EVENT_TABLE()

+    DECLARE_NO_COPY_CLASS(wxTipDialog)

 };
 
 // ============================================================================
 };
 
 // ============================================================================


@@ -122,7 +139,7 @@ private:
 // ----------------------------------------------------------------------------
 // wxFileTipProvider
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // wxFileTipProvider
 // ----------------------------------------------------------------------------

-
+#if wxUSE_TEXTFILE

 wxFileTipProvider::wxFileTipProvider(const wxString& filename,
                                      size_t currentTip)
                  : wxTipProvider(currentTip), m_textfile(filename)
 wxFileTipProvider::wxFileTipProvider(const wxString& filename,
                                      size_t currentTip)
                  : wxTipProvider(currentTip), m_textfile(filename)


@@ -134,129 +151,193 @@ wxString wxFileTipProvider::GetTip()
 {
     size_t count = m_textfile.GetLineCount();
     if ( !count )
 {
     size_t count = m_textfile.GetLineCount();
     if ( !count )

+    {

         return _("Tips not available, sorry!");
         return _("Tips not available, sorry!");

+    }
+
+    wxString tip;

 
 

-    // notice that it may be greater, actually, if we remembered it from the
-    // last time and the number of tips changed
-    if ( m_currentTip == count )
+    // Comments start with a # symbol.
+    // Loop reading lines until get the first one that isn't a comment.
+    // The max number of loop executions is the number of lines in the
+    // textfile so that can't go into an eternal loop in the [oddball]
+    // case of a comment-only tips file, or the developer has vetoed
+    // them all via PreprecessTip().
+    for ( size_t i=0; i < count; i++ )

     {
     {

-        // wrap
-        m_currentTip = 0;
+        // The current tip may be at the last line of the textfile, (or
+        // past it, if the number of lines in the textfile changed, such
+        // as changing to a different textfile, with less tips). So check
+        // to see at last line of text file, (or past it)...
+        if ( m_currentTip >= count )
+        {
+            // .. and if so, wrap back to line 0.
+            m_currentTip = 0;
+        }
+
+        // Read the tip, and increment the current tip counter.
+        tip = m_textfile.GetLine(m_currentTip++);
+
+        // Allow a derived class's overrided virtual to modify the tip
+        // now if so desired.
+        tip = PreprocessTip(tip);
+
+        // Break if tip isn't a comment, and isn't an empty string
+        // (or only stray space characters).
+        if ( !tip.StartsWith(wxT("#")) && (tip.Trim() != wxEmptyString) )
+        {
+            break;
+        }

     }
 
     }
 

-    return m_textfile.GetLine(m_currentTip++);
+    // If tip starts with '_(', then it is a gettext string of format
+    // _("My \"global\" tip text") so first strip off the leading '_("'...
+    if ( tip.StartsWith(wxT("_(\"" ), &tip))
+    {
+        //...and strip off the trailing '")'...
+        tip = tip.BeforeLast(wxT('\"'));
+        // ...and replace escaped quotes
+        tip.Replace(wxT("\\\""), wxT("\""));
+
+        // and translate it as requested
+        tip = wxGetTranslation(tip);
+    }
+
+    return tip;

 }
 }

+#endif // wxUSE_TEXTFILE

 
 // ----------------------------------------------------------------------------
 // wxTipDialog
 // ----------------------------------------------------------------------------
 
 BEGIN_EVENT_TABLE(wxTipDialog, wxDialog)
 
 // ----------------------------------------------------------------------------
 // wxTipDialog
 // ----------------------------------------------------------------------------
 
 BEGIN_EVENT_TABLE(wxTipDialog, wxDialog)

-    EVT_BUTTON(wxID_NEXT_TIP, OnNextTip)
+    EVT_BUTTON(wxID_NEXT_TIP, wxTipDialog::OnNextTip)

 END_EVENT_TABLE()
 
 wxTipDialog::wxTipDialog(wxWindow *parent,
                          wxTipProvider *tipProvider,
                          bool showAtStartup)
 END_EVENT_TABLE()
 
 wxTipDialog::wxTipDialog(wxWindow *parent,
                          wxTipProvider *tipProvider,
                          bool showAtStartup)

-           : wxDialog(parent, -1, _("Tip of the Day"),
+           : wxDialog(GetParentForModalDialog(parent), wxID_ANY, _("Tip of the Day"),

                       wxDefaultPosition, wxDefaultSize,
                       wxDefaultPosition, wxDefaultSize,

-                      wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER)
+                      wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER
+                      )

 {
     m_tipProvider = tipProvider;
 {
     m_tipProvider = tipProvider;

+    bool isPda = (wxSystemSettings::GetScreenType() <= wxSYS_SCREEN_PDA);

 
 

-    wxSize sizeBtn = GetStandardButtonSize();
-    wxLayoutConstraints *c;
+    // 1) create all controls in tab order

 
 

-    // create the controls in the right order, then set the constraints
-    wxButton *btnClose = new wxButton(this, wxID_CANCEL, _("&Close"));
-    m_checkbox = new wxCheckBox(this, -1, _("&Show tips at startup"));
-    wxButton *btnNext = new wxButton(this, wxID_NEXT_TIP, _("&Next"));
+    wxStaticText *text = new wxStaticText(this, wxID_ANY, _("Did you know..."));

 
 

-    wxTextCtrl *text = new wxTextCtrl(this, -1, _("Did you know..."),
-                                      wxDefaultPosition, wxDefaultSize,
-                                      wxTE_READONLY | wxNO_BORDER);
-    text->SetFont(wxFont(18, wxSWISS, wxNORMAL, wxBOLD));
-    text->SetBackgroundColour(wxSystemSettings::GetSystemColour(wxSYS_COLOUR_BTNFACE));
-
-    m_text = new wxTextCtrl(this, -1, _T(""),
-                            wxDefaultPosition, wxDefaultSize,
-                            wxTE_MULTILINE | wxTE_READONLY | wxSUNKEN_BORDER);
-    m_text->SetFont(wxFont(14, wxROMAN, wxNORMAL, wxNORMAL));
+    if (!isPda)
+    {
+        wxFont font = text->GetFont();
+        font.SetPointSize(int(1.6 * font.GetPointSize()));
+        font.SetWeight(wxFONTWEIGHT_BOLD);
+        text->SetFont(font);
+    }

 
 

-#ifdef __WXMSW__
-    wxIcon icon("wxICON_TIP");
-#else
-    #include "wx/generic/tip.xpm"
-    wxIcon icon(tipIcon);
+    m_text = new wxTextCtrl(this, wxID_ANY, wxEmptyString,
+                            wxDefaultPosition, wxSize(200, 160),
+                            wxTE_MULTILINE |
+                            wxTE_READONLY |
+                            wxTE_NO_VSCROLL |
+                            wxTE_RICH2 | // a hack to get rid of vert scrollbar
+                            wxDEFAULT_CONTROL_BORDER
+                            );
+#if defined(__WXMSW__)
+    m_text->SetFont(wxFont(12, wxSWISS, wxNORMAL, wxNORMAL));

 #endif
 
 #endif
 

-    wxStaticBitmap *bmp = new wxStaticBitmap(this, -1, icon);
-
-    const int iconSize = icon.GetWidth();
-
-    c = new wxLayoutConstraints;
-    c->top.SameAs(this, wxTop, 2*LAYOUT_Y_MARGIN);
-    c->left.RightOf(bmp, 2*LAYOUT_X_MARGIN);
-    c->right.SameAs(this, wxRight, 2*LAYOUT_X_MARGIN);
-    c->height.Absolute(2*text->GetSize().GetHeight());
-    text->SetConstraints(c);
-
-    c = new wxLayoutConstraints;
-    c->centreY.SameAs(text, wxCentreY);
-    c->left.SameAs(this, wxLeft, 2*LAYOUT_X_MARGIN);
-    c->width.Absolute(iconSize);
-    c->height.Absolute(iconSize);
-    bmp->SetConstraints(c);
-
-    c = new wxLayoutConstraints;
-    c->bottom.SameAs(this, wxBottom, 2*LAYOUT_X_MARGIN);
-    c->right.SameAs(this, wxRight, 2*LAYOUT_X_MARGIN);
-    c->width.Absolute(sizeBtn.GetWidth());
-    c->height.Absolute(sizeBtn.GetHeight());
-    btnClose->SetConstraints(c);
-
-    c = new wxLayoutConstraints;
-    c->bottom.SameAs(this, wxBottom, 2*LAYOUT_X_MARGIN);
-    c->right.LeftOf(btnClose, 2*LAYOUT_X_MARGIN);
-    c->width.Absolute(sizeBtn.GetWidth());
-    c->height.Absolute(sizeBtn.GetHeight());
-    btnNext->SetConstraints(c);
-
-    c = new wxLayoutConstraints;
-    c->bottom.SameAs(this, wxBottom, 2*LAYOUT_X_MARGIN);
-    c->left.SameAs(this, wxLeft, 2*LAYOUT_X_MARGIN);
-    c->width.AsIs();
-    c->height.AsIs();
-    m_checkbox->SetConstraints(c);
+//#if defined(__WXPM__)
+    //
+    // The only way to get icons into an OS/2 static bitmap control
+    //
+//    wxBitmap                        vBitmap;
+
+//    vBitmap.SetId(wxICON_TIP); // OS/2 specific bitmap method--OS/2 wxBitmaps all have an ID.
+//                               // and for StatBmp's under OS/2 it MUST be a valid resource ID.
+//
+//    wxStaticBitmap*                 bmp = new wxStaticBitmap(this, wxID_ANY, vBitmap);
+//
+//#else
+
+    wxIcon icon = wxArtProvider::GetIcon(wxART_TIP, wxART_CMN_DIALOG);
+    wxStaticBitmap *bmp = new wxStaticBitmap(this, wxID_ANY, icon);
+
+//#endif
+
+    m_checkbox = new wxCheckBox(this, wxID_ANY, _("&Show tips at startup"));

     m_checkbox->SetValue(showAtStartup);
     m_checkbox->SetValue(showAtStartup);

+    m_checkbox->SetFocus();
+
+    // smart phones does not support or do not waste space for wxButtons
+#ifndef __SMARTPHONE__
+    wxButton *btnNext = new wxButton(this, wxID_NEXT_TIP, _("&Next Tip"));
+#endif
+
+    // smart phones does not support or do not waste space for wxButtons
+#ifndef __SMARTPHONE__
+    wxButton *btnClose = new wxButton(this, wxID_CLOSE);
+    SetAffirmativeId(wxID_CLOSE);
+#endif
+

 
 

-    c = new wxLayoutConstraints;
-    c->top.Below(text);
-    c->left.SameAs(this, wxLeft, 2*LAYOUT_X_MARGIN);
-    c->right.SameAs(this, wxRight, 2*LAYOUT_X_MARGIN);
-    c->bottom.Above(btnClose, -2*LAYOUT_Y_MARGIN);
-    m_text->SetConstraints(c);
+    // 2) put them in boxes
+
+    wxBoxSizer *topsizer = new wxBoxSizer( wxVERTICAL );
+
+    wxBoxSizer *icon_text = new wxBoxSizer( wxHORIZONTAL );
+    icon_text->Add( bmp, 0, wxCENTER );
+    icon_text->Add( text, 1, wxCENTER | wxLEFT, wxLARGESMALL(20,0) );
+    topsizer->Add( icon_text, 0, wxEXPAND | wxALL, wxLARGESMALL(10,0) );
+
+    topsizer->Add( m_text, 1, wxEXPAND | wxLEFT|wxRIGHT, wxLARGESMALL(10,0) );
+
+    wxBoxSizer *bottom = new wxBoxSizer( wxHORIZONTAL );
+    if (isPda)
+        topsizer->Add( m_checkbox, 0, wxCENTER|wxTOP );
+    else
+        bottom->Add( m_checkbox, 0, wxCENTER );
+
+    // smart phones does not support or do not waste space for wxButtons
+#ifdef __SMARTPHONE__
+    SetRightMenu(wxID_NEXT_TIP, _("Next"));
+    SetLeftMenu(wxID_CLOSE);
+#else
+    if (!isPda)
+        bottom->Add( 10,10,1 );
+    bottom->Add( btnNext, 0, wxCENTER | wxLEFT, wxLARGESMALL(10,0) );
+    bottom->Add( btnClose, 0, wxCENTER | wxLEFT, wxLARGESMALL(10,0) );
+#endif
+
+    if (isPda)
+        topsizer->Add( bottom, 0, wxCENTER | wxALL, 5 );
+    else
+        topsizer->Add( bottom, 0, wxEXPAND | wxALL, wxLARGESMALL(10,0) );

 
     SetTipText();
 
 
     SetTipText();
 

-    Centre(wxBOTH | wxCENTER_FRAME);
+    SetSizer( topsizer );

 
 

-    wxSize size(5*sizeBtn.GetWidth(), 10*sizeBtn.GetHeight());
-    SetSize(size);
-    SetSizeHints(size.x, size.y);
+    topsizer->SetSizeHints( this );
+    topsizer->Fit( this );

 
 

-    SetAutoLayout(TRUE);
+    Centre(wxBOTH | wxCENTER_FRAME);

 }
 
 // ----------------------------------------------------------------------------
 // our public interface
 // ----------------------------------------------------------------------------
 
 }
 
 // ----------------------------------------------------------------------------
 // our public interface
 // ----------------------------------------------------------------------------
 

+#if wxUSE_TEXTFILE

 wxTipProvider *wxCreateFileTipProvider(const wxString& filename,
                                        size_t currentTip)
 {
     return new wxFileTipProvider(filename, currentTip);
 }
 wxTipProvider *wxCreateFileTipProvider(const wxString& filename,
                                        size_t currentTip)
 {
     return new wxFileTipProvider(filename, currentTip);
 }

+#endif // wxUSE_TEXTFILE

 
 bool wxShowTip(wxWindow *parent,
                wxTipProvider *tipProvider,
 
 bool wxShowTip(wxWindow *parent,
                wxTipProvider *tipProvider,


@@ -269,4 +350,3 @@ bool wxShowTip(wxWindow *parent,
 }
 
 #endif // wxUSE_STARTUP_TIPS
 }
 
 #endif // wxUSE_STARTUP_TIPS

-