offapi/com/sun/star/inspection/XPropertyControlFactory.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_XPropertyControlFactory_idl__
  21 #define __com_sun_star_inspection_XPropertyControlFactory_idl__
  22
  23 #include <com/sun/star/lang/IllegalArgumentException.idl>
  24
  25 module com {  module sun {  module star {  module inspection {
  26
  27 interface XPropertyControl;
  28
  29 /** a factory for XPropertyControls
  30
  31     @since OOo 2.0.3
  32 */
  33 interface XPropertyControlFactory
  34 {
  35     /** creates a XPropertyControl
  36
  37         <p>A XPropertyControlFactory can create any of the control types denoted by
  38         the PropertyControlType constants.</p>
  39
  40         @param ControlType
  41             the type of the requested control
  42
  43         @param CreateReadOnly
  44             determines whether the newly created control should be readonly.
  45
  46             <p>If this argument is `TRUE`, this does not necessarily mean that the property cannot be
  47             changed at all in the ObjectInspector. Instead, an XPropertyHandler
  48             can still decide that there is a dedicated UI for entering the property value,
  49             which is usually triggered by a LineDescriptor::PrimaryButton.</p>
  50
  51             <p>Note that this parameter might be ignored if the XObjectInspectorModel::IsReadOnly
  52             attribute is `TRUE`, in which case all created property controls must be readonly.</p>
  53
  54         @returns
  55             a control of the given type.
  56
  57         @throws com::sun::star::lang::IllegalArgumentException
  58             if the given ControlType is not a value PropertyControlType
  59     */
  60     XPropertyControl    createPropertyControl( [in] short ControlType, [in] boolean CreateReadOnly )
  61         raises ( com::sun::star::lang::IllegalArgumentException );
  62 };
  63
  64
  65 }; }; }; };
  66
  67 #endif
  68
  69 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */