reffld.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 .
 */
#ifndef INCLUDED_SW_INC_REFFLD_HXX
#define INCLUDED_SW_INC_REFFLD_HXX
 
#include <tools/solar.h>
 
#include "fldbas.hxx"
 
class SfxPoolItem;
class SwDoc;
class SwTextNode;
class SwTextField;
class SwRootFrame;
 
bool IsFrameBehind( const SwTextNode& rMyNd, sal_Int32 nMySttPos,
                    const SwTextNode& rBehindNd, sal_Int32 nSttPos );
 
enum REFERENCESUBTYPE
{
    REF_SETREFATTR = 0,
    REF_SEQUENCEFLD,
    REF_BOOKMARK,
    REF_OUTLINE,
    REF_FOOTNOTE,
    REF_ENDNOTE
};
 
enum REFERENCEMARK
{
    REF_BEGIN,
    REF_PAGE = REF_BEGIN, 
    REF_CHAPTER,          
    REF_CONTENT,          
    REF_UPDOWN,           
    REF_PAGE_PGDESC,      
    REF_ONLYNUMBER,       
    REF_ONLYCAPTION,      
    REF_ONLYSEQNO,        
    // --> #i81002#
    REF_NUMBER,              
    REF_NUMBER_NO_CONTEXT,   
    REF_NUMBER_FULL_CONTEXT, 
};
 
 
class SAL_DLLPUBLIC_RTTI SwGetRefFieldType final : public SwFieldType
{
    SwDoc& m_rDoc;
 
    virtual void SwClientNotify(const SwModify&, const SfxHint&) override;
public:
    SwGetRefFieldType(SwDoc& rDoc );
    virtual std::unique_ptr<SwFieldType> Copy() const override;
    virtual void UpdateFields() override {};
 
    SwDoc&                  GetDoc() const { return m_rDoc; }
 
    void MergeWithOtherDoc( SwDoc& rDestDoc );
 
    static SwTextNode* FindAnchor( SwDoc* pDoc, const OUString& rRefMark,
                                        sal_uInt16 nSubType, sal_uInt16 nSeqNo,
                                        sal_Int32* pStt, sal_Int32* pEnd = nullptr,
                                        SwRootFrame const* pLayout = nullptr);
    void UpdateGetReferences();
};
 
class SW_DLLPUBLIC SwGetRefField final : public SwField
{
private:
    OUString m_sSetRefName;
    OUString m_sSetReferenceLanguage;
    OUString m_sText;         
    OUString m_sTextRLHidden; 
    sal_uInt16 m_nSubType;
    sal_uInt16 m_nSeqNo;
 
    virtual OUString    ExpandImpl(SwRootFrame const* pLayout) const override;
    virtual std::unique_ptr<SwField> Copy() const override;
 
public:
    SwGetRefField( SwGetRefFieldType*, OUString aSetRef, OUString aReferenceLanguage,
                    sal_uInt16 nSubType, sal_uInt16 nSeqNo, sal_uLong nFormat );
 
    virtual ~SwGetRefField() override;
 
    virtual OUString GetFieldName() const override;
 
    const OUString& GetSetRefName() const { return m_sSetRefName; }
 
    // #i81002#
    void                UpdateField( const SwTextField* pFieldTextAttr );
 
    void                SetExpand( const OUString& rStr );
 
    virtual sal_uInt16      GetSubType() const override;
    virtual void        SetSubType( sal_uInt16 n ) override;
 
    // --> #i81002#
    bool IsRefToHeadingCrossRefBookmark() const;
    bool IsRefToNumItemCrossRefBookmark() const;
    const SwTextNode* GetReferencedTextNode() const;
    // #i85090#
    OUString GetExpandedTextOfReferencedTextNode(SwRootFrame const& rLayout) const;
 
    sal_uInt16              GetSeqNo() const        { return m_nSeqNo; }
    void                SetSeqNo( sal_uInt16 n )    { m_nSeqNo = n; }
 
    // Name of reference.
    virtual OUString    GetPar1() const override;
    virtual void        SetPar1(const OUString& rStr) override;
 
    virtual OUString    GetPar2() const override;
    virtual bool        QueryValue( css::uno::Any& rVal, sal_uInt16 nWhichId ) const override;
    virtual bool        PutValue( const css::uno::Any& rVal, sal_uInt16 nWhichId ) override;
 
    void                ConvertProgrammaticToUIName();
 
    virtual OUString    GetDescription() const override;
};
 
#endif 
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */