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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: NavigationToolBar.idl,v $
  10  * $Revision: 1.4 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_form_component_NavigationToolBar_idl__
  31 #define __com_sun_star_form_component_NavigationToolBar_idl__
  32
  33 #ifndef __com_sun_star_form_FormControlModel_idl__
  34 #include <com/sun/star/form/FormControlModel.idl>
  35 #endif
  36 #ifndef __com_sun_star_awt_FontDescriptor_idl__
  37 #include <com/sun/star/awt/FontDescriptor.idl>
  38 #endif
  39
  40 //=============================================================================
  41
  42  module com {  module sun {  module star {  module form {  module component {
  43
  44 //=============================================================================
  45
  46 /** This service specifies the model for control which provides controller
  47     functionality for a <type>DataForm</type>, such as navigating or filtering
  48     the form.
  49  */
  50 service NavigationToolBar
  51 {
  52     service com::sun::star::form::FormControlModel;
  53
  54     //-------------------------------------------------------------------------
  55     /** denotes the border style of the control.
  56
  57         Allowed values are
  58         <ul><li><b>0</b>: no border at all</li>
  59             <li><b>1</b>: 3D border</li>
  60             <li><b>2</b>: simple flat</li>
  61         </ul>
  62      */
  63     [property] short Border;
  64
  65     //-------------------------------------------------------------------------
  66     /** determines whether the control is enabled or disabled.
  67      */
  68     [property] boolean Enabled;
  69
  70     //-------------------------------------------------------------------------
  71     /** contains the font attributes for the text in the control
  72      */
  73     [property] com::sun::star::awt::FontDescriptor FontDescriptor;
  74
  75     //-------------------------------------------------------------------------
  76     /** specifies the text color (as RGB value) of the control.
  77      */
  78     [property] long TextColor;
  79
  80     //-------------------------------------------------------------------------
  81     /** specifies the text line color (as RGB value) of the control.
  82
  83         <p>This color is used if the <member>FontDescriptor</member> defines
  84         that the text in the control should be underlined or stroke out.</p>
  85      */
  86     [property] long TextLineColor;
  87
  88     //-------------------------------------------------------------------------
  89     /** specifies the relief for the font described in <member>FontDescriptor</member>
  90
  91         <p>The value must be one of the <type scope="com::sun::star::text">FontRelief</type>
  92         constants.</p>
  93      */
  94     [property] long FontRelief;
  95
  96     //-------------------------------------------------------------------------
  97     /** specifies the emphasis mark for the font described in <member>FontDescriptor</member>
  98
  99         <p>The value must be one of the <type scope="com::sun::star::text">FontEmphasis</type>
 100         constants.</p>
 101      */
 102     [property] long FontEmphasisMark;
 103
 104     //-------------------------------------------------------------------------
 105     /** specifies the size of the icons in the control
 106
 107         <p>At least the following values are to be supported:
 108         <ul><li>0: small icons (16x16)</li>
 109             <li>1: medium size icons (26x26)</li>
 110         </ul>
 111     */
 112     [property] short IconSize;
 113
 114     //-------------------------------------------------------------------------
 115     /** determines whether the control should provide functionality for positioning the
 116         parent form
 117     */
 118     [property] boolean ShowPosition;
 119
 120     //-------------------------------------------------------------------------
 121     /** determines whether the control should provide functionality for navigating the
 122         parent form
 123     */
 124     [property] boolean ShowNavigation;
 125
 126     //-------------------------------------------------------------------------
 127     /** determines whether the control should provide functionality for acting on the current record
 128         of the parent form
 129     */
 130     [property] boolean ShowRecordActions;
 131
 132     //-------------------------------------------------------------------------
 133     /** determines whether the control should provide functionality for filtering and sorting the
 134         parent form
 135     */
 136     [property] boolean ShowFilterSort;
 137
 138     //-------------------------------------------------------------------------
 139     /** specifies a repeat delay for the control
 140
 141         <p>Some buttons of a NavigationToolBar may show repeating behaviour, e.g. may be
 142         repeatedly triggered when the user keeps the mouse pressed over such a button.<br/>
 143         The delay between two such triggers (in milliseconds) is specified with this property.
 144         </p>
 145     */
 146     [property] long RepeatDelay;
 147 };
 148
 149 //=============================================================================
 150
 151 }; }; }; }; };
 152
 153 #endif