offapi/com/sun/star/form/component/CommandButton.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20
  21
  22  module com {  module sun {  module star {  module form {  module component {
  23
  24
  25 /** specifies the control model for a clickable button which is part of a form
  26     component hierarchy.
  27
  28     @see ImageButton
  29  */
  30 published service CommandButton
  31 {
  32     service com::sun::star::awt::UnoControlButtonModel;
  33
  34     service com::sun::star::form::FormControlModel;
  35
  36     /** supplies the image producer when the button is to display an image.
  37
  38         <p>If the com::sun::star::awt::UnoControlButtonModel::ImageURL points to the location of an
  39         image to be displayed on the button, this interface can be used to retrieve an image
  40         producer, which itself will supply the image.</p>
  41
  42         <p>Usually, a control belonging to the model will use this interface to obtain the
  43         image to be painted</p>
  44      */
  45     interface com::sun::star::form::XImageProducerSupplier;
  46
  47
  48     /** describes the action to be executed by the button when pressed.
  49      */
  50     [property] com::sun::star::form::FormButtonType ButtonType;
  51
  52     /** describes the frame, where to open the document specified by the TargetURL.
  53
  54         <p>This property is evaluated if the button is of type URL.</p>
  55
  56         <p>As always, there is a number of target names which have a special meaning, and force
  57         a special com::sun::star::frame::Frame to be used.</p>
  58      */
  59     [property] string TargetFrame;
  60
  61     /** specifies the URL, which should be opened if the button was clicked.
  62
  63         <p>This property is evaluated if the button is of type URL.</p>
  64
  65         @see com::sun::star::form::FormButtonType
  66      */
  67     [property] string TargetURL;
  68
  69     /** specifies the default toggle state for the button, used when it is reset.
  70
  71         <p>This property is meaningful only when com::sun::star::awt::UnoControlButtonModel::Toggle
  72         is `TRUE`. In this case, the <code>DefaultState</code> controls to which <code>State</code> the button will
  73         be reset.</p>
  74
  75         <p>For a given implementation of the interface, if this (optional) property is present, then also the optional
  76         interface com::sun::star::form::XReset must be present.</p>
  77     */
  78     [optional, property] boolean DefaultState;
  79
  80     /** allows resetting the button
  81
  82         <p>This property is meaningful only when com::sun::star::awt::UnoControlButtonModel::Toggle
  83         is `TRUE`. In this case, the <code>DefaultState</code> controls to which <code>State</code> the button will
  84         be reset, when com::sun::star::form::XReset::reset() is invoked.</p>
  85
  86         <p>For a given implementation of the interface, if this (optional) interface is present, then also the optional
  87         property #DefaultState must be present.</p>
  88     */
  89     [optional] interface ::com::sun::star::form::XReset;
  90 };
  91
  92
  93 }; }; }; }; };
  94
  95 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */