offapi/com/sun/star/ui/dialogs/XControlAccess.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
  21 module com { module sun { module star { module ui { module dialogs {
  22
  23 /** Generic control access interface.
  24
  25     <p>Use this interface to access user interface controls supported
  26         by the implementing service. The supported controls, control
  27         properties and the appropriate values are documented in the
  28         description of the implementing service.</p>
  29
  30     @see com::sun::star::ui::dialogs::FilePicker
  31     @see com::sun::star::ui::dialogs::FilePicker
  32
  33     @since OOo 1.1.2
  34 */
  35 published interface XControlAccess: com::sun::star::uno::XInterface
  36 {
  37 /** Change a control property.
  38
  39     @param aControlName
  40         The name of the control. Common control names are for
  41         instance "OkButton" or "CancelButton".
  42
  43     @param aControlProperty
  44         The control property to manipulate. Common control properties
  45         are for instance "Label" or "State".
  46
  47     @param aValue
  48         A value appropriated for the property.
  49
  50     @throws com::sun::star::lang::IllegalArgumentException
  51         when the control is not supported, the control property is invalid or
  52         the value fits not the control action.
  53 */
  54 void setControlProperty( [in] string aControlName, [in] string aControlProperty, [in] any aValue )
  55     raises( com::sun::star::lang::IllegalArgumentException );
  56
  57 /** Query for a control property.
  58
  59     @param aControlName
  60        The name of the control. Common control names are for
  61         instance "OkButton" or "CancelButton".
  62
  63     @param aControlProperty
  64         The requested control property. Common control properties
  65         are for instance "Label" or "State".
  66
  67     @returns
  68         the requested value.
  69
  70     @throws com::sun::star::lang::IllegalArgumentException
  71         when the control is not supported or the control property is invalid.
  72 */
  73 any getControlProperty( [in] string aControlName, [in] string aControlProperty )
  74     raises( com::sun::star::lang::IllegalArgumentException );
  75 };
  76
  77
  78 }; }; }; }; };
  79
  80 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */