diff options
Diffstat (limited to 'offapi/com/sun/star/frame/ToolbarController.idl')
-rw-r--r-- | offapi/com/sun/star/frame/ToolbarController.idl | 132 |
1 files changed, 0 insertions, 132 deletions
diff --git a/offapi/com/sun/star/frame/ToolbarController.idl b/offapi/com/sun/star/frame/ToolbarController.idl deleted file mode 100644 index 75a23a0b5..000000000 --- a/offapi/com/sun/star/frame/ToolbarController.idl +++ /dev/null @@ -1,132 +0,0 @@ -/************************************************************************* - * - * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * - * Copyright 2000, 2010 Oracle and/or its affiliates. - * - * OpenOffice.org - a multi-platform office productivity suite - * - * This file is part of OpenOffice.org. - * - * OpenOffice.org is free software: you can redistribute it and/or modify - * it under the terms of the GNU Lesser General Public License version 3 - * only, as published by the Free Software Foundation. - * - * OpenOffice.org is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU Lesser General Public License version 3 for more details - * (a copy is included in the LICENSE file that accompanied this code). - * - * You should have received a copy of the GNU Lesser General Public License - * version 3 along with OpenOffice.org. If not, see - * <http://www.openoffice.org/license.html> - * for a copy of the LGPLv3 License. - * - ************************************************************************/ - -#ifndef __com_sun_star_frame_ToolbarController_idl__ -#define __com_sun_star_frame_ToolbarController_idl__ - -#include <com/sun/star/lang/XInitialization.idl> -#include <com/sun/star/util/XUpdatable.idl> -#include <com/sun/star/frame/XStatusListener.idl> -#include <com/sun/star/frame/XToolbarController.idl> -#include <com/sun/star/frame/XSubToolbarController.idl> - -//============================================================================= - - module com { module sun { module star { module frame { - -//============================================================================= -/** is an abstract service for a component which offers a more complex user - interface to users within a toolbar. - - <p> - A generic toolbar function is represented as a button which has a state - (enabled,disabled and selected, not selected). A toolbar controller can - be added to a toolbar and provide information or functions within a more - sophisticated user interface.<br/> A typical example for toolbar controller - is the font chooser within the toolbar. It provides all available fonts in - a dropdown box and shows the current chosen font. - <p> - - @see com::sun::star::frame::XDispatchProvider - - @since OOo 2.0 - */ - -service ToolbarController -{ - //------------------------------------------------------------------------- - /** with this interface a component can receive events if a feature has - changed. - - <p> - The toolbar controller implementation should register itself as a - listener when its <member scope="com::sun::star::util">XUpdatable</member> - interface has been called. - </p> - */ - interface com::sun::star::frame::XStatusListener; - - /** used to initialize a component with required arguments. - - A toolbar controller needs at least three additional arguments - provided as <type scope="com::sun::star::beans">PropertyValue</type>: - <ul> - <li><b>Frame</b><br>a <type scope="com::sun::star::frame">XFrame</type> - instance to which the toolbar controller belongs.</li> - <li><b>CommandURL</b><br>a string which specifies the command a - toolbar controller is bound.</li> - <li><b>ServiceManager</b><br>a - <type scope="com::sun::star::lang">XMultiServiceFactory</type> - instance which can be used to create additional UNO services.</li> - </ul> - */ - interface com::sun::star::lang::XInitialization; - - /** used to notify an implementation that it needs to add its listener or remove - and add them again. - - <p> - A toolbar controller instance is ready for use after this call has been made - the first time. The toolbar implementation guarantees that the controller's - item window has been added to the toolbar and its reference is held by it. - </p> - */ - interface com::sun::star::util::XUpdatable; - - //------------------------------------------------------------------------- - /** used to notify changed features and requests for additional user interface - items. - - <p> - Mostly used by a toolbar implementation to forward information to and request - services from a toolbar controller component. This interface must be usable - after <member scope="com::sun::star::lang">XInitialitation::initialize</member> - has been called. The behavior of the interface is undefined if the controller - component hasn't been initialized. - </p> - */ - interface com::sun::star::frame::XToolbarController; - - //------------------------------------------------------------------------- - /** used to notify and retrieve information that are specific for sub-toolbar - controllers. - - <p> - Used by implementations that want to provide the toolbar button/sub- - toolbar function feature. A controller supporting this interface exchanges - the function of its own toolbar button, that opened the sub-toolbar, with - the one that has been selected on the sub-toolbar. - </p> - */ - [optional] interface ::com::sun::star::frame::XSubToolbarController; -}; - -//============================================================================= - -}; }; }; }; - -#endif |