offapi/com/sun/star/ui/XUIElementSettings.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 {
  22
  23
  24 /** provides functions to retrieve and change user interface element structure
  25     data and to update its visible representation.
  26
  27     @since OOo 2.0
  28 */
  29
  30 interface XUIElementSettings : com::sun::star::uno::XInterface
  31 {
  32     /** forces the user interface element to retrieve new settings from its
  33         configuration source.
  34
  35         <p>
  36         This is not done automatically as configurable user interface elements
  37         are controlled by layout managers. It is more efficient to let the
  38         responsible layout manager to control the update process in a single
  39         task.
  40         </p>
  41     */
  42     void updateSettings();
  43
  44     /** provides a UIElementSettings instance that provides access
  45         to the structure of user interface element if the user interface element
  46         type supports it.
  47
  48         @param bWriteable
  49             must be `TRUE` if the retrieved settings should be a writable.
  50             Otherwise `FALSE` should be provided to get a shareable reference
  51             to the settings data.
  52
  53         @return
  54             the current settings of the user interface element.
  55     */
  56     com::sun::star::container::XIndexAccess getSettings( [in] boolean bWriteable );
  57
  58     /** set changes to the structure of the user interface element.
  59
  60         @param UISettings
  61             new data settings for the configurable user interface element.
  62
  63
  64         <p>
  65         User interface elements cannot be changed directly. The changed structure
  66         data has to be set again. This speeds up the configuration process if many
  67         changes have to be made on the structure. The persistence of changes are
  68         controlled by the boolean property Persistent.
  69
  70         </p>
  71
  72         @see com::sun::star::ui::UIElementSettings
  73     */
  74     void setSettings( [in] com::sun::star::container::XIndexAccess UISettings );
  75 };
  76
  77 }; }; }; };
  78
  79
  80 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */