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