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_XSubToolbarController_idl__ 24*b1cdbd2cSJim Jagielski#define __com_sun_star_frame_XSubToolbarController_idl__ 25*b1cdbd2cSJim Jagielski 26*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_uno_XInterface_idl__ 27*b1cdbd2cSJim Jagielski#include <com/sun/star/uno/XInterface.idl> 28*b1cdbd2cSJim Jagielski#endif 29*b1cdbd2cSJim Jagielski 30*b1cdbd2cSJim Jagielski//============================================================================= 31*b1cdbd2cSJim Jagielski 32*b1cdbd2cSJim Jagielski module com { module sun { module star { module frame { 33*b1cdbd2cSJim Jagielski 34*b1cdbd2cSJim Jagielski//============================================================================= 35*b1cdbd2cSJim Jagielski/** special interface to support sub-toolbars in a controller implementation. 36*b1cdbd2cSJim Jagielski 37*b1cdbd2cSJim Jagielski <p> 38*b1cdbd2cSJim Jagielski This interface is normally used to implement the toolbar button/sub- 39*b1cdbd2cSJim Jagielski toolbar function feature. It exchanges the function of the toolbar 40*b1cdbd2cSJim Jagielski button, that opened the sub-toolbar, with the one that has been selected 41*b1cdbd2cSJim Jagielski on the sub-toolbar. 42*b1cdbd2cSJim Jagielski </p> 43*b1cdbd2cSJim Jagielski 44*b1cdbd2cSJim Jagielski @see com::sun::star::frame::ToolbarController 45*b1cdbd2cSJim Jagielski 46*b1cdbd2cSJim Jagielski @since OpenOffice 2.0 47*b1cdbd2cSJim Jagielski */ 48*b1cdbd2cSJim Jagielskiinterface XSubToolbarController : com::sun::star::uno::XInterface 49*b1cdbd2cSJim Jagielski{ 50*b1cdbd2cSJim Jagielski //============================================================================= 51*b1cdbd2cSJim Jagielski /** if the controller features a sub-toolbar. 52*b1cdbd2cSJim Jagielski 53*b1cdbd2cSJim Jagielski @return 54*b1cdbd2cSJim Jagielski <TRUE/> if the controller offers a sub toolbar, otherwise <FALSE/>. 55*b1cdbd2cSJim Jagielski 56*b1cdbd2cSJim Jagielski <p> 57*b1cdbd2cSJim Jagielski Enables implementations to dynamically decide to support sub-toolbars 58*b1cdbd2cSJim Jagielski or not. 59*b1cdbd2cSJim Jagielski </p> 60*b1cdbd2cSJim Jagielski */ 61*b1cdbd2cSJim Jagielski boolean opensSubToolbar(); 62*b1cdbd2cSJim Jagielski 63*b1cdbd2cSJim Jagielski //============================================================================= 64*b1cdbd2cSJim Jagielski /** provides the resource URL of the sub-toolbar this controller opens. 65*b1cdbd2cSJim Jagielski 66*b1cdbd2cSJim Jagielski @return 67*b1cdbd2cSJim Jagielski name of the sub-toolbar this controller offers. A empty string 68*b1cdbd2cSJim Jagielski will be interpreted as if this controller offers no sub-toolbar. 69*b1cdbd2cSJim Jagielski */ 70*b1cdbd2cSJim Jagielski string getSubToolbarName(); 71*b1cdbd2cSJim Jagielski 72*b1cdbd2cSJim Jagielski //============================================================================= 73*b1cdbd2cSJim Jagielski /** gets called to notify a controller that a sub-toolbar function has been 74*b1cdbd2cSJim Jagielski selected. 75*b1cdbd2cSJim Jagielski 76*b1cdbd2cSJim Jagielski @param aCommand 77*b1cdbd2cSJim Jagielski a string which identifies the function that has been selected by 78*b1cdbd2cSJim Jagielski a user. 79*b1cdbd2cSJim Jagielski */ 80*b1cdbd2cSJim Jagielski void functionSelected( [in] string aCommand ); 81*b1cdbd2cSJim Jagielski 82*b1cdbd2cSJim Jagielski //============================================================================= 83*b1cdbd2cSJim Jagielski /** gets called to notify a controller that it should set an image which 84*b1cdbd2cSJim Jagielski represents the current selected function. 85*b1cdbd2cSJim Jagielski 86*b1cdbd2cSJim Jagielski <p> 87*b1cdbd2cSJim Jagielski Only the controller instance is able to set the correct image for the 88*b1cdbd2cSJim Jagielski current function. A toolbar implementation will ask sub-toolbar 89*b1cdbd2cSJim Jagielski controllers to update their image whenever it has to update the images 90*b1cdbd2cSJim Jagielski of all its buttons. 91*b1cdbd2cSJim Jagielski </p> 92*b1cdbd2cSJim Jagielski */ 93*b1cdbd2cSJim Jagielski void updateImage(); 94*b1cdbd2cSJim Jagielski}; 95*b1cdbd2cSJim Jagielski 96*b1cdbd2cSJim Jagielski}; }; }; }; 97*b1cdbd2cSJim Jagielski 98*b1cdbd2cSJim Jagielski#endif 99