tools/designer/src/lib/sdk/abstractobjectinspector.cpp
changeset 0 1918ee327afb
child 4 3b1da2848fc7
equal deleted inserted replaced
-1:000000000000 0:1918ee327afb
       
     1 /****************************************************************************
       
     2 **
       
     3 ** Copyright (C) 2009 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 Qt Designer 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 #include "abstractobjectinspector.h"
       
    43 
       
    44 QT_BEGIN_NAMESPACE
       
    45 
       
    46 /*!
       
    47     \class QDesignerObjectInspectorInterface
       
    48 
       
    49     \brief The QDesignerObjectInspectorInterface class allows you to
       
    50     change the focus of Qt Designer's object inspector.
       
    51 
       
    52     \inmodule QtDesigner
       
    53 
       
    54     You can use the QDesignerObjectInspectorInterface to change the
       
    55     current form window selection. For example, when implementing a
       
    56     custom widget plugin:
       
    57 
       
    58     \snippet doc/src/snippets/code/tools_designer_src_lib_sdk_abstractobjectinspector.cpp 0
       
    59 
       
    60     The QDesignerObjectInspectorInterface class is not intended to be
       
    61     instantiated directly. You can retrieve an interface to \QD's
       
    62     object inspector using the
       
    63     QDesignerFormEditorInterface::objectInspector() function.  A
       
    64     pointer to \QD's current QDesignerFormEditorInterface object (\c
       
    65     formEditor in the example above) is provided by the
       
    66     QDesignerCustomWidgetInterface::initialize() function's
       
    67     parameter. When implementing a custom widget plugin, you must
       
    68     subclass the QDesignerCustomWidgetInterface to expose your plugin
       
    69     to \QD.
       
    70 
       
    71     The interface provides the core() function that you can use to
       
    72     retrieve a pointer to \QD's current QDesignerFormEditorInterface
       
    73     object, and the setFormWindow() function that enables you to
       
    74     change the current form window selection.
       
    75 
       
    76     \sa QDesignerFormEditorInterface, QDesignerFormWindowInterface
       
    77 */
       
    78 
       
    79 /*!
       
    80     Constructs an object inspector interface with the given \a parent
       
    81     and the specified window \a flags.
       
    82 */
       
    83 QDesignerObjectInspectorInterface::QDesignerObjectInspectorInterface(QWidget *parent, Qt::WindowFlags flags)
       
    84     : QWidget(parent, flags)
       
    85 {
       
    86 }
       
    87 
       
    88 /*!
       
    89     Destroys the object inspector interface.
       
    90 */
       
    91 QDesignerObjectInspectorInterface::~QDesignerObjectInspectorInterface()
       
    92 {
       
    93 }
       
    94 
       
    95 /*!
       
    96     Returns a pointer to \QD's current QDesignerFormEditorInterface
       
    97     object.
       
    98 */
       
    99 QDesignerFormEditorInterface *QDesignerObjectInspectorInterface::core() const
       
   100 {
       
   101     return 0;
       
   102 }
       
   103 
       
   104 /*!
       
   105     \fn void QDesignerObjectInspectorInterface::setFormWindow(QDesignerFormWindowInterface *formWindow)
       
   106 
       
   107     Sets the currently selected form window to \a formWindow.
       
   108 */
       
   109 
       
   110 QT_END_NAMESPACE