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