offapi/com/sun/star/inspection/XObjectInspector.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef __com_sun_star_inspection_XObjectInspector_idl__
  21 #define __com_sun_star_inspection_XObjectInspector_idl__
  22
  23 #include <com/sun/star/frame/XController.idl>
  24 #include <com/sun/star/frame/XDispatchProvider.idl>
  25 #include <com/sun/star/util/VetoException.idl>
  26
  27 module com {  module sun {  module star {  module inspection {
  28
  29 interface XObjectInspectorModel;
  30 interface XObjectInspectorUI;
  31
  32 /** describes the main interface of an ObjectInspector.
  33
  34     @see ObjectInspector
  35
  36     @since OOo 2.0.3
  37 */
  38 interface XObjectInspector
  39 {
  40     /** allows to plug the inspector into an com::sun::star::frame::XFrame
  41
  42         <p>The com::sun::star::frame::XController::setModel() method
  43         accepts only XObjectInspectorModels, and will return `FALSE` if the
  44         to-be-attached model is not `NULL`, but does not support this interface.</p>
  45
  46         <p>If you do not want to support a full-blown com::sun::star::frame::XModel,
  47         use the #InspectorModel attribute instead.</p>
  48
  49         <p>The com::sun::star::frame::XController::getViewData() and
  50         com::sun::star::frame::XController::restoreViewData() exchange
  51         string values, which describes as much of the current view state as possible.</p>
  52     */
  53     interface com::sun::star::frame::XController;
  54
  55     /** allows to intercept functionality
  56
  57         <p>This interface is inherited from the com::sun::star::frame::Controller
  58         service, currently, there is no functionality to intercept at an XObjectInspector.</p>
  59     */
  60     interface com::sun::star::frame::XDispatchProvider;
  61
  62     /** provides access to the current model of the inspector
  63
  64         <p>The model is mainly responsible for providing the property handlers. Additionally,
  65         it can provide user interface names and help URLs for property categories.</p>
  66
  67         <p>Note that there are two ways of setting or retrieving the current model: You can either
  68         use com::sun::star::frame::XModel::setModel(), or, if you do not want
  69         or need to implement the full-blown com::sun::star::frame::XModel interface,
  70         you can use this property directly. Both approaches are semantically equivalent.</p>
  71
  72         <p>If a new model is set at the inspector, the complete UI will be rebuilt to reflect
  73         the change, using the new property handlers provided by the new model.</p>
  74     */
  75     [attribute] XObjectInspectorModel InspectorModel;
  76
  77     /** provides access to the user interface of the object inspector.
  78
  79         <p>This interface can be used to access and manipulate various aspects of
  80         the user interface. For instance, you can enable and disable certain
  81         property controls (or parts thereof), or register observers for all property
  82         controls.</p>
  83
  84         @since OOo 2.2
  85     */
  86     [attribute, readonly] XObjectInspectorUI InspectorUI;
  87
  88     /** inspects a new collection of one or more objects.
  89
  90         <p>If the sequence is empty, the UI of the ObjectInspector will be
  91         cleared.</p>
  92
  93         <p>If the sequence contains more than one object, the XObjectInspector
  94         will create a complete set of property handlers (as indicated by
  95         XObjectInspectorModel::HandlerFactories) for <em>every</em> of
  96         the objects, and compose their output.</p>
  97
  98         @throws com::sun::star::util::VetoException
  99             if the inspector cannot switch to another object set. This typically happens if
 100             one of the active XPropertyHandler's raised a non-modal user interface,
 101             and vetoed suspension of this UI.
 102
 103         @see XPropertyHandler::isComposable
 104         @see XPropertyHandler::onInteractivePropertySelection
 105         @see XPropertyHandler::suspend
 106     */
 107     void inspect( [in] sequence< com::sun::star::uno::XInterface > Objects )
 108         raises (com::sun::star::util::VetoException);
 109 };
 110
 111
 112 }; }; }; };
 113
 114 #endif
 115
 116
 117 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */