/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef __com_sun_star_sheet_DocumentSettings_idl__
#define __com_sun_star_sheet_DocumentSettings_idl__

#ifndef __com_sun_star_beans_XPropertySet_idl__
#include <com/sun/star/beans/XPropertySet.idl>
#endif

#ifndef __com_sun_star_util_Color_idl__
#include <com/sun/star/util/Color.idl>
#endif

#ifndef __com_sun_star_document_Settings_idl__
#include <com/sun/star/document/Settings.idl>
#endif

//=============================================================================

module com {  module sun {  module star {  module sheet {

//=============================================================================

/** describes properties that apply to the whole spreadsheet document.

    <p>For settings that affect view properties, these settings apply to
    subsequently created views and are saved with the document, while
    <type>SpreadsheetViewSettings</type> can be used to alter a specific
    view that is already open.</p>
 */
published service DocumentSettings
{
    service com::sun::star::document::Settings;

    //-------------------------------------------------------------------------
    /** provides access to the properties.
     */
    interface com::sun::star::beans::XPropertySet;

    //-------------------------------------------------------------------------

    /** enables display of zero-values.
     */
    [optional, property] boolean ShowZeroValues;

    /** controls whether a marker is shown for notes in cells.
     */
    [optional, property] boolean ShowNotes;

    /** enables the display of the cell grid.
     */
    [optional, property] boolean ShowGrid;

    /** specifies the color in which the cell grid is displayed.
     */
    [optional, property] com::sun::star::util::Color GridColor;

    /** enables display of page breaks.
     */
    [optional, property] boolean ShowPageBreaks;

    /** enables the column and row headers of the view.
     */
    [optional, property] boolean HasColumnRowHeaders;

    /** enables the sheet tabs of the view.
     */
    [optional, property] boolean HasSheetTabs;

    /** enables the display of outline symbols.
     */
    [optional, property] boolean IsOutlineSymbolsSet;

    /** enables the restriction of object movement and resizing
        of drawing objects to the raster.
     */
    [optional, property] boolean IsSnapToRaster;

    /** enables the display of the drawing object raster.
     */
    [optional, property] boolean RasterIsVisible;

    /** specifies the distance between horizontal grid elements
        in 1/100 mm.
     */
    [optional, property] long RasterResolutionX;

    /** specifies the distance between vertical grid elements
        in 1/100 mm.
     */
    [optional, property] long RasterResolutionY;

    /** specifies the number of subdivisions between two horiontal
        grid elements.
     */
    [optional, property] long RasterSubdivisionX;

    /** specifies the number of subdivisions between two vertical
        grid elements.
     */
    [optional, property] long RasterSubdivisionY;

    /** enables the synchronization of horizontal and vertical
        grid settings in the user interface.
     */
    [optional, property] boolean IsRasterAxisSynchronized;
};

//=============================================================================

}; }; }; };

#endif
