offapi/com/sun/star/inspection/ObjectInspector.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 #ifndef __com_sun_star_inspection_ObjectInspector_idl__
  20 #define __com_sun_star_inspection_ObjectInspector_idl__
  21
  22 #include <com/sun/star/inspection/XObjectInspector.idl>
  23 #include <com/sun/star/lang/IllegalArgumentException.idl>
  24
  25 module com {  module sun {  module star {  module inspection {
  26
  27 /** describes an com::sun::star::frame::Controller which can be used to
  28     browse and modify properties of components.
  29
  30     <p>The controller can be plugged into an com::sun::star::frame::XFrame, and will
  31     provide a visual component for inspecting and modifying component properties.<br>
  32     Note that "property" here is a generic term - any aspect of a component can be considered a property,
  33     as long as some property handler is able to describe this aspect in a property-like way.</p>
  34
  35     <p>The basic idea is that one facet of the inspected component is represented by a single line
  36     of controls: A label, an input control, and optionally one or two buttons which, when pressed,
  37     trigger additional user interaction (e.g. a more sophisticated dialog to enter a property value).</p>
  38
  39     <p>Additionally, property lines can be grouped into different categories. A usual implementation
  40     of such categories would be tab pages, but other implementations are possible, too.</p>
  41
  42     <p>Even more, the inspector can optionally display a help section at the bottom of its
  43     window, which can display arbitrary (context-sensitive) help texts.</p>
  44
  45     <p>An ObjectInspector needs one or more property handlers which describe
  46     the facets of an inspected component - without such handlers, the inspector window will simply
  47     stay empty.</p>
  48
  49     <p>The property handlers, as well as more information about the layout of the inspector,
  50     are provided by a inspector model, which has to be implemented by the user of the inspector.</p>
  51     </p>
  52
  53     <p>Since property handlers might have the need to raise UI, they will be created with a context
  54     value named "DialogParentWindow", which contains an XWindow which should be used as parent of
  55     any windows to raise.<br>
  56     If the com::sun::star::uno::XComponentContext in which the ObjectInspector
  57     was created already contains such a value, it is not overwritten. Only if it doesn't, the inspector
  58     will add an own value - which contains the inspector's main window - to the context when creating
  59     handlers.</p>
  60
  61     @see XPropertyHandler
  62     @see LineDescriptor
  63     @see PropertyControlType
  64     @see ObjectInspectorModel
  65     @see com::sun::star::uno::XComponentContext
  66     @see com::sun::star::lang::XMultiComponentFactory
  67
  68     @since OOo 2.0.3
  69 */
  70 service ObjectInspector : XObjectInspector
  71 {
  72     /** creates a default instance of the ObjectInspector
  73
  74         @since OOo 2.2
  75     */
  76     createDefault();
  77
  78     /** creates an instance of the ObjectInspector, using a given ObjectInspectorModel
  79
  80         @throws ::com::sun::star::lang::IllegalArgumentException
  81             if Model is `NULL`.
  82
  83         @since OOo 2.2
  84     */
  85     createWithModel( [in] XObjectInspectorModel Model )
  86         raises ( ::com::sun::star::lang::IllegalArgumentException );
  87 };
  88
  89
  90 }; }; }; };
  91
  92 #endif
  93
  94
  95
  96 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */