docs/latex/wx/dialevt.tex

   1 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   2 %% Name:        dialevt.tex
   3 %% Purpose:     wxDialUpEvent documentation
   4 %% Author:      Vadim Zeitlin
   5 %% Modified by:
   6 %% Created:     08.04.00
   7 %% RCS-ID:      $Id$
   8 %% Copyright:   (c) Vadim Zeitlin
   9 %% License:     wxWindows license
  10 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  11
  12 \section{\class{wxDialUpEvent}}\label{wxdialupevent}
  13
  14 This is the event class for the dialup events sent by
  15 \helpref{wxDialUpManager}{wxdialupmanager}.
  16
  17 \wxheading{Derived from}
  18
  19 \helpref{wxEvent}{wxevent}\\
  20 \helpref{wxObject}{wxobject}
  21
  22 \wxheading{Include files}
  23
  24 <wx/dialup.h>
  25
  26 \latexignore{\rtfignore{\wxheading{Members}}}
  27
  28 \membersection{wxDialUpEvent::wxDialUpEvent}\label{wxdialupeventwxdialupevent}
  29
  30 \func{}{wxDialUpEvent}{\param{bool }{isConnected}, \param{bool }{isOwnEvent}}
  31
  32 Constructor is only used by \helpref{wxDialUpManager}{wxdialupmanager}.
  33
  34 \membersection{wxDialUpEvent::IsConnectedEvent}\label{wxdialupeventisconnectedevent}
  35
  36 \constfunc{bool}{IsConnectedEvent}{\void}
  37
  38 Is this a {\tt CONNECTED} or {\tt DISCONNECTED} event? In other words, does it
  39 notify about transition from offline to online state or vice versa?
  40
  41 \membersection{wxDialUpEvent::IsOwnEvent}\label{wxdialupeventisownevent}
  42
  43 \constfunc{bool}{IsOwnEvent}{\void}
  44
  45 Does this event come from wxDialUpManager::Dial() or from some extrenal
  46 process (i.e. does it result from our own attempt to establish the
  47 connection)?
  48