xlpage.hxx

Go to the documentation of this file.

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */

#pragma once

#include <tools/gen.hxx>
#include "ftools.hxx"
#include <memory>

// Constants and Enumerations =================================================

// (0x0014, 0x0015) HEADER, FOOTER --------------------------------------------

const sal_uInt16 EXC_ID_HEADER              = 0x0014;
const sal_uInt16 EXC_ID_FOOTER              = 0x0015;

// (0x0016, 0x0017) EVEN HEADER, EVEN FOOTER ----------------------------------

const sal_uInt16 EXC_ID_HEADER_EVEN         = 0x0016;
const sal_uInt16 EXC_ID_FOOTER_EVEN         = 0x0017;

// (0x001A, 0x001B) VERTICAL-, HORIZONTALPAGEBREAKS ---------------------------

const sal_uInt16 EXC_ID_VERPAGEBREAKS       = 0x001A;
const sal_uInt16 EXC_ID_HORPAGEBREAKS       = 0x001B;

// (0x0026, 0x0027, 0x0028, 0x0029) LEFT-, RIGHT-, TOP-, BOTTOMMARGIN ---------

const sal_uInt16 EXC_ID_LEFTMARGIN          = 0x0026;
const sal_uInt16 EXC_ID_RIGHTMARGIN         = 0x0027;
const sal_uInt16 EXC_ID_TOPMARGIN           = 0x0028;
const sal_uInt16 EXC_ID_BOTTOMMARGIN        = 0x0029;

const sal_Int32 EXC_MARGIN_DEFAULT_LR       = 1900;     
const sal_Int32 EXC_MARGIN_DEFAULT_TB       = 2500;     
const sal_Int32 EXC_MARGIN_DEFAULT_HF       = 1300;     
const sal_Int32 EXC_MARGIN_DEFAULT_HLR      = 1900;     
const sal_Int32 EXC_MARGIN_DEFAULT_FLR      = 1900;     

// (0x002A, 0x002B) PRINTHEADERS, PRINTGRIDLINES ------------------------------

const sal_uInt16 EXC_ID_PRINTHEADERS        = 0x002A;
const sal_uInt16 EXC_ID_PRINTGRIDLINES      = 0x002B;

// (0x0033) PRINTSIZE ---------------------------------------------------------

const sal_uInt16 EXC_ID_PRINTSIZE           = 0x0033;

const sal_uInt16 EXC_PRINTSIZE_SCREEN       = 1;
const sal_uInt16 EXC_PRINTSIZE_PAGE         = 2;
const sal_uInt16 EXC_PRINTSIZE_FULL         = 3;

// (0x0082, 0x0083, 0x0084) GRIDSET, HCENTER, VCENTER -------------------------

const sal_uInt16 EXC_ID_GRIDSET             = 0x0082;
const sal_uInt16 EXC_ID_HCENTER             = 0x0083;
const sal_uInt16 EXC_ID_VCENTER             = 0x0084;

// (0x00A1) SETUP -------------------------------------------------------------

const sal_uInt16 EXC_ID_SETUP               = 0x00A1;

const sal_uInt16 EXC_SETUP_INROWS           = 0x0001;
const sal_uInt16 EXC_SETUP_PORTRAIT         = 0x0002;
const sal_uInt16 EXC_SETUP_INVALID          = 0x0004;
const sal_uInt16 EXC_SETUP_BLACKWHITE       = 0x0008;
const sal_uInt16 EXC_SETUP_DRAFT            = 0x0010;
const sal_uInt16 EXC_SETUP_PRINTNOTES       = 0x0020;
const sal_uInt16 EXC_SETUP_STARTPAGE        = 0x0080;
const sal_uInt16 EXC_SETUP_NOTES_END        = 0x0200;

const sal_uInt16 EXC_PAPERSIZE_DEFAULT      = 0;
const sal_uInt16 EXC_PAPERSIZE_USER         = 0xFFFF;

// Page settings ==============================================================

class SvxBrushItem;

struct XclPageData
{
    XclPageData(const XclPageData&) = delete;
    const XclPageData& operator=(const XclPageData&) = delete;

    typedef std::unique_ptr< SvxBrushItem > SvxBrushItemPtr;

    ScfUInt16Vec        maHorPageBreaks;    
    ScfUInt16Vec        maVerPageBreaks;    
    SvxBrushItemPtr     mxBrushItem;        
    OUString            maHeader;           
    OUString            maFooter;           
    OUString            maHeaderEven;       
    OUString            maFooterEven;       
    double              mfLeftMargin;       
    double              mfRightMargin;      
    double              mfTopMargin;        
    double              mfBottomMargin;     
    double              mfHeaderMargin;     
    double              mfFooterMargin;     
    double              mfHdrLeftMargin;    
    double              mfHdrRightMargin;   
    double              mfFtrLeftMargin;    
    double              mfFtrRightMargin;   
    sal_uInt16          mnPaperSize;        
    sal_uInt16          mnStrictPaperSize;  
    sal_uInt16          mnPaperWidth;       
    sal_uInt16          mnPaperHeight;      
    sal_uInt16          mnCopies;           
    sal_uInt16          mnStartPage;        
    sal_uInt16          mnScaling;          
    sal_uInt16          mnFitToWidth;       
    sal_uInt16          mnFitToHeight;      
    sal_uInt16          mnHorPrintRes;      
    sal_uInt16          mnVerPrintRes;      
    bool                mbUseEvenHF;        
//  bool                mbUseFirstHF;       /// True = use maHeaderFirst/maFooterFirst.  TODO: not implemented yet.
    bool                mbValid;            
    bool                mbPortrait;         
    bool                mbPrintInRows;      
    bool                mbBlackWhite;       
    bool                mbDraftQuality;     
    bool                mbPrintNotes;       
    bool                mbManualStart;      
    bool                mbFitToPages;       
    bool                mbHorCenter;        
    bool                mbVerCenter;        
    bool                mbPrintHeadings;    
    bool                mbPrintGrid;        

    explicit            XclPageData();
                        ~XclPageData();

    void                SetDefaults();

    Size                GetScPaperSize() const;
    void                SetScPaperSize( const Size& rSize, bool bPortrait, bool bStrict = false );
};

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */