1*d1766043SAndrew Rist/************************************************************** 2cdf0e10cSrcweir * 3*d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one 4*d1766043SAndrew Rist * or more contributor license agreements. See the NOTICE file 5*d1766043SAndrew Rist * distributed with this work for additional information 6*d1766043SAndrew Rist * regarding copyright ownership. The ASF licenses this file 7*d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the 8*d1766043SAndrew Rist * "License"); you may not use this file except in compliance 9*d1766043SAndrew Rist * with the License. You may obtain a copy of the License at 10*d1766043SAndrew Rist * 11*d1766043SAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 12*d1766043SAndrew Rist * 13*d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing, 14*d1766043SAndrew Rist * software distributed under the License is distributed on an 15*d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*d1766043SAndrew Rist * KIND, either express or implied. See the License for the 17*d1766043SAndrew Rist * specific language governing permissions and limitations 18*d1766043SAndrew Rist * under the License. 19*d1766043SAndrew Rist * 20*d1766043SAndrew Rist *************************************************************/ 21*d1766043SAndrew Rist 22*d1766043SAndrew Rist 23cdf0e10cSrcweir#ifndef __com_sun_star_form_component_ImageButton_idl__ 24cdf0e10cSrcweir#define __com_sun_star_form_component_ImageButton_idl__ 25cdf0e10cSrcweir 26cdf0e10cSrcweir#ifndef __com_sun_star_awt_UnoControlImageControlModel_idl__ 27cdf0e10cSrcweir#include <com/sun/star/awt/UnoControlImageControlModel.idl> 28cdf0e10cSrcweir#endif 29cdf0e10cSrcweir 30cdf0e10cSrcweir#ifndef __com_sun_star_form_FormControlModel_idl__ 31cdf0e10cSrcweir#include <com/sun/star/form/FormControlModel.idl> 32cdf0e10cSrcweir#endif 33cdf0e10cSrcweir 34cdf0e10cSrcweir#ifndef __com_sun_star_form_XApproveActionBroadcaster_idl__ 35cdf0e10cSrcweir#include <com/sun/star/form/XApproveActionBroadcaster.idl> 36cdf0e10cSrcweir#endif 37cdf0e10cSrcweir 38cdf0e10cSrcweir#ifndef __com_sun_star_form_XImageProducerSupplier_idl__ 39cdf0e10cSrcweir#include <com/sun/star/form/XImageProducerSupplier.idl> 40cdf0e10cSrcweir#endif 41cdf0e10cSrcweir 42cdf0e10cSrcweir#ifndef __com_sun_star_form_FormButtonType_idl__ 43cdf0e10cSrcweir#include <com/sun/star/form/FormButtonType.idl> 44cdf0e10cSrcweir#endif 45cdf0e10cSrcweir 46cdf0e10cSrcweir 47cdf0e10cSrcweir//============================================================================= 48cdf0e10cSrcweir 49cdf0e10cSrcweir module com { module sun { module star { module form { module component { 50cdf0e10cSrcweir 51cdf0e10cSrcweir//============================================================================= 52cdf0e10cSrcweir 53cdf0e10cSrcweir/** This service specifies the control model for a clickable button which 54cdf0e10cSrcweir is represented by an image. 55cdf0e10cSrcweir 56cdf0e10cSrcweir <p>The image to be displayed is determined by <member scope="com::sun::star::awt">UnoControlImageControlModel::ImageURL</member> 57cdf0e10cSrcweir property specifies the URL of an image to be displayed.</p> 58cdf0e10cSrcweir 59cdf0e10cSrcweir @see CommandButton 60cdf0e10cSrcweir*/ 61cdf0e10cSrcweirpublished service ImageButton 62cdf0e10cSrcweir{ 63cdf0e10cSrcweir service com::sun::star::awt::UnoControlImageControlModel; 64cdf0e10cSrcweir 65cdf0e10cSrcweir service com::sun::star::form::FormControlModel; 66cdf0e10cSrcweir 67cdf0e10cSrcweir 68cdf0e10cSrcweir /** supplies the caller with an <type scope="com::sun::star::awt">XImageProducer</type>. 69cdf0e10cSrcweir 70cdf0e10cSrcweir <p>Other components can register as <type scope="com::sun::star::awt">XImageConsumer</type> 71cdf0e10cSrcweir at this producer. Then they will be notified of any change in the image to be displayed.</p> 72cdf0e10cSrcweir 73cdf0e10cSrcweir <p>Whenever the <member scope="com::sun::star::awt">UnoControlImageControlModel::ImageURL</member> 74cdf0e10cSrcweir property is changed, the model loads the specified image, and sets it as image source 75cdf0e10cSrcweir at its <type scope="com::sun::star::awt">XImageProducer</type>. Then, all 76cdf0e10cSrcweir <type scope="com::sun::star::awt">XImageConsumer</type>s are notified and supplied with 77cdf0e10cSrcweir the binary data of the image.<br/> 78cdf0e10cSrcweir Usually, controls acting for an <type>ImageButton</type> model are consumers, and use the 79cdf0e10cSrcweir data stream to display the image</p> 80cdf0e10cSrcweir */ 81cdf0e10cSrcweir interface com::sun::star::form::XImageProducerSupplier; 82cdf0e10cSrcweir 83cdf0e10cSrcweir //------------------------------------------------------------------------- 84cdf0e10cSrcweir /** describes the action to be executed by the button when pressed. 85cdf0e10cSrcweir */ 86cdf0e10cSrcweir [property] com::sun::star::form::FormButtonType ButtonType; 87cdf0e10cSrcweir 88cdf0e10cSrcweir //------------------------------------------------------------------------- 89cdf0e10cSrcweir /** describes the frame, where to open the document specified by the TargetURL. 90cdf0e10cSrcweir 91cdf0e10cSrcweir <p>This property is evaluated if the button is of type URL.</p> 92cdf0e10cSrcweir 93cdf0e10cSrcweir <p>As always, there is a number of target names which have a special meaning, and force 94cdf0e10cSrcweir a special <type scope="com::sun::star::frame">Frame</type> to be used.</p> 95cdf0e10cSrcweir */ 96cdf0e10cSrcweir [property] string TargetFrame; 97cdf0e10cSrcweir 98cdf0e10cSrcweir //------------------------------------------------------------------------- 99cdf0e10cSrcweir /** specifies the URL, which should be opened if the button was clicked. 100cdf0e10cSrcweir 101cdf0e10cSrcweir <p>This property is evaluated if the button is of type URL.</p> 102cdf0e10cSrcweir 103cdf0e10cSrcweir @see com::sun::star::form::FormButtonType 104cdf0e10cSrcweir */ 105cdf0e10cSrcweir [property] string TargetURL; 106cdf0e10cSrcweir}; 107cdf0e10cSrcweir 108cdf0e10cSrcweir//============================================================================= 109cdf0e10cSrcweir 110cdf0e10cSrcweir}; }; }; }; }; 111cdf0e10cSrcweir 112cdf0e10cSrcweir#endif 113