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