1*b1cdbd2cSJim Jagielski/************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_frame_XToolbarController_idl__ 24*b1cdbd2cSJim Jagielski#define __com_sun_star_frame_XToolbarController_idl__ 25*b1cdbd2cSJim Jagielski 26*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_awt_XWindow_idl__ 27*b1cdbd2cSJim Jagielski#include <com/sun/star/awt/XWindow.idl> 28*b1cdbd2cSJim Jagielski#endif 29*b1cdbd2cSJim Jagielski 30*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_awt_KeyModifier_idl__ 31*b1cdbd2cSJim Jagielski#include <com/sun/star/awt/KeyModifier.idl> 32*b1cdbd2cSJim Jagielski#endif 33*b1cdbd2cSJim Jagielski 34*b1cdbd2cSJim Jagielski//============================================================================= 35*b1cdbd2cSJim Jagielski 36*b1cdbd2cSJim Jagielski module com { module sun { module star { module frame { 37*b1cdbd2cSJim Jagielski 38*b1cdbd2cSJim Jagielski//============================================================================= 39*b1cdbd2cSJim Jagielski/** is an abstract service for a component which offers a more complex user interface 40*b1cdbd2cSJim Jagielski to users within a toolbar. 41*b1cdbd2cSJim Jagielski 42*b1cdbd2cSJim Jagielski <p> 43*b1cdbd2cSJim Jagielski A generic toolbar function is represented as a button which has a state 44*b1cdbd2cSJim Jagielski (enabled,disabled and selected, not selected). A toolbar controller can be added to a 45*b1cdbd2cSJim Jagielski toolbar and provide information or functions with a more sophisticated user interface.<br/> 46*b1cdbd2cSJim Jagielski A typical example for toolbar controller is a font chooser on a toolbar. It provides 47*b1cdbd2cSJim Jagielski all available fonts in a dropdown box and shows the current chosen font. 48*b1cdbd2cSJim Jagielski <p> 49*b1cdbd2cSJim Jagielski 50*b1cdbd2cSJim Jagielski @see com::sun::star::frame::XDispatchProvider 51*b1cdbd2cSJim Jagielski 52*b1cdbd2cSJim Jagielski @since OpenOffice 2.0 53*b1cdbd2cSJim Jagielski */ 54*b1cdbd2cSJim Jagielskiinterface XToolbarController : com::sun::star::uno::XInterface 55*b1cdbd2cSJim Jagielski{ 56*b1cdbd2cSJim Jagielski //============================================================================= 57*b1cdbd2cSJim Jagielski /** provides a function to execute the command which is bound to the toolbar controller. 58*b1cdbd2cSJim Jagielski 59*b1cdbd2cSJim Jagielski @param 60*b1cdbd2cSJim Jagielski a combination of <type scope="com::sun::star::awt">KeyModifier</type> value that represent 61*b1cdbd2cSJim Jagielski the current state of the modifier keys. 62*b1cdbd2cSJim Jagielski 63*b1cdbd2cSJim Jagielski <p> 64*b1cdbd2cSJim Jagielski This function is usally called by a toolbar implementation when a user clicked on a toolbar button 65*b1cdbd2cSJim Jagielski or pressed enter on the keyboard when the item has the input focus. 66*b1cdbd2cSJim Jagielski </p> 67*b1cdbd2cSJim Jagielski */ 68*b1cdbd2cSJim Jagielski void execute( [in] short KeyModifier ); 69*b1cdbd2cSJim Jagielski 70*b1cdbd2cSJim Jagielski //============================================================================= 71*b1cdbd2cSJim Jagielski /** notifies a component that a single click has been made on the toolbar item. 72*b1cdbd2cSJim Jagielski */ 73*b1cdbd2cSJim Jagielski void click(); 74*b1cdbd2cSJim Jagielski 75*b1cdbd2cSJim Jagielski //============================================================================= 76*b1cdbd2cSJim Jagielski /** notifies a component that a double click has been made on the toolbar item. 77*b1cdbd2cSJim Jagielski */ 78*b1cdbd2cSJim Jagielski void doubleClick(); 79*b1cdbd2cSJim Jagielski 80*b1cdbd2cSJim Jagielski //============================================================================= 81*b1cdbd2cSJim Jagielski /** requests to create a popup window for additional functions. 82*b1cdbd2cSJim Jagielski 83*b1cdbd2cSJim Jagielski @return 84*b1cdbd2cSJim Jagielski a <type scope="com::sun::star::awt">XWindow</type> which provides additional functions 85*b1cdbd2cSJim Jagielski to the user. The reference must be empty if component does not want to provide a separate 86*b1cdbd2cSJim Jagielski window. 87*b1cdbd2cSJim Jagielski */ 88*b1cdbd2cSJim Jagielski com::sun::star::awt::XWindow createPopupWindow(); 89*b1cdbd2cSJim Jagielski 90*b1cdbd2cSJim Jagielski //============================================================================= 91*b1cdbd2cSJim Jagielski /** requests to create an item window which can be added to the toolbar. 92*b1cdbd2cSJim Jagielski 93*b1cdbd2cSJim Jagielski @param Parent 94*b1cdbd2cSJim Jagielski a <type scope="com::sun::star::awt">XWindow</type> which must be used as a parent 95*b1cdbd2cSJim Jagielski for the requested item window. 96*b1cdbd2cSJim Jagielski 97*b1cdbd2cSJim Jagielski @return 98*b1cdbd2cSJim Jagielski a <type scope="com::sun::star::awt">XWindow</type> which can be added to a toolbar. 99*b1cdbd2cSJim Jagielski The reference must be empty if a component does not want to provide an item window. 100*b1cdbd2cSJim Jagielski */ 101*b1cdbd2cSJim Jagielski com::sun::star::awt::XWindow createItemWindow( [in] com::sun::star::awt::XWindow Parent ); 102*b1cdbd2cSJim Jagielski}; 103*b1cdbd2cSJim Jagielski 104*b1cdbd2cSJim Jagielski}; }; }; }; 105*b1cdbd2cSJim Jagielski 106*b1cdbd2cSJim Jagielski#endif 107