offapi/com/sun/star/view/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.5 $
  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_view_ViewSettings_idl__
  31 #define __com_sun_star_view_ViewSettings_idl__
  32
  33 #ifndef __com_sun_star_beans_XPropertySet_idl__
  34 #include <com/sun/star/beans/XPropertySet.idl>
  35 #endif
  36
  37 //=============================================================================
  38
  39 module com {  module sun {  module star {  module view {
  40
  41 //=============================================================================
  42
  43 /** provides access to the settings of the controller of an office document.
  44  */
  45 published service ViewSettings
  46 {
  47     interface com::sun::star::beans::XPropertySet;
  48
  49     //-------------------------------------------------------------------------
  50     /** If this property is <TRUE/>, the horizontal ruler is displayed.
  51      */
  52     [optional, property] boolean ShowHoriRuler;
  53
  54     //-------------------------------------------------------------------------
  55     /** If this property is <TRUE/>, the horizontal scroll bar is displayed.
  56      */
  57     [optional, property] boolean ShowHoriScrollBar;
  58
  59     //-------------------------------------------------------------------------
  60     /** specfifies the zoom-value in percent.
  61      */
  62     [optional, property] short ZoomValue;
  63
  64     //-------------------------------------------------------------------------
  65     /** If this property is <TRUE/>, the vertical ruler is displayed.
  66      */
  67     [optional, property] boolean ShowVertRuler;
  68
  69     //-------------------------------------------------------------------------
  70     /** If this property is <TRUE/>, the vertical scroll bar is displayed.
  71      */
  72     [optional, property] boolean ShowVertScrollBar;
  73 };
  74
  75 //=============================================================================
  76
  77 }; }; }; };
  78
  79 #endif