offapi/com/sun/star/ui/XToolPanel.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 #ifndef __com_sun_star_ui_XToolPanel_idl__
  21 #define __com_sun_star_ui_XToolPanel_idl__
  22
  23 #include <com/sun/star/awt/XWindow.idl>
  24 #include <com/sun/star/accessibility/XAccessible.idl>
  25
  26
  27 module com { module sun { module star { module ui {
  28
  29
  30 /** describes the basic interface to be implemented by a tool panel
  31  */
  32 interface XToolPanel
  33 {
  34     /** provides access to the tool panel's main window.
  35
  36     <p>It is allowed for an implementation to return <NULL/> here, but in this case some functionality, for instance
  37     automatic positioning of the tool panel, might not be available, and must be implemented by the tool panel itself.</p>
  38     */
  39     [attribute, readonly] ::com::sun::star::awt::XWindow    Window;
  40
  41     /** creates the root of the Accessibility object tree for the tool panel
  42         @param ParentAccessible
  43             the parent object in the Accessibility object tree
  44     */
  45     ::com::sun::star::accessibility::XAccessible
  46         createAccessible( [in] ::com::sun::star::accessibility::XAccessible ParentAccessible );
  47 };
  48
  49
  50 }; }; }; };
  51
  52
  53 #endif
  54
  55 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */