offapi/com/sun/star/ui/dialogs/XControlAccess.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: XControlAccess.idl,v $
  10  * $Revision: 1.8 $
  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_ui_dialogs_XControlAccess_idl__
  32 #define __com_sun_star_ui_dialogs_XControlAccess_idl__
  33
  34 #ifndef __com_sun_star_uno_XInterface_idl__
  35 #include <com/sun/star/uno/XInterface.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_lang_IllegalArgumentException_idl__
  39 #include <com/sun/star/lang/IllegalArgumentException.idl>
  40 #endif
  41
  42 //=============================================================================
  43
  44 module com { module sun { module star { module ui { module dialogs {
  45
  46 //=============================================================================
  47 /** Generic control access interface.
  48
  49     <p>Use this interface to access user interface controls supported
  50         by the implementing service. The supported controls, control
  51         properties and the appropriate values are documented in the
  52         decription of the implementing service.</p>
  53
  54     @see com::sun::star::ui::dialogs::FilePicker
  55     @see com::sun::star::ui::dialogs::FilePicker
  56
  57     @since OOo 1.1.2
  58 */
  59 published interface XControlAccess: com::sun::star::uno::XInterface
  60 {
  61 //-------------------------------------------------------------------------
  62 /** Change a control property.
  63
  64     @param aControlName
  65         The name of the control. Common control names are for
  66         instance 'OkButton' or 'CancelButton'.
  67
  68     @param aControlProperty
  69         The control property to manipulate. Common control properties
  70         are for instance 'Label' or 'State'.
  71
  72     @param aValue
  73         A value appropriated for the property.
  74
  75     @throws com::sun::star::lang::IllegalArgumentException
  76         when the control is not supported, the control property is invalid or
  77         the value fits not the control action.
  78 */
  79 void setControlProperty( [in] string aControlName, [in] string aControlProperty, [in] any aValue )
  80     raises( com::sun::star::lang::IllegalArgumentException );
  81
  82 //-------------------------------------------------------------------------
  83 /** Query for a control property.
  84
  85     @param aControlName
  86        The name of the control. Common control names are for
  87         instance 'OkButton' or 'CancelButton'.
  88
  89     @param aControlProperty
  90         The requested control property. Common control properties
  91         are for instance 'Label' or 'State'.
  92
  93     @returns
  94         the requested value.
  95
  96     @throws com::sun::star::lang::IllegalArgumentException
  97         when the control is not supported or the control property is invalid.
  98 */
  99 any getControlProperty( [in] string aControlName, [in] string aControlProperty )
 100     raises( com::sun::star::lang::IllegalArgumentException );
 101 };
 102
 103 //=============================================================================
 104
 105 }; }; }; }; };
 106
 107 #endif
 108