Add a LICENSE file and cleanup README.md a bit
[deb_shairplay.git] / AirTV-Qt / qtsingleapplication / examples / loader / loader.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-loader.html
41 \title Loading Documents
42
43 The application in this example loads or prints the documents
44 passed as commandline parameters to further instances of this
45 application.
46
47 \quotefromfile loader/main.cpp
48 \printuntil };
49 The user interface in this application is a QMainWindow subclass
50 with a QMdiArea as the central widget. It implements a slot
51 \c handleMessage() that will be connected to the messageReceived()
52 signal of the QtSingleApplication class.
53
54 \printuntil }
55 The MainWindow constructor creates a minimal user interface.
56
57 \printto case Print:
58 The handleMessage() slot interprets the message passed in as a
59 filename that can be prepended with \e /print to indicate that
60 the file should just be printed rather than loaded.
61
62 \printto #include
63 Loading the file will also activate the window.
64
65 \printto mw
66 The \c main entry point function creates a QtSingleApplication
67 object, and creates a message to send to a running instance
68 of the application. If the message was sent successfully the
69 process exits immediately.
70
71 \printuntil }
72 If the message could not be sent the application starts up. Note
73 that \c false is passed to the call to setActivationWindow() to
74 prevent automatic activation for every message received, e.g. when
75 the application should just print a file. Instead, the message
76 handling function determines whether activation is requested, and
77 signals that by emitting the needToShow() signal. This is then
78 simply connected directly to QtSingleApplication's
79 activateWindow() slot.
80 */