1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23
24#ifndef __com_sun_star_ui_XSidebarPanel_idl__
25#define __com_sun_star_ui_XSidebarPanel_idl__
26
27#ifndef __com_sun_star_uno_XInterface_idl__
28#include <com/sun/star/uno/XInterface.idl>
29#endif
30
31#ifndef __com_sun_star_rendering_XCanvas_idl__
32#include <com/sun/star/rendering/XCanvas.idl>
33#endif
34
35#ifndef __com_sun_star_awt_Point_idl__
36#include <com/sun/star/awt/Point.idl>
37#endif
38
39#ifndef __com_sun_star_beans_XPropertySet_idl__
40#include <com/sun/star/beans/XPropertySet.idl>
41#endif
42#ifndef __com_sun_star_ui_LayoutSize_idl__
43#include <com/sun/star/ui/LayoutSize.idl>
44#endif
45
46module com { module sun { module star { module ui {
47
48/** Optional interface of sidebar panels.
49*/
50interface XSidebarPanel
51{
52    /** For a given width of the container the layouter asks every ui element for its
53        optimal height.
54
55        The height to which a ui element is set may differ from the returned value.
56
57        The height is set via the XWindow interface.
58    */
59    LayoutSize getHeightForWidth ( [in] long nWidth);
60
61    /** If the panel has a menu or dialog then show it now.
62    */
63    void showMenu ();
64
65    /** Return whether the panel supports (ie wants to be displayed
66        for) the given context.
67
68        The decision of whether to display a panel for a given context
69        depends on two sources of information.
70        One is the configuration
71        (org.openoffice.Office.UI/Sidebar/Content/PanelList).
72        The other is this function.
73
74        @param sApplicationName
75            Name of an application (reference of valid values needed,
76        Wiki page?)
77        @param sContextName
78            Name of the context in the scope of the application
79            (reference needed).
80    */
81    boolean isContextSupported (
82        [in] string sApplicationName,
83        [in] string sContextName);
84} ;
85
86} ; } ; } ; } ;
87
88#endif
89