office-gobmx/include/xmloff/xmlstyle.hxx
Noel Grandin 0302c9b192 loplugin:constfields in xmloff
Change-Id: I9623e6b483b28f5b50a2c76016bcc319b375a35a
Reviewed-on: https://gerrit.libreoffice.org/60394
Tested-by: Jenkins
Reviewed-by: Noel Grandin <noel.grandin@collabora.co.uk>
2018-09-13 12:56:39 +02:00

241 lines
8.9 KiB
C++

/* -*- 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 .
*/
#ifndef INCLUDED_XMLOFF_XMLSTYLE_HXX
#define INCLUDED_XMLOFF_XMLSTYLE_HXX
#include <rtl/ref.hxx>
#include <sal/config.h>
#include <xmloff/dllapi.h>
#include <sal/types.h>
#include <svl/style.hxx>
#include <xmloff/xmltkmap.hxx>
#include <xmloff/xmlictxt.hxx>
#include <memory>
class SvXMLStylesContext_Impl;
class SvXMLUnitConverter;
class SvXMLImportPropertyMapper;
namespace com { namespace sun { namespace star {
namespace container { class XNameContainer; }
namespace style { class XAutoStyleFamily; }
} } }
enum XMLStyleStylesElemTokens
{
XML_TOK_STYLE_STYLE,
XML_TOK_STYLE_PAGE_MASTER,
XML_TOK_TEXT_LIST_STYLE,
XML_TOK_TEXT_OUTLINE,
XML_TOK_STYLES_GRADIENTSTYLES,
XML_TOK_STYLES_HATCHSTYLES,
XML_TOK_STYLES_BITMAPSTYLES,
XML_TOK_STYLES_TRANSGRADIENTSTYLES,
XML_TOK_STYLES_MARKERSTYLES,
XML_TOK_STYLES_DASHSTYLES,
XML_TOK_TEXT_NOTE_CONFIG,
XML_TOK_TEXT_BIBLIOGRAPHY_CONFIG,
XML_TOK_TEXT_LINENUMBERING_CONFIG,
XML_TOK_STYLE_DEFAULT_STYLE,
XML_TOK_STYLE_DEFAULT_PAGE_LAYOUT //text grid enhancement
};
class XMLOFF_DLLPUBLIC SvXMLStyleContext : public SvXMLImportContext
{
OUString maName;
OUString maDisplayName;
OUString maAutoName;
OUString maParentName;// Will be moved to XMLPropStyle soon!!!!
OUString maFollow; // Will be moved to XMLPropStyle soon!!!!
bool mbHidden;
sal_uInt16 mnFamily;
bool mbValid : 1; // Set this to false in CreateAndInsert
// if the style shouldn't be processed
// by Finish() or si somehow invalid.
bool mbNew : 1; // Set this to false in CreateAnsInsert
// if the style is already existing.
bool const mbDefaultStyle : 1;
protected:
virtual void SetAttribute( sal_uInt16 nPrefixKey,
const OUString& rLocalName,
const OUString& rValue );
void SetFamily( sal_uInt16 nSet ) { mnFamily = nSet; }
void SetAutoName( const OUString& rName ) { maAutoName = rName; }
public:
SvXMLStyleContext( SvXMLImport& rImport, sal_uInt16 nPrfx,
const OUString& rLName,
const css::uno::Reference< css::xml::sax::XAttributeList >& xAttrList,
sal_uInt16 nFamily=0,
bool bDefaultStyle = false );
virtual ~SvXMLStyleContext() override;
virtual SvXMLImportContextRef CreateChildContext( sal_uInt16 nPrefix,
const OUString& rLocalName,
const css::uno::Reference< css::xml::sax::XAttributeList > & xAttrList ) override;
virtual void StartElement(
const css::uno::Reference< css::xml::sax::XAttributeList > & xAttrList ) override;
const OUString& GetName() const { return maName; }
const OUString& GetDisplayName() const { return maDisplayName.getLength() ? maDisplayName : maName; }
const OUString& GetAutoName() const { return maAutoName; }
const OUString& GetParentName() const { return maParentName; }
const OUString& GetFollow() const { return maFollow; }
sal_uInt16 GetFamily() const { return mnFamily; }
bool IsValid() const { return mbValid; }
void SetValid( bool b ) { mbValid = b; }
bool IsNew() const { return mbNew; }
void SetNew( bool b ) { mbNew = b; }
bool IsHidden() const { return mbHidden; }
// This method is called for every default style
virtual void SetDefaults();
// This method is called for every style. It must create it and insert
// it into the document.
virtual void CreateAndInsert( bool bOverwrite );
// This method is called for every style. It must create it and insert
// it into the document if this hasn't happened already in CreateAndInsert().
virtual void CreateAndInsertLate( bool bOverwrite );
// This method is called fpr every style after all styles have been
// inserted into the document.
virtual void Finish( bool bOverwrite );
bool IsDefaultStyle() const { return mbDefaultStyle; }
/** if this method returns true, its parent styles context
should not add it to its container.<br>
Transient styles can't be accessed from its
parent SvXMLStylesContext after they are imported and
the methods CreateAndInsert(), CreateAndInsertLate()
and Finish() will not be called.
The default return value is false
*/
virtual bool IsTransient() const;
};
class XMLOFF_DLLPUBLIC SvXMLStylesContext : public SvXMLImportContext
{
std::unique_ptr<SvXMLStylesContext_Impl> mpImpl;
std::unique_ptr<SvXMLTokenMap> mpStyleStylesElemTokenMap;
css::uno::Reference< css::container::XNameContainer > mxParaStyles;
css::uno::Reference< css::container::XNameContainer > mxTextStyles;
css::uno::Reference< css::style::XAutoStyleFamily > mxParaAutoStyles;
css::uno::Reference< css::style::XAutoStyleFamily > mxTextAutoStyles;
rtl::Reference < SvXMLImportPropertyMapper > mxParaImpPropMapper;
rtl::Reference < SvXMLImportPropertyMapper > mxTextImpPropMapper;
rtl::Reference < SvXMLImportPropertyMapper > mxShapeImpPropMapper;
mutable rtl::Reference < SvXMLImportPropertyMapper > mxChartImpPropMapper;
mutable rtl::Reference < SvXMLImportPropertyMapper > mxPageImpPropMapper;
SAL_DLLPRIVATE const SvXMLTokenMap& GetStyleStylesElemTokenMap();
SvXMLStylesContext(SvXMLStylesContext &) = delete;
void operator =(SvXMLStylesContext &) = delete;
protected:
sal_uInt32 GetStyleCount() const;
SvXMLStyleContext *GetStyle( sal_uInt32 i );
const SvXMLStyleContext *GetStyle( sal_uInt32 i ) const;
virtual SvXMLStyleContext *CreateStyleChildContext( sal_uInt16 nPrefix,
const OUString& rLocalName,
const css::uno::Reference< css::xml::sax::XAttributeList > & xAttrList );
virtual SvXMLStyleContext *CreateStyleStyleChildContext( sal_uInt16 nFamily,
sal_uInt16 nPrefix, const OUString& rLocalName,
const css::uno::Reference< css::xml::sax::XAttributeList > & xAttrList );
virtual SvXMLStyleContext *CreateDefaultStyleStyleChildContext(
sal_uInt16 nFamily, sal_uInt16 nPrefix,
const OUString& rLocalName,
const css::uno::Reference< css::xml::sax::XAttributeList > & xAttrList );
virtual bool InsertStyleFamily( sal_uInt16 nFamily ) const;
public:
SvXMLStylesContext( SvXMLImport& rImport, sal_uInt16 nPrfx,
const OUString& rLName,
const css::uno::Reference< css::xml::sax::XAttributeList > & xAttrList,
bool bAutomatic = false );
virtual ~SvXMLStylesContext() override;
// Create child element.
virtual SvXMLImportContextRef CreateChildContext( sal_uInt16 nPrefix,
const OUString& rLocalName,
const css::uno::Reference< css::xml::sax::XAttributeList > & xAttrList ) override;
// Override this method to insert styles into the document.
virtual void EndElement() override;
// This allows to add an SvXMLStyleContext to this context from extern
void AddStyle(SvXMLStyleContext& rNew);
const SvXMLStyleContext *FindStyleChildContext(
sal_uInt16 nFamily,
const OUString& rName,
bool bCreateIndex = false ) const;
virtual sal_uInt16 GetFamily( const OUString& rFamily ) const;
virtual rtl::Reference < SvXMLImportPropertyMapper > GetImportPropertyMapper(
sal_uInt16 nFamily ) const;
virtual css::uno::Reference< css::container::XNameContainer >
GetStylesContainer( sal_uInt16 nFamily ) const;
virtual OUString GetServiceName( sal_uInt16 nFamily ) const;
css::uno::Reference< css::style::XAutoStyleFamily >
GetAutoStyles( sal_uInt16 nFamily ) const;
void CopyAutoStylesToDoc();
void CopyStylesToDoc( bool bOverwrite, bool bFinish = true );
void FinishStyles( bool bOverwrite );
// This method must be called to release the references to all styles
// that are stored in the context.
void Clear();
bool IsAutomaticStyle() const;
};
#endif // INCLUDED_XMLOFF_XMLSTYLE_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */