xref: /aoo41x/main/offapi/com/sun/star/ui/XSidebarPanel.idl (revision 7a32b0c8)

/**************************************************************
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/



#ifndef __com_sun_star_ui_XSidebarPanel_idl__
#define __com_sun_star_ui_XSidebarPanel_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

#ifndef __com_sun_star_rendering_XCanvas_idl__
#include <com/sun/star/rendering/XCanvas.idl>
#endif

#ifndef __com_sun_star_awt_Point_idl__
#include <com/sun/star/awt/Point.idl>
#endif

#ifndef __com_sun_star_beans_XPropertySet_idl__
#include <com/sun/star/beans/XPropertySet.idl>
#endif
#ifndef __com_sun_star_ui_LayoutSize_idl__
#include <com/sun/star/ui/LayoutSize.idl>
#endif

module com { module sun { module star { module ui {

/** Optional interface of sidebar panels.
*/
interface XSidebarPanel
{
    /** For a given width of the container the layouter asks every ui element for its
        optimal height.

        The height to which a ui element is set may differ from the returned value.

        The height is set via the XWindow interface.
    */
    LayoutSize getHeightForWidth ( [in] long nWidth);

    /** If the panel has a menu or dialog then show it now.
    */
    void showMenu ();

    /** Return whether the panel supports (ie wants to be displayed
        for) the given context.

        The decision of whether to display a panel for a given context
        depends on two sources of information.
        One is the configuration
        (org.openoffice.Office.UI/Sidebar/Content/PanelList).
        The other is this function.

        @param sApplicationName
            Name of an application (reference of valid values needed,
        Wiki page?)
        @param sContextName
            Name of the context in the scope of the application
            (reference needed).
    */
    boolean isContextSupported (
        [in] string sApplicationName,
        [in] string sContextName);
} ;

} ; } ; } ; } ;

#endif