XSidebarPanel.idl (b9e67834) XSidebarPanel.idl (7a32b0c8)
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

--- 25 unchanged lines hidden (view full) ---

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
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

--- 25 unchanged lines hidden (view full) ---

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
42
43module com { module sun { module star { module ui {
44
45
46module com { module sun { module star { module ui {
47
45/** Give access to data for one sidebar panel.
48/** Optional interface of sidebar panels.
46*/
47interface XSidebarPanel
48{
49*/
50interface XSidebarPanel
51{
49 /** Return a canvas that will paint directly into the panel.
50 It is created on the first call.
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.
51 */
58 */
52 rendering::XCanvas getCanvas ();
59 LayoutSize getHeightForWidth ( [in] long nWidth);
53
60
54 /** Return the position of the content area (without any border or decoration)
55 in screen coordinates.
61 /** If the panel has a menu or dialog then show it now.
56 */
62 */
57 awt::Point getPositionOnScreen ();
63 void showMenu ();
58
64
59 /** Return a property set that represents the theme that is used to render the panel and its controls.
60 Note that the same properties are shared by all panels and decks.
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).
61 */
80 */
62 beans::XPropertySet getThemeProperties ();
81 boolean isContextSupported (
82 [in] string sApplicationName,
83 [in] string sContextName);
63} ;
64
65} ; } ; } ; } ;
66
67#endif
84} ;
85
86} ; } ; } ; } ;
87
88#endif