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