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_CommandButton_idl__ 24cdf0e10cSrcweir#define __com_sun_star_form_component_CommandButton_idl__ 25cdf0e10cSrcweir 26cdf0e10cSrcweir#include <com/sun/star/form/FormControlModel.idl> 27cdf0e10cSrcweir#include <com/sun/star/awt/UnoControlButtonModel.idl> 28cdf0e10cSrcweir#include <com/sun/star/form/XImageProducerSupplier.idl> 29cdf0e10cSrcweir#include <com/sun/star/form/XApproveActionBroadcaster.idl> 30cdf0e10cSrcweir#include <com/sun/star/form/FormButtonType.idl> 31cdf0e10cSrcweir#include <com/sun/star/form/XReset.idl> 32cdf0e10cSrcweir 33cdf0e10cSrcweir 34cdf0e10cSrcweir//============================================================================= 35cdf0e10cSrcweir 36cdf0e10cSrcweir module com { module sun { module star { module form { module component { 37cdf0e10cSrcweir 38cdf0e10cSrcweir//============================================================================= 39cdf0e10cSrcweir 40cdf0e10cSrcweir/** specifies the control model for a clickable button which is part of a form 41cdf0e10cSrcweir component hierarchy. 42cdf0e10cSrcweir 43cdf0e10cSrcweir @see ImageButton 44cdf0e10cSrcweir */ 45cdf0e10cSrcweirpublished service CommandButton 46cdf0e10cSrcweir{ 47cdf0e10cSrcweir service com::sun::star::awt::UnoControlButtonModel; 48cdf0e10cSrcweir 49cdf0e10cSrcweir service com::sun::star::form::FormControlModel; 50cdf0e10cSrcweir 51cdf0e10cSrcweir /** supplies the image producer when the button is to display an image. 52cdf0e10cSrcweir 53cdf0e10cSrcweir <p>If the <member scope="com::sun::star::awt">UnoControlButtonModel::ImageURL</member> points to the location of an 54cdf0e10cSrcweir image to be displayed on the button, this interface can be used to retrieve an image 55cdf0e10cSrcweir producer, which itself will supply the image.</p> 56cdf0e10cSrcweir 57cdf0e10cSrcweir <p>Usually, a control belonging to the model will use this interface to obtain the 58cdf0e10cSrcweir image to be painted</p> 59cdf0e10cSrcweir */ 60cdf0e10cSrcweir interface com::sun::star::form::XImageProducerSupplier; 61cdf0e10cSrcweir 62cdf0e10cSrcweir //------------------------------------------------------------------------- 63cdf0e10cSrcweir 64cdf0e10cSrcweir /** describes the action to be executed by the button when pressed. 65cdf0e10cSrcweir */ 66cdf0e10cSrcweir [property] com::sun::star::form::FormButtonType ButtonType; 67cdf0e10cSrcweir 68cdf0e10cSrcweir /** describes the frame, where to open the document specified by the TargetURL. 69cdf0e10cSrcweir 70cdf0e10cSrcweir <p>This property is evaluated if the button is of type URL.</p> 71cdf0e10cSrcweir 72cdf0e10cSrcweir <p>As always, there is a number of target names which have a special meaning, and force 73cdf0e10cSrcweir a special <type scope="com::sun::star::frame">Frame</type> to be used.</p> 74cdf0e10cSrcweir */ 75cdf0e10cSrcweir [property] string TargetFrame; 76cdf0e10cSrcweir 77cdf0e10cSrcweir /** specifies the URL, which should be opened if the button was clicked. 78cdf0e10cSrcweir 79cdf0e10cSrcweir <p>This property is evaluated if the button is of type URL.</p> 80cdf0e10cSrcweir 81cdf0e10cSrcweir @see com::sun::star::form::FormButtonType 82cdf0e10cSrcweir */ 83cdf0e10cSrcweir [property] string TargetURL; 84cdf0e10cSrcweir 85cdf0e10cSrcweir /** specifies the default toggle state for the button, used when it is reset. 86cdf0e10cSrcweir 87cdf0e10cSrcweir <p>This property is meaningful only when <member scope="com::sun::star::awt">UnoControlButtonModel::Toggle</member> 88cdf0e10cSrcweir is <TRUE/>. In this case, the <code>DefaultState</code> controls to which <code>State</code> the button will 89cdf0e10cSrcweir be reset.</p> 90cdf0e10cSrcweir 91cdf0e10cSrcweir <p>For a given implementation of the interface, if this (optional) property is present, then also the optional 92cdf0e10cSrcweir interface <type scope="com::sun::star::form">XReset</type> must be present.</p> 93cdf0e10cSrcweir */ 94cdf0e10cSrcweir [optional, property] boolean DefaultState; 95cdf0e10cSrcweir 96cdf0e10cSrcweir /** allows resetting the button 97cdf0e10cSrcweir 98cdf0e10cSrcweir <p>This property is meaningful only when <member scope="com::sun::star::awt">UnoControlButtonModel::Toggle</member> 99cdf0e10cSrcweir is <TRUE/>. In this case, the <code>DefaultState</code> controls to which <code>State</code> the button will 100cdf0e10cSrcweir be reset, when <member scope="com::sun::star::form">XReset::reset</member> is invoked.</p> 101cdf0e10cSrcweir 102cdf0e10cSrcweir <p>For a given implementation of the interface, if this (optional) interface is present, then also the optional 103cdf0e10cSrcweir property <member>DefaultState</member> must be present.</p> 104cdf0e10cSrcweir */ 105cdf0e10cSrcweir [optional] interface ::com::sun::star::form::XReset; 106cdf0e10cSrcweir}; 107cdf0e10cSrcweir 108cdf0e10cSrcweir//============================================================================= 109cdf0e10cSrcweir 110cdf0e10cSrcweir}; }; }; }; }; 111cdf0e10cSrcweir 112cdf0e10cSrcweir#endif 113