doc/src/frameworks-technologies/desktop-integration.qdoc
branchRCL_3
changeset 7 3f74d0d4af4c
equal deleted inserted replaced
6:dee5afe5301f 7:3f74d0d4af4c
       
     1 /****************************************************************************
       
     2 **
       
     3 ** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
       
     4 ** All rights reserved.
       
     5 ** Contact: Nokia Corporation (qt-info@nokia.com)
       
     6 **
       
     7 ** This file is part of the documentation of the Qt Toolkit.
       
     8 **
       
     9 ** $QT_BEGIN_LICENSE:LGPL$
       
    10 ** No Commercial Usage
       
    11 ** This file contains pre-release code and may not be distributed.
       
    12 ** You may use this file in accordance with the terms and conditions
       
    13 ** contained in the Technology Preview License Agreement accompanying
       
    14 ** this package.
       
    15 **
       
    16 ** GNU Lesser General Public License Usage
       
    17 ** Alternatively, this file may be used under the terms of the GNU Lesser
       
    18 ** General Public License version 2.1 as published by the Free Software
       
    19 ** Foundation and appearing in the file LICENSE.LGPL included in the
       
    20 ** packaging of this file.  Please review the following information to
       
    21 ** ensure the GNU Lesser General Public License version 2.1 requirements
       
    22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
       
    23 **
       
    24 ** In addition, as a special exception, Nokia gives you certain additional
       
    25 ** rights.  These rights are described in the Nokia Qt LGPL Exception
       
    26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
       
    27 **
       
    28 ** If you have questions regarding the use of this file, please contact
       
    29 ** Nokia at qt-info@nokia.com.
       
    30 **
       
    31 **
       
    32 **
       
    33 **
       
    34 **
       
    35 **
       
    36 **
       
    37 **
       
    38 ** $QT_END_LICENSE$
       
    39 **
       
    40 ****************************************************************************/
       
    41 
       
    42 /*!
       
    43     \group desktop
       
    44     \title Desktop Integration Classes
       
    45 */
       
    46 
       
    47 /*!
       
    48     \page desktop-integration.html
       
    49     \title Desktop Integration
       
    50     \brief Integrating with the user's desktop environment.
       
    51     
       
    52     \ingroup best-practices
       
    53 
       
    54     Qt applications behave well in the user's desktop environment, but certain
       
    55     integrations require additional, and sometimes platform specific, techniques.
       
    56 
       
    57     \tableofcontents
       
    58 
       
    59     \section1 Useful Classes
       
    60 
       
    61     Various classes in Qt are designed to help developers integrate applications into
       
    62     users' desktop environments. These classes enable developers to take advantage
       
    63     of native services while still using a cross-platform API.
       
    64 
       
    65     \annotatedlist desktop
       
    66 
       
    67     \section1 Setting the Application Icon
       
    68 
       
    69     In order to change the icon of the executable application file
       
    70     itself, as it is presented on the desktop (i.e., prior to
       
    71     application execution), it is necessary to employ another,
       
    72     platform-dependent technique.
       
    73 
       
    74     \tableofcontents {1 Setting the Application Icon}
       
    75 
       
    76     \section1 Opening External Resources
       
    77 
       
    78     Although Qt provides facilities to handle and display resources, such as
       
    79     \l{QImageIOHandler}{common image formats} and \l{QTextDocument}{HTML},
       
    80     it is sometimes necessary to open files and external resources using external
       
    81     applications.
       
    82 
       
    83     QDesktopServices provides an interface to services offered by the user's desktop
       
    84     environment. In particular, the \l{QDesktopServices::}{openUrl()} function is
       
    85     used to open resources using the appropriate application, which may have been
       
    86     specifically configured by the user.
       
    87 
       
    88     \section1 System Tray Icons
       
    89 
       
    90     Many modern desktop environments feature docks or panels with \e{system trays}
       
    91     in which applications can install icons. Applications often use system tray icons
       
    92     to display status information, either by updating the icon itself or by showing
       
    93     information in "balloon messages". Additionally, many applications provide
       
    94     pop-up menus that can be accessed via their system tray icons.
       
    95 
       
    96     The QSystemTrayIcon class exposes all of the above features via an intuitive
       
    97     Qt-style API that can be used on all desktop platforms.
       
    98 
       
    99     \section1 Desktop Widgets
       
   100 
       
   101     On systems where the user's desktop is displayed using more than one screen,
       
   102     certain types of applications may need to obtain information about the
       
   103     configuration of the user's workspace to ensure that new windows and dialogs
       
   104     are opened in appropriate locations.
       
   105 
       
   106     The QDesktopWidget class can be used to monitor the positions of widgets and
       
   107     notify applications about changes to the way the desktop is split over the
       
   108     available screens. This enables applications to implement policies for
       
   109     positioning new windows so that, for example, they do not distract a user
       
   110     who is working on a specific task.
       
   111 */