offapi/com/sun/star/ui/dialogs/XControlInformation.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28
  29 #ifndef __com_sun_star_ui_dialogs_XControlInformation_idl__
  30 #define __com_sun_star_ui_dialogs_XControlInformation_idl__
  31
  32 #include <com/sun/star/uno/XInterface.idl>
  33 #include <com/sun/star/lang/IllegalArgumentException.idl>
  34
  35 //=============================================================================
  36
  37 module com { module sun { module star { module ui { module dialogs {
  38
  39 //=============================================================================
  40 /** Interface to query for controls and control properties supported by the
  41     implementing instance.
  42
  43     @since OOo 1.1.2
  44 */
  45 published interface XControlInformation: com::sun::star::uno::XInterface
  46 {
  47 //-------------------------------------------------------------------------
  48 /** Query for the supported controls of a service instance.
  49
  50     @returns
  51         a sequence with the names of the supported controls.
  52 */
  53 sequence<string> getSupportedControls( );
  54
  55 //-------------------------------------------------------------------------
  56 /** Returns whether the specified control is supported or not.
  57
  58     @param aControlName
  59         The name of the control. Common control names are for
  60         instance "OkButton" or "CancelButton".
  61
  62     @returns
  63         <TRUE/> if the specified control is supported.
  64         <FALSE/> if the specified control is not supported.
  65 */
  66 boolean isControlSupported( [in] string aControlName );
  67
  68 //-------------------------------------------------------------------------
  69 /** Returns a sequence with properties supported by the specified
  70     control.
  71
  72     @param aControlName
  73         The name of the control. Common control names are for
  74         instance "OkButton" or "CancelButton".
  75
  76     @returns
  77         a sequence of control properties supported by the specified control.
  78
  79     @throws com::sun::star::lang::IllegalArgumentException
  80         when the specified control is not supported.
  81 */
  82 sequence<string> getSupportedControlProperties( [in] string aControlName )
  83     raises( com::sun::star::lang::IllegalArgumentException );
  84
  85 //-------------------------------------------------------------------------
  86 /** Returns whether control property is supported by a control.
  87
  88     @param aControlName
  89        The name of the control.
  90
  91     @param aControlProperty
  92         The control property to query for.
  93
  94     @returns
  95         <TRUE/> if the specified control action is supported.
  96         <FALSE/> if the specified control action is not supported.
  97
  98     @throws com::sun::star::lang::IllegalArgumentException
  99         when the specified control is not supported.
 100 */
 101 boolean isControlPropertySupported( [in] string aControlName, [in] string aControlProperty )
 102     raises( com::sun::star::lang::IllegalArgumentException );
 103 };
 104
 105 }; }; }; }; };
 106
 107 #endif
 108
 109 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */