offapi/com/sun/star/form/component/ImageButton.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 /** This service specifies the control model for a clickable button which
  26     is represented by an image.
  27
  28      <p>The image to be displayed is determined by com::sun::star::awt::UnoControlImageControlModel::ImageURL
  29     property specifies the URL of an image to be displayed.</p>
  30
  31     @see CommandButton
  32 */
  33 published service ImageButton
  34 {
  35     service com::sun::star::awt::UnoControlImageControlModel;
  36
  37     service com::sun::star::form::FormControlModel;
  38
  39
  40     /** supplies the caller with a com::sun::star::awt::XImageProducer.
  41
  42         <p>Other components can register as com::sun::star::awt::XImageConsumer
  43         at this producer. Then they will be notified of any change in the image to be displayed.</p>
  44
  45         <p>Whenever the com::sun::star::awt::UnoControlImageControlModel::ImageURL
  46         property is changed, the model loads the specified image, and sets it as image source
  47         at its com::sun::star::awt::XImageProducer. Then, all
  48         com::sun::star::awt::XImageConsumers are notified and supplied with
  49         the binary data of the image.<br/>
  50         Usually, controls acting for an ImageButton model are consumers, and use the
  51         data stream to display the image</p>
  52      */
  53     interface com::sun::star::form::XImageProducerSupplier;
  54
  55     /** describes the action to be executed by the button when pressed.
  56      */
  57     [property] com::sun::star::form::FormButtonType ButtonType;
  58
  59     /** describes the frame, where to open the document specified by the TargetURL.
  60
  61         <p>This property is evaluated if the button is of type URL.</p>
  62
  63         <p>As always, there is a number of target names which have a special meaning, and force
  64         a special com::sun::star::frame::Frame to be used.</p>
  65      */
  66     [property] string TargetFrame;
  67
  68     /** specifies the URL, which should be opened if the button was clicked.
  69
  70         <p>This property is evaluated if the button is of type URL.</p>
  71
  72         @see com::sun::star::form::FormButtonType
  73      */
  74     [property] string TargetURL;
  75 };
  76
  77
  78 }; }; }; }; };
  79
  80 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */