AirTV-Qt/qtsingleapplication/examples/trivial/trivial.qdoc

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
   4 ** All rights reserved.
   5 **
   6 ** Contact: Nokia Corporation (qt-info@nokia.com)
   7 **
   8 ** This file is part of a Qt Solutions component.
   9 **
  10 ** You may use this file under the terms of the BSD license as follows:
  11 **
  12 ** "Redistribution and use in source and binary forms, with or without
  13 ** modification, are permitted provided that the following conditions are
  14 ** met:
  15 **   * Redistributions of source code must retain the above copyright
  16 **     notice, this list of conditions and the following disclaimer.
  17 **   * Redistributions in binary form must reproduce the above copyright
  18 **     notice, this list of conditions and the following disclaimer in
  19 **     the documentation and/or other materials provided with the
  20 **     distribution.
  21 **   * Neither the name of Nokia Corporation and its Subsidiary(-ies) nor
  22 **     the names of its contributors may be used to endorse or promote
  23 **     products derived from this software without specific prior written
  24 **     permission.
  25 **
  26 ** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  27 ** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  28 ** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  29 ** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  30 ** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  31 ** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  32 ** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  33 ** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  34 ** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  35 ** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  36 ** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."
  37 **
  38 ****************************************************************************/
  39
  40 /*! \page qtsingleapplication-example-trivial.html
  41     \title A Trivial Example
  42
  43     The application in this example has a log-view that displays
  44     messages sent by further instances of the same application.
  45
  46     The example demonstrates the use of the QtSingleApplication
  47     class to detect and communicate with a running instance of
  48     the application using the sendMessage() API. The messageReceived()
  49     signal is used to display received messages in a QTextEdit log.
  50
  51     \quotefromfile trivial/main.cpp
  52     \printuntil instance
  53     The example has only the \c main entry point function.
  54     A QtSingleApplication object is created immediately.
  55
  56     \printuntil return
  57     If another instance of this application is already running,
  58     sendMessage() will succeed, and this instance just exits
  59     immediately.
  60
  61     \printuntil show()
  62     Otherwise the instance continues as normal and creates the
  63     user interface.
  64
  65     \printuntil return instance.exec();
  66     The \c logview object is also set as the application's activation
  67     window. Every time a message is received, the window will be raised
  68     and activated automatically.
  69
  70     The messageReceived() signal is also connected to the QTextEdit's
  71     append() slot. Every message received from further instances of
  72     this application will be displayed in the log.
  73
  74     Finally the event loop is entered.
  75 */