offapi/com/sun/star/text/ViewSettings.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: ViewSettings.idl,v $
  10  * $Revision: 1.18 $
  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_text_ViewSettings_idl__
  31 #define __com_sun_star_text_ViewSettings_idl__
  32
  33 #ifndef __com_sun_star_beans_XPropertySet_idl__
  34 #include <com/sun/star/beans/XPropertySet.idl>
  35 #endif
  36 #ifndef __com_sun_star_view_DocumentZoomType_idl__
  37 #include <com/sun/star/view/DocumentZoomType.idl>
  38 #endif
  39 #ifndef __com_sun_star_lang_IllegalArgumentException_idl__
  40 #include <com/sun/star/lang/IllegalArgumentException.idl>
  41 #endif
  42
  43 //=============================================================================
  44
  45  module com {  module sun {  module star {  module text {
  46
  47 //=============================================================================
  48
  49 // DocMerge from xml: service com::sun::star::text::ViewSettings
  50 /** provides access to the settings of the controller of a text document.
  51  */
  52 published service ViewSettings
  53 {
  54     // DocMerge: empty anyway
  55     interface com::sun::star::beans::XPropertySet;
  56
  57     //-------------------------------------------------------------------------
  58
  59     // DocMerge from xml: property com::sun::star::text::ViewSettings::ShowAnnotations
  60     /** If this property is <TRUE/>, annotations (notes) are visible.
  61      */
  62     [property] boolean ShowAnnotations;
  63
  64     //-------------------------------------------------------------------------
  65
  66     // DocMerge from xml: property com::sun::star::text::ViewSettings::ShowBreaks
  67     /** If this property is <TRUE/>, paragraph line breaks are visible.
  68      */
  69     [property] boolean ShowBreaks;
  70
  71     //-------------------------------------------------------------------------
  72
  73     // DocMerge from xml: property com::sun::star::text::ViewSettings::ShowFieldCommandsShowDrawings
  74     /** If this property is <TRUE/>, shapes are visible.
  75      */
  76     [property] boolean ShowDrawings;
  77
  78     //-------------------------------------------------------------------------
  79
  80     // DocMerge from xml: property com::sun::star::text::ViewSettings::ShowFieldCommands
  81     /** If this property is <TRUE/>, text fields are shown with their commands; otherwise
  82         the content is visible.
  83      */
  84     [property] boolean ShowFieldCommands;
  85
  86     //-------------------------------------------------------------------------
  87
  88     // DocMerge from xml: property com::sun::star::text::ViewSettings::ShowFootnoteBackground
  89     /** If this property is <TRUE/>, footnotes symbols are displayed with gray background.
  90      */
  91     [property] boolean ShowFootnoteBackground;
  92
  93     //-------------------------------------------------------------------------
  94
  95     // DocMerge from xml: property com::sun::star::text::ViewSettings::ShowGraphics
  96     /** If this property is <TRUE/>, graphic objects are visible.
  97      */
  98     [property] boolean ShowGraphics;
  99
 100     //-------------------------------------------------------------------------
 101
 102     // DocMerge from xml: property com::sun::star::text::ViewSettings::ShowHiddenParagraphs
 103     /** If this property is <TRUE/>, hidden paragraghs are displayed.
 104      */
 105     [property] boolean ShowHiddenParagraphs;
 106
 107     //-------------------------------------------------------------------------
 108
 109     // DocMerge from xml: property com::sun::star::text::ViewSettings::ShowHiddenText
 110     /** If this property is <TRUE/>, hidden text is displayed.
 111      */
 112     [property] boolean ShowHiddenText;
 113
 114     //-------------------------------------------------------------------------
 115
 116          /** ShowHoriRuler and ShowVertRuler determine whether a ruler is visible.
 117          */
 118         [property] boolean ShowRulers;
 119
 120         //-------------------------------------------------------------------------
 121
 122         /** If this property is <TRUE/> and the property ShowRulers is <TRUE/>,
 123            the horizontal ruler is displayed.
 124      */
 125     [property] boolean ShowHoriRuler;
 126
 127     //-------------------------------------------------------------------------
 128
 129         /** If this property is <TRUE/> and the property ShowRulers is <TRUE/>,
 130            the horizontal scroll bar is displayed.
 131      */
 132     [property] boolean ShowHoriScrollBar;
 133
 134     //-------------------------------------------------------------------------
 135
 136     // DocMerge from xml: property com::sun::star::text::ViewSettings::ShowIndexMarkBackground
 137     /** If this property is <TRUE/>, index marks are displayed with gray background.
 138      */
 139     [property] boolean ShowIndexMarkBackground;
 140
 141     //-------------------------------------------------------------------------
 142
 143     // DocMerge from xml: property com::sun::star::text::ViewSettings::ShowParaBreaks
 144     /** If this property is <TRUE/>, paragraph breaks are visible.
 145      */
 146     [property] boolean ShowParaBreaks;
 147
 148     //-------------------------------------------------------------------------
 149
 150     // DocMerge from xml: property com::sun::star::text::ViewSettings::ShowProtectedSpaces
 151     /** If this property is <TRUE/>, protected spaces (hard spaces) are displayed with gray
 152         background.
 153      */
 154     [property] boolean ShowProtectedSpaces;
 155
 156     //-------------------------------------------------------------------------
 157
 158     // DocMerge from xml: property com::sun::star::text::ViewSettings::ShowSoftHyphens
 159     /** If this property is <TRUE/>, soft hyphens are displayed with gray background.
 160      */
 161     [property] boolean ShowSoftHyphens;
 162
 163     //-------------------------------------------------------------------------
 164
 165     // DocMerge from xml: property com::sun::star::text::ViewSettings::ShowSpaces
 166     /** If this property is <TRUE/>, spaces are displayed with dots.
 167      */
 168     [property] boolean ShowSpaces;
 169
 170     //-------------------------------------------------------------------------
 171
 172     // DocMerge from xml: property com::sun::star::text::ViewSettings::ShowTableBoundaries
 173     /** If this property is <TRUE/>, table boundaries are displayed.
 174      */
 175     [property] boolean ShowTableBoundaries;
 176
 177     //-------------------------------------------------------------------------
 178
 179     // DocMerge from xml: property com::sun::star::text::ViewSettings::ShowTables
 180     /** If this property is <TRUE/>, tables are visible.
 181      */
 182     [property] boolean ShowTables;
 183
 184     //-------------------------------------------------------------------------
 185
 186     // DocMerge from xml: property com::sun::star::text::ViewSettings::ShowTabstops
 187     /** If this property is <TRUE/>, tab stops are visible.
 188      */
 189     [property] boolean ShowTabstops;
 190
 191     //-------------------------------------------------------------------------
 192
 193     // DocMerge from xml: property com::sun::star::text::ViewSettings::ShowTextBoundaries
 194     /** If this property is <TRUE/>, text boundaries are displayed.
 195      */
 196     [property] boolean ShowTextBoundaries;
 197
 198     //-------------------------------------------------------------------------
 199
 200     // DocMerge from xml: property com::sun::star::text::ViewSettings::ShowTextFieldBackground
 201     /** If this property is <TRUE/>, text fields are displayed with gray background.
 202      */
 203     [property] boolean ShowTextFieldBackground;
 204
 205     //-------------------------------------------------------------------------
 206
 207     // DocMerge from xml: property com::sun::star::text::ViewSettings::ShowVertRuler
 208     /** If this property is <TRUE/>, the vertical ruler is displayed.
 209      */
 210     [property] boolean ShowVertRuler;
 211
 212     //-------------------------------------------------------------------------
 213
 214     // DocMerge from xml: property com::sun::star::text::ViewSettings::ShowVertScrollBar
 215     /** If this property is <TRUE/>, the vertical scroll bar is displayed.
 216      */
 217     [property] boolean ShowVertScrollBar;
 218
 219     //-------------------------------------------------------------------------
 220
 221     // DocMerge from xml: property com::sun::star::text::ViewSettings::SmoothScrolling
 222     /** If this property is <TRUE/>, smooth scrolling is active.
 223      */
 224     [property] boolean SmoothScrolling;
 225
 226     //-------------------------------------------------------------------------
 227
 228     // DocMerge from xml: property com::sun::star::text::ViewSettings::SolidMarkHandles
 229     /** If this property is <TRUE/>, handles of drawing objects are visible.
 230      */
 231     [property] boolean SolidMarkHandles;
 232     //-------------------------------------------------------------------------
 233     /** If this property is <TRUE/>, the vertical ruler is aligned to the right side
 234      of the view and the vertical scrollbar is on the left.
 235      */
 236     [property] boolean IsVertRulerRightAligned;
 237
 238     //-------------------------------------------------------------------------
 239     /** If this property is <TRUE/> the document will be displayed as if it
 240         were a HTML document.
 241      */
 242     [property] boolean ShowOnlineLayout;
 243
 244     //-------------------------------------------------------------------------
 245     /** This property defines the zoom type for the document.
 246
 247         @see com::sun::star::view::DocumentZoomType
 248      */
 249     [property] short ZoomType;
 250
 251     //-------------------------------------------------------------------------
 252     /** Defines the zoom value to use.
 253         Valid only if the ZoomType is set to
 254         <member scope="com::sun::star::view::DocumentZoomType">BY_VALUE</member>.
 255      */
 256     [property] short ZoomValue;
 257     //-------------------------------------------------------------------------
 258     /** If this property is <TRUE/> hyperlinks in the document are executed (loaded) on
 259      mouse click. Otherwise they are handled like normal text.
 260          */
 261     [optional, property] boolean IsExecuteHyperlinks;
 262
 263     //-------------------------------------------------------------------------
 264     /** Specifies whether to display the grid or not
 265
 266         @since OOo 2.0.0
 267      */
 268     [optional, property] boolean IsRasterVisible;
 269
 270     //-------------------------------------------------------------------------
 271     /** Specifies whether to move frames, drawing elements, and form
 272         functions only between grid points.
 273
 274         @since OOo 2.0.0
 275      */
 276     [optional, property] boolean IsSnapToRaster;
 277
 278     //-------------------------------------------------------------------------
 279     /** Specifies the number of intervals between grid points on the X-axis.
 280
 281         <p>The value must be greater or equal to 0, and the application
 282         may enforce an upper bound for the value.</p>
 283
 284         @since OOo 2.0.0
 285         @throws com::sun::star::lang::IllegalArgumentException
 286             if the value is out of bounds.
 287      */
 288     [optional, property] long RasterSubdivisionX;
 289
 290     //-------------------------------------------------------------------------
 291     /** Specifies the number of intervals between grid points on the Y-axis.
 292
 293         <p>The value must be greater or equal to 0, and the application
 294         may enforce an upper bound for the value.</p>
 295
 296         @since OOo 2.0.0
 297         @throws com::sun::star::lang::IllegalArgumentException
 298             if the value is out of bounds.
 299      */
 300     [optional, property] long RasterSubdivisionY;
 301
 302     //-------------------------------------------------------------------------
 303     /** Defines the unit of measure for the spacing between grid points
 304         on the X-axis.
 305
 306         <p>The value must be greater than 0. The application
 307         may enforce more restricting bounds for the value.</p>
 308
 309         @since OOo 2.0.0
 310         @throws com::sun::star::lang::IllegalArgumentException
 311             if the value is out of bounds.
 312      */
 313     [optional, property] long RasterResolutionX;
 314
 315     //-------------------------------------------------------------------------
 316     /** Defines the unit of measure for the spacing between grid points
 317         on the Y-axis.
 318
 319         <p>The value must be greater than 0. The application
 320         may enforce more restricting bounds for the value.</p>
 321
 322         @since OOo 2.0.0
 323         @throws com::sun::star::lang::IllegalArgumentException
 324             if the value is out of bounds.
 325      */
 326     [optional, property] long RasterResolutionY;
 327
 328     //-------------------------------------------------------------------------
 329     /** If this property is <TRUE/>, hidden characters are displayed
 330
 331         @since OOo 3.0.0
 332      */
 333     [optional, property] boolean ShowHiddenCharacters;
 334     //-------------------------------------------------------------------------
 335     /** If this proeperty is <TRUE/>, the settings of nonprinting characters are applied.
 336
 337         <p>This option controls the use of the settings ShowHiddenCharacters,
 338         ShowTabstops, ShowSpaces, ShowBreaks and ShowParaBreaks </p>
 339
 340         @since OOo 3.0.0
 341      */
 342     [optional, property] boolean ShowNonprintingCharacters;
 343     //-------------------------------------------------------------------------
 344     /** metric unit of the horizontal ruler
 345
 346         <p>Uses values <type scope="com::sun::star::awt">FieldUnit</type></p>
 347
 348         @since OOo 3.1.0
 349      */
 350     [optional, property] long HorizontalRulerMetric;
 351     //-------------------------------------------------------------------------
 352     /** metric unit of the vertical ruler
 353
 354         <p>Uses values from <type scope="com::sun::star::awt">FieldUnit</type></p>
 355
 356         @since OOo 3.1.0
 357      */
 358     [optional, property] long VerticalRulerMetric;
 359 };
 360
 361 //=============================================================================
 362
 363 }; }; }; };
 364
 365 #endif