postit.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 <rtl/ustring.hxx>
#include <svl/itemset.hxx>
#include <rtl/ref.hxx>
#include "address.hxx"
#include "scdllapi.h"
 
#include <memory>
#include <string_view>
 
class EditTextObject;
class OutlinerParaObject;
class SdrCaptionObj;
class SdrPage;
 
class ScDocument;
namespace tools { class Rectangle; }
struct ScCaptionInitData;
 
struct ScNoteData
{
    typedef std::shared_ptr< ScCaptionInitData > ScCaptionInitDataRef;
 
    OUString     maDate;             
    OUString     maAuthor;           
    ScCaptionInitDataRef mxInitData;        
    rtl::Reference<SdrCaptionObj> mxCaption;          
    bool                mbShown;            
 
    explicit            ScNoteData( bool bShown = false );
};
 
class SC_DLLPUBLIC ScPostIt
{
public:
    static sal_uInt32 mnLastPostItId;
 
    explicit            ScPostIt( ScDocument& rDoc, const ScAddress& rPos, sal_uInt32 nPostItId = 0 );
 
    explicit            ScPostIt( ScDocument& rDoc, const ScAddress& rPos, const ScPostIt& rNote, sal_uInt32 nPostItId = 0  );
 
    explicit            ScPostIt(
                            ScDocument& rDoc, const ScAddress& rPos,
                            ScNoteData aNoteData, bool bAlwaysCreateCaption, sal_uInt32 nPostItId = 0  );
 
                        ~ScPostIt();
 
    std::unique_ptr<ScPostIt> Clone(
                            const ScAddress& rOwnPos,
                            ScDocument& rDestDoc, const ScAddress& rDestPos,
                            bool bCloneCaption ) const;
 
    sal_uInt32 GetId() const { return mnPostItId; }
 
    const ScNoteData& GetNoteData() const { return maNoteData;}
 
    const OUString& GetDate() const { return maNoteData.maDate;}
    void SetDate( const OUString& rDate );
 
    const OUString& GetAuthor() const { return maNoteData.maAuthor;}
    void SetAuthor( const OUString& rAuthor );
 
    void                AutoStamp();
 
    const OutlinerParaObject* GetOutlinerObject() const;
    const EditTextObject* GetEditTextObject() const;
 
    OUString     GetText() const;
    bool                HasMultiLineText() const;
    void                SetText( const ScAddress& rPos, const OUString& rText );
 
    SdrCaptionObj*      GetCaption() const { return maNoteData.mxCaption.get();}
    SdrCaptionObj*      GetOrCreateCaption( const ScAddress& rPos ) const;
 
    void                ForgetCaption( bool bPreserveData = false );
 
    void                ShowCaption( const ScAddress& rPos, bool bShow );
    bool IsCaptionShown() const { return maNoteData.mbShown;}
 
    void                ShowCaptionTemp( const ScAddress& rPos, bool bShow = true );
 
    void                UpdateCaptionPos( const ScAddress& rPos );
 
private:
                        ScPostIt( const ScPostIt& ) = delete;
    ScPostIt&           operator=( const ScPostIt& ) = delete;
 
    void                CreateCaptionFromInitData( const ScAddress& rPos ) const;
    void                CreateCaption( const ScAddress& rPos, const SdrCaptionObj* pCaption = nullptr );
    void                RemoveCaption();
 
private:
    ScDocument&         mrDoc;              
    mutable ScNoteData  maNoteData;         
    sal_uInt32          mnPostItId;
};
 
class SC_DLLPUBLIC ScNoteUtil
{
public:
 
    static rtl::Reference<SdrCaptionObj> CreateTempCaption( ScDocument& rDoc, const ScAddress& rPos,
                            SdrPage& rDrawPage, std::u16string_view rUserText,
                            const tools::Rectangle& rVisRect, bool bTailFront );
 
    static ScPostIt*    CreateNoteFromCaption(
                            ScDocument& rDoc, const ScAddress& rPos,
                            SdrCaptionObj* pCaption );
 
    static ScPostIt*    CreateNoteFromObjectData(
                            ScDocument& rDoc, const ScAddress& rPos,
                            SfxItemSet&& oItemSet,
                            const OutlinerParaObject& rOutlinerObj,
                            const tools::Rectangle& rCaptionRect, bool bShown );
 
    static ScPostIt*    CreateNoteFromString(
                            ScDocument& rDoc, const ScAddress& rPos,
                            const OUString& rNoteText, bool bShown,
                            bool bAlwaysCreateCaption, sal_uInt32 nPostItId = 0 );
 
};
 
namespace sc {
 
struct NoteEntry
{
    ScAddress maPos;
    const ScPostIt* mpNote;
 
    NoteEntry( const ScAddress& rPos, const ScPostIt* pNote );
};
 
}
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */