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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XPropertyControlFactory.idl,v $
  10  * $Revision: 1.5 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __com_sun_star_inspection_XPropertyControlFactory_idl__
  32 #define __com_sun_star_inspection_XPropertyControlFactory_idl__
  33
  34 #ifndef __com_sun_star_lang_IllegalArgumentException_idl__
  35 #include <com/sun/star/lang/IllegalArgumentException.idl>
  36 #endif
  37
  38 //=============================================================================
  39 module com {  module sun {  module star {  module inspection {
  40
  41 interface XPropertyControl;
  42
  43 //-----------------------------------------------------------------------------
  44 /** a factory for <type>XPropertyControl</type>s
  45
  46     @since OOo 2.0.3
  47 */
  48 interface XPropertyControlFactory
  49 {
  50     /** creates a <type>XPropertyControl</type>
  51
  52         <p>A <type>XPropertyControlFactory</type> can create any of the control types denoted by
  53         the <type>PropertyControlType</type> constants.</p>
  54
  55         @param ControlType
  56             the type of the requested control
  57
  58         @param CreateReadOnly
  59             determines whether the newly created control should be readonly.
  60
  61             <p>If this argument is <TRUE/>, this does not necessarily mean that the property cannot be
  62             changed at all in the <type>ObjectInspector</type>. Instead, an <type>XPropertyHandler</type>
  63             can still decide that there is a dedicated UI for entering the property value,
  64             which is usually triggered by a <member>LineDescriptor::PrimaryButton</member>.</p>
  65
  66             <p>Note that this parameter might be ignored if the <member>XObjectInspectorModel::IsReadOnly</member>
  67             attribute is <TRUE/>, in which case all created property controls must be readonly.</p>
  68
  69         @returns
  70             a control of the given type.
  71
  72         @throws com::sun::star::lang::IllegalArgumentException
  73             if the given <arg>ControlType</arg> is not a value <type>PropertyControlType</type>
  74     */
  75     XPropertyControl    createPropertyControl( [in] short ControlType, [in] boolean CreateReadOnly )
  76         raises ( com::sun::star::lang::IllegalArgumentException );
  77 };
  78
  79 //=============================================================================
  80
  81 }; }; }; };
  82
  83 #endif
  84