docs/latex/wx/notifmsg.tex

   1 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   2 %% Name:        notifmsg.tex
   3 %% Purpose:     wxNotificationMessage documentation
   4 %% Author:      Vadim Zeitlin
   5 %% Created:     2007-11-24
   6 %% RCS-ID:      $Id: cmdlpars.tex 49199 2007-10-17 17:32:16Z VZ $
   7 %% Copyright:   (c) 2007 Vadim Zeitlin <vadim@wxwidgets.org>
   8 %% License:     wxWindows license
   9 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  10
  11 \section{\class{wxNotificationMessage}}\label{wxnotificationmessage}
  12
  13 This class allows to show the user a message non intrusively. Currently it is
  14 implemented natively only for the Maemo platform and uses (non-modal) dialogs
  15 for the display of the notifications under the other platforms but it will be
  16 extended to use the platform-specific notifications in the other ports in the
  17 future.
  18
  19 Notice that this class is not a window and so doesn't derive from wxWindow.
  20
  21 \wxheading{Derived from}
  22
  23 \helpref{wxEvtHandler}{wxevthandler}
  24
  25 \wxheading{Include files}
  26
  27 <wx/notifmsg.h>
  28
  29 \latexignore{\rtfignore{\wxheading{Members}}}
  30
  31
  32 \membersection{wxNotificationMessage::wxNotificationMessage}\label{wxnotificationmessagewxnotificationmessage}
  33
  34 \func{}{wxNotificationMessage}{\void}
  35
  36 Default constructor, use \helpref{SetParent}{\wxnotificationmessagesetparent},
  37 \helpref{SetTitle}{wxnotificationmessagesettitle} and
  38 \helpref{SetMessage}{wxnotificationmessagesetmessage} to initialize the object
  39 before showing it.
  40
  41
  42 \func{}{wxNotificationMessage}{\param{const wxString\& }{title}, \param{const wxString\& }{message = wxString()}, \param{wxWindow* }{parent = NULL}}
  43
  44 Create a notification object with the given title and message (the
  45 latter may be empty in which case only the title will be shown).
  46
  47
  48 \membersection{wxNotificationMessage::Close}\label{wxnotificationmessageclose}
  49
  50 \func{bool}{Close}{\void}
  51
  52 Hides the notification.
  53
  54 Returns \true if it was hidden or \false if it couldn't be done (e.g. on some
  55 systems automatically hidden notifications can't be hidden manually)
  56
  57
  58 \membersection{wxNotificationMessage::SetMessage}\label{wxnotificationmessagesetmessage}
  59
  60 \func{void}{SetMessage}{\param{const wxString\& }{message}}
  61
  62 Set the main text of the notification.
  63
  64
  65 \membersection{wxNotificationMessage::SetParent}\label{wxnotificationmessagesetparent}
  66
  67 \func{void}{SetParent}{\param{wxWindow* }{parent}}
  68
  69 Set the parent for this notification: the notification will be associated with
  70 the top level parent of this window or, if this method is not called, with the
  71 main application window by default
  72
  73
  74 \membersection{wxNotificationMessage::SetTitle}\label{wxnotificationmessagesettitle}
  75
  76 \func{void}{SetTitle}{\param{const wxString\& }{title}}
  77
  78 Set the title, it must be a concise string, use
  79 \helpref{SetMessage}{wxnotificationmessagesetmessage} to give the user more
  80 details.
  81
  82
  83 \membersection{wxNotificationMessage::Show}\label{wxnotificationmessageshow}
  84
  85 \func{bool}{Show}{\param{int }{timeout = Timeout\_Auto}}
  86
  87 Show the notification to the user and hides it after timeout seconds
  88 pass. Special values \texttt{Timeout\_Auto} and \texttt{Timeout\_Never} can be
  89 used here, notice that you shouldn't rely on \arg{timeout} being exactly
  90 respected because the current platform may only support default timeout value
  91 and also because the user may be able to close the notification.
  92
  93 Returns \false if an error occurred.
  94