offapi/com/sun/star/form/component/NavigationToolBar.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_NavigationToolBar_idl__
  20 #define __com_sun_star_form_component_NavigationToolBar_idl__
  21
  22 #include <com/sun/star/form/FormControlModel.idl>
  23 #include <com/sun/star/awt/FontDescriptor.idl>
  24
  25
  26  module com {  module sun {  module star {  module form {  module component {
  27
  28
  29 /** This service specifies the model for control which provides controller
  30     functionality for a DataForm, such as navigating or filtering
  31     the form.
  32  */
  33 service NavigationToolBar
  34 {
  35     service com::sun::star::form::FormControlModel;
  36
  37     /** denotes the border style of the control.
  38
  39         Allowed values are
  40         <ul><li><b>0</b>: no border at all</li>
  41             <li><b>1</b>: 3D border</li>
  42             <li><b>2</b>: simple flat</li>
  43         </ul>
  44      */
  45     [property] short Border;
  46
  47     /** determines whether the control is enabled or disabled.
  48      */
  49     [property] boolean Enabled;
  50
  51     /** contains the font attributes for the text in the control
  52      */
  53     [property] com::sun::star::awt::FontDescriptor FontDescriptor;
  54
  55     /** specifies the text color (as RGB value) of the control.
  56      */
  57     [property] long TextColor;
  58
  59     /** specifies the text line color (as RGB value) of the control.
  60
  61         <p>This color is used if the #FontDescriptor defines
  62         that the text in the control should be underlined or stroke out.</p>
  63      */
  64     [property] long TextLineColor;
  65
  66     /** specifies the relief for the font described in #FontDescriptor
  67
  68         <p>The value must be one of the com::sun::star::text::FontRelief
  69         constants.</p>
  70      */
  71     [property] long FontRelief;
  72
  73     /** specifies the emphasis mark for the font described in #FontDescriptor
  74
  75         <p>The value must be one of the com::sun::star::text::FontEmphasis
  76         constants.</p>
  77      */
  78     [property] long FontEmphasisMark;
  79
  80     /** specifies the size of the icons in the control
  81
  82         <p>At least the following values are to be supported:
  83         <ul><li>0: small icons (16x16)</li>
  84             <li>1: medium size icons (26x26)</li>
  85         </ul>
  86     */
  87     [property] short IconSize;
  88
  89     /** determines whether the control should provide functionality for positioning the
  90         parent form
  91     */
  92     [property] boolean ShowPosition;
  93
  94     /** determines whether the control should provide functionality for navigating the
  95         parent form
  96     */
  97     [property] boolean ShowNavigation;
  98
  99     /** determines whether the control should provide functionality for acting on the current record
 100         of the parent form
 101     */
 102     [property] boolean ShowRecordActions;
 103
 104     /** determines whether the control should provide functionality for filtering and sorting the
 105         parent form
 106     */
 107     [property] boolean ShowFilterSort;
 108
 109     /** specifies a repeat delay for the control
 110
 111         <p>Some buttons of a NavigationToolBar may show repeating behavior, e.g. may be
 112         repeatedly triggered when the user keeps the mouse pressed over such a button.<br/>
 113         The delay between two such triggers (in milliseconds) is specified with this property.
 114         </p>
 115     */
 116     [property] long RepeatDelay;
 117 };
 118
 119
 120 }; }; }; }; };
 121
 122 #endif
 123
 124 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */