offapi/com/sun/star/ui/XSidebarPanel.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 module com { module sun { module star { module ui {
  21
  22 /** Optional interface of sidebar panels.
  23 */
  24 interface XSidebarPanel
  25 {
  26     /** For a given width of the container the layouter asks every ui element for its
  27         optimal height.
  28
  29         The height to which a ui element is set may differ from the returned value.
  30
  31         The height is set via the XWindow interface.
  32     */
  33     LayoutSize getHeightForWidth ( [in] long nWidth);
  34
  35     /** Minimal possible width of this panel in pixels.
  36
  37         If this value is smaller than the maximum allowed size of the Sidebar
  38         (see config option 'org.openoffice.Office.UI.Sidebar.General.MaximumWidth'),
  39         the config option will be ignored and the new maximum Sidebar width will be
  40         getMinimalWidth() + 100px.
  41     */
  42     long getMinimalWidth();
  43 } ;
  44
  45 } ; } ; } ; } ;
  46
  47 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */