implemented wxNotificationMessage for wxMSW using wxTaskBarIcon and fallback to generic implementation on older systems; added wxNotificationMessage::SetFlags()

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@50429 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

include/wx/generic/notifmsg.h

@@ -1,6 +1,6 @@
 ///////////////////////////////////////////////////////////////////////////////
 // Name:        wx/generic/notifmsg.h
-// Purpose:     generic implementation of wxNotificationMessage
+// Purpose:     generic implementation of wxGenericNotificationMessage
 // Author:      Vadim Zeitlin
 // Created:     2007-11-24
 // RCS-ID:      $Id$
@@ -14,22 +14,22 @@
 class wxNotificationMessageDialog;
 
 // ----------------------------------------------------------------------------
-// wxNotificationMessage
+// wxGenericNotificationMessage
 // ----------------------------------------------------------------------------
 
-class WXDLLIMPEXP_ADV wxNotificationMessage : public wxNotificationMessageBase
+class WXDLLIMPEXP_ADV wxGenericNotificationMessage : public wxNotificationMessageBase
 {
 public:
-    wxNotificationMessage() { Init(); }
-    wxNotificationMessage(const wxString& title,
-                          const wxString& message = wxString(),
-                          wxWindow *parent = NULL)
+    wxGenericNotificationMessage() { Init(); }
+    wxGenericNotificationMessage(const wxString& title,
+                                 const wxString& message = wxString(),
+                                 wxWindow *parent = NULL)
         : wxNotificationMessageBase(title, message, parent)
     {
         Init();
     }
 
-    virtual ~wxNotificationMessage();
+    virtual ~wxGenericNotificationMessage();
 
 
     virtual bool Show(int timeout = Timeout_Auto);
@@ -53,7 +53,7 @@ private:
     wxNotificationMessageDialog *m_dialog;
 
 
-    DECLARE_NO_COPY_CLASS(wxNotificationMessage)
+    DECLARE_NO_COPY_CLASS(wxGenericNotificationMessage)
 };
 
 #endif // _WX_GENERIC_NOTIFMSG_H_

include/wx/msw/notifmsg.h

@@ -0,0 +1,64 @@
+///////////////////////////////////////////////////////////////////////////////
+// Name:        wx/msw/notifmsg.h
+// Purpose:     implementation of wxNotificationMessage for Windows
+// Author:      Vadim Zeitlin
+// Created:     2007-12-01
+// RCS-ID:      $Id$
+// Copyright:   (c) 2007 Vadim Zeitlin <vadim@wxwindows.org>
+// Licence:     wxWindows licence
+///////////////////////////////////////////////////////////////////////////////
+
+#ifndef _WX_MSW_NOTIFMSG_H_
+#define _WX_MSW_NOTIFMSG_H_
+
+class WXDLLIMPEXP_FWD_ADV wxTaskBarIcon;
+
+// ----------------------------------------------------------------------------
+// wxNotificationMessage
+// ----------------------------------------------------------------------------
+
+class WXDLLIMPEXP_ADV wxNotificationMessage : public wxNotificationMessageBase
+{
+public:
+    wxNotificationMessage() { Init(); }
+    wxNotificationMessage(const wxString& title,
+                          const wxString& message = wxString(),
+                          wxWindow *parent = NULL)
+        : wxNotificationMessageBase(title, message, parent)
+    {
+        Init();
+    }
+
+    virtual ~wxNotificationMessage();
+
+
+    virtual bool Show(int timeout = Timeout_Auto);
+    virtual bool Close();
+
+    // MSW implementation-specific methods
+
+    // by default, wxNotificationMessage under MSW creates a temporary taskbar
+    // icon to which it attaches the notification, if there is an existing
+    // taskbar icon object in the application you may want to call this method
+    // to attach the notification to it instead (we won't take ownership of it
+    // and you can also pass NULL to not use the icon for notifications any
+    // more)
+    //
+    // returns the task bar icon which was used previously (may be NULL)
+    static wxTaskBarIcon *UseTaskBarIcon(wxTaskBarIcon *icon);
+
+private:
+    // common part of all ctors
+    void Init() { m_impl = NULL; }
+
+
+    // the real implementation of this class (selected during run-time because
+    // the balloon task bar icons are not available in all Windows versions)
+    class wxNotifMsgImpl *m_impl;
+
+
+    DECLARE_NO_COPY_CLASS(wxNotificationMessage)
+};
+
+#endif // _WX_MSW_NOTIFMSG_H_
+

include/wx/notifmsg.h

@@ -28,17 +28,23 @@ public:
     // ----------------------
 
     // default ctor, use setters below to initialize it later
-    wxNotificationMessageBase() { }
+    wxNotificationMessageBase()
+    {
+        m_parent = NULL;
+        m_flags = wxICON_INFORMATION;
+    }
 
     // create a notification object with the given title and message (the
     // latter may be empty in which case only the title will be shown)
     wxNotificationMessageBase(const wxString& title,
                               const wxString& message = wxString(),
-                              wxWindow *parent = NULL)
+                              wxWindow *parent = NULL,
+                              int flags = wxICON_INFORMATION)
         : m_title(title),
           m_message(message),
           m_parent(parent)
     {
+        SetFlags(flags);
     }
 
     // note that the setters must be called before Show()
@@ -55,6 +61,18 @@ public:
     // main application window by default
     void SetParent(wxWindow *parent) { m_parent = parent; }
 
+    // this method can currently be used to choose a standard icon to use: the
+    // parameter may be one of wxICON_INFORMATION, wxICON_WARNING or
+    // wxICON_ERROR only (but not wxICON_QUESTION)
+    void SetFlags(int flags)
+    {
+        wxASSERT_MSG( flags == wxICON_INFORMATION ||
+                        flags == wxICON_WARNING || flags == wxICON_ERROR,
+                            "Invalid icon flags specified" );
+
+        m_flags = flags;
+    }
+
 
     // showing and hiding
     // ------------------
@@ -82,6 +100,7 @@ protected:
     const wxString& GetTitle() const { return m_title; }
     const wxString& GetMessage() const { return m_message; }
     wxWindow *GetParent() const { return m_parent; }
+    int GetFlags() const { return m_flags; }
 
     // return the concatenation of title and message separated by a new line,
     // this is suitable for simple implementation which have no support for
@@ -103,26 +122,35 @@ private:
 
     wxWindow *m_parent;
 
+    int m_flags;
+
     DECLARE_NO_COPY_CLASS(wxNotificationMessageBase)
 };
 
-#define wxUSE_GENERIC_NOTIFICATION_MESSAGE 1
-
 #if defined(__WXGTK__) && wxUSE_LIBHILDON
-    // we always use the native implementation in Hildon while the other ports
-    // will fall back to the generic one even if they have a native version too
-    #undef wxUSE_GENERIC_NOTIFICATION_MESSAGE
-    #define wxUSE_GENERIC_NOTIFICATION_MESSAGE 0
-
     #include "wx/gtk/hildon/notifmsg.h"
 /*
     TODO: provide support for
         - libnotify (Gnome)
-        - Snarl (http://www.fullphat.net/, Win32)
         - Growl (http://growl.info/, OS X)
  */
+#elif defined(__WXMSW__) && wxUSE_TASKBARICON
+    #include "wx/msw/notifmsg.h"
 #else
     #include "wx/generic/notifmsg.h"
+
+    class wxNotificationMessage : public wxGenericNotificationMessage
+    {
+    public:
+        wxNotificationMessage() { }
+        wxNotificationMessage(const wxString& title,
+                              const wxString& message = wxString(),
+                              wxWindow *parent = NULL,
+                              int flags = wxICON_INFORMATION)
+            : wxGenericNotificationMessage(title, message, parent, flags)
+        {
+        }
+    };
 #endif
 
 #endif // wxUSE_NOTIFICATION_MESSAGE