offapi/com/sun/star/ui/XUIElementSettings.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: XUIElementSettings.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_ui_XUIElementSettings_idl__
  32 #define __com_sun_star_ui_XUIElementSettings_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_container_XIndexAccess_idl__
  39 #include <com/sun/star/container/XIndexAccess.idl>
  40 #endif
  41
  42 //=============================================================================
  43
  44 module com { module sun { module star { module ui {
  45
  46 //=============================================================================
  47
  48 /** provides functions to retrieve and change user interface element structure
  49     data and to update its visible representation.
  50
  51     @since OOo 2.0.0
  52 */
  53
  54 interface XUIElementSettings : com::sun::star::uno::XInterface
  55 {
  56     /** forces the user interface element to retrieve new settings from its
  57         configuration source.
  58
  59         <p>
  60         This is not done automatically as configurable user interface elements
  61         are controlled by layout managers. It is more efficient to let the
  62         responsible layout manager to control the update process in a single
  63         task.
  64         </p>
  65     */
  66     void updateSettings();
  67
  68     /** provides a <type>UIElementSettings</type> instance that provides access
  69         to the structure of user interface element if the user interface element
  70         type supports it.
  71
  72         @param bWriteable
  73             must be <TRUE/> if the retrieved settings should be a writeable.
  74             Otherwise <FALSE/> should be provided to get a shareable reference
  75             to the settings data.
  76
  77         @return
  78             the current settings of the user interface element.
  79     */
  80     com::sun::star::container::XIndexAccess getSettings( [in] boolean bWriteable );
  81
  82     /** set changes to the structure of the user interface element.
  83
  84         @param UISettings
  85             new data settings for the configurable user interface element.
  86
  87
  88         <p>
  89         User interface elements cannot be changed directly. The changed structure
  90         data has to be set again. This speeds up the configuration process if many
  91         changes have to be made on the structure. The persistence of changes are
  92         controlled by the boolean property <member>Persistent</member>.
  93
  94         </p>
  95
  96         @see com::sun::star::ui::UIElementSettings
  97     */
  98     void setSettings( [in] com::sun::star::container::XIndexAccess UISettings );
  99 };
 100
 101 }; }; }; };
 102
 103 //=============================================================================
 104
 105 #endif