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