]> git.saurik.com Git - wxWidgets.git/blobdiff - interface/notifmsg.h
mac paths updated
[wxWidgets.git] / interface / notifmsg.h
index 78a3c0ca0b333e02aef4760751799f26c9140d3e..ecc14510e9d9a69958ecf27e74b1bfd17994b9ea 100644 (file)
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        notifmsg.h
-// Purpose:     documentation for wxNotificationMessage class
+// Purpose:     interface of wxNotificationMessage
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
@@ -9,15 +9,15 @@
 /**
     @class wxNotificationMessage
     @wxheader{notifmsg.h}
-    
+
     This class allows to show the user a message non intrusively. Currently it is
     implemented natively only for the Maemo platform and uses (non-modal) dialogs
     for the display of the notifications under the other platforms but it will be
     extended to use the platform-specific notifications in the other ports in the
     future.
-    
+
     Notice that this class is not a window and so doesn't derive from wxWindow.
-    
+
     @library{wxbase}
     @category{FIXME}
 */
@@ -27,22 +27,19 @@ public:
     //@{
     /**
         , @b wxWindow*@e parent = @NULL, @b int@e flags = @c wxICON_INFORMATION)
-        
         Create a notification object with the given attributes.
-        
-        See SetTitle(), 
-        SetMessage(), 
+        See SetTitle(),
+        SetMessage(),
         SetParent() and
         SetFlags() for the description of the
         corresponding parameters.
     */
     wxNotificationMessage();
-        wxNotificationMessage(const wxString& title);
+    wxNotificationMessage(const wxString& title);
     //@}
 
     /**
         Hides the notification.
-        
         Returns @true if it was hidden or @false if it couldn't be done (e.g. on
         some
         systems automatically hidden notifications can't be hidden manually)
@@ -51,10 +48,9 @@ public:
 
     /**
         This parameter can be currently used to specify the icon to show in the
-        notification. Valid values are @c wxICON_INFORMATION, 
-        @c wxICON_WARNING and @c wxICON_ERROR (notice that 
+        notification. Valid values are @c wxICON_INFORMATION,
+        @c wxICON_WARNING and @c wxICON_ERROR (notice that
         @c wxICON_QUESTION is not allowed here).
-        
         Some implementations of this class may not support the icons.
     */
     void SetFlags(int flags);
@@ -74,7 +70,7 @@ public:
     void SetParent(wxWindow* parent);
 
     /**
-        Set the title, it must be a concise string (not more than 64 characters), use 
+        Set the title, it must be a concise string (not more than 64 characters), use
         SetMessage() to give the user more
         details.
     */
@@ -83,11 +79,11 @@ public:
     /**
         Show the notification to the user and hides it after timeout seconds
         pass. Special values @c Timeout_Auto and @c Timeout_Never can be
-        used here, notice that you shouldn't rely on @e timeout being exactly
+        used here, notice that you shouldn't rely on @a timeout being exactly
         respected because the current platform may only support default timeout value
         and also because the user may be able to close the notification.
-        
         Returns @false if an error occurred.
     */
     bool Show(int timeout = Timeout_Auto);
 };
+