Artifact.h

#pragma once
// Copyright (c) 2001-2024 Aspose Pty Ltd. All Rights Reserved.

// C# preprocessor directive: #if !NETCORE


// C# preprocessor directive: #endif


#include <system/object_ext.h>
#include <system/idisposable.h>
#include <system/enum.h>
#include <system/array.h>
#include <drawing/color.h>

#include "Aspose.PDF.Cpp/aspose_pdf_api_defs.h"

namespace Aspose
{
namespace Pdf
{
class ArtifactCollection;
class BackgroundArtifact;
namespace Engine
{
namespace Data
{
class IPdfDictionary;
} // namespace Data
} // namespace Engine
namespace Facades
{
class FormattedText;
} // namespace Facades
class FooterArtifact;
class HeaderArtifact;
enum class HorizontalAlignment;
namespace LogicalStructure
{
class StructureElement;
} // namespace LogicalStructure
class Matrix;
class Operator;
class OperatorCollection;
namespace Operators
{
class ConcatenateMatrix;
class Do;
class GS;
class SelectFont;
class SetRGBColor;
} // namespace Operators
class Page;
class Point;
class Rectangle;
class Resources;
namespace Tests
{
class RegressionTests_v9_3;
} // namespace Tests
namespace Text
{
class TextState;
} // namespace Text
enum class VerticalAlignment;
class WatermarkArtifact;
class XForm;
class XImage;
} // namespace Pdf
} // namespace Aspose
namespace System
{
namespace Collections
{
namespace Generic
{
template <typename, typename> class Dictionary;
template <typename> class List;
} // namespace Generic
} // namespace Collections
namespace IO
{
class Stream;
} // namespace IO
} // namespace System

namespace Aspose {

namespace Pdf {

class ASPOSE_PDF_SHARED_CLASS Artifact : public System::IDisposable
{
    typedef Artifact ThisType;
    typedef System::IDisposable BaseType;
    
    typedef ::System::BaseTypesInfo<BaseType> ThisTypeBaseTypesInfo;
    ASPOSE_PDF_SHARED_RTTI_INFO_DECL();
    
    friend class Aspose::Pdf::LogicalStructure::StructureElement;
    friend class Aspose::Pdf::ArtifactCollection;
    friend class Aspose::Pdf::BackgroundArtifact;
    friend class Aspose::Pdf::FooterArtifact;
    friend class Aspose::Pdf::HeaderArtifact;
    friend class Aspose::Pdf::WatermarkArtifact;
    friend class Aspose::Pdf::Tests::RegressionTests_v9_3;
    
public:

    enum class ArtifactType
    {
        Pagination,
        Layout,
        Page,
        Background,
        Undefined
    };
    
    enum class ArtifactSubtype
    {
        Header,
        Footer,
        Watermark,
        Background,
        Undefined
    };
    
    
protected:

    class ArtifactContext : public System::Object
    {
        typedef ArtifactContext ThisType;
        typedef System::Object BaseType;
        
        typedef ::System::BaseTypesInfo<BaseType> ThisTypeBaseTypesInfo;
        RTTI_INFO_DECL();
        
    public:
    
        System::SharedPtr<Resources> resources;
        System::String fontName;
        System::SharedPtr<Matrix> initialMatrix;
        
        ArtifactContext(System::SharedPtr<Resources> resources, System::SharedPtr<Matrix> matrix, System::String fontName);
        ArtifactContext();
        
    };
    
    class TextAttributes : public System::Object
    {
        typedef TextAttributes ThisType;
        typedef System::Object BaseType;
        
        typedef ::System::BaseTypesInfo<BaseType> ThisTypeBaseTypesInfo;
        RTTI_INFO_DECL();
        
    public:
    
        TextAttributes();
        
    private:
    
        System::Drawing::Color textColor;
        System::String fontResourceName;
        double fontSize;
        
    };
    
    
public:

    ASPOSE_PDF_SHARED_API System::String get_CustomType();
    ASPOSE_PDF_SHARED_API void set_CustomType(System::String value);
    ASPOSE_PDF_SHARED_API System::String get_CustomSubtype();
    ASPOSE_PDF_SHARED_API void set_CustomSubtype(System::String value);
    ASPOSE_PDF_SHARED_API Artifact::ArtifactType get_Type();
    ASPOSE_PDF_SHARED_API void set_Type(Artifact::ArtifactType value);
    ASPOSE_PDF_SHARED_API Artifact::ArtifactSubtype get_Subtype();
    ASPOSE_PDF_SHARED_API void set_Subtype(Artifact::ArtifactSubtype value);
    ASPOSE_PDF_SHARED_API System::SharedPtr<System::Collections::Generic::List<System::SharedPtr<Operator>>> get_Contents();
    ASPOSE_PDF_SHARED_API System::SharedPtr<XForm> get_Form();
    ASPOSE_PDF_SHARED_API System::SharedPtr<Aspose::Pdf::Rectangle> get_Rectangle();
    ASPOSE_PDF_SHARED_API System::SharedPtr<Point> get_Position() const;
    ASPOSE_PDF_SHARED_API void set_Position(System::SharedPtr<Point> value);
    ASPOSE_PDF_SHARED_API double get_RightMargin() const;
    ASPOSE_PDF_SHARED_API void set_RightMargin(double value);
    ASPOSE_PDF_SHARED_API double get_LeftMargin() const;
    ASPOSE_PDF_SHARED_API void set_LeftMargin(double value);
    ASPOSE_PDF_SHARED_API double get_TopMargin() const;
    ASPOSE_PDF_SHARED_API void set_TopMargin(double value);
    ASPOSE_PDF_SHARED_API double get_BottomMargin() const;
    ASPOSE_PDF_SHARED_API void set_BottomMargin(double value);
    ASPOSE_PDF_SHARED_API HorizontalAlignment get_ArtifactHorizontalAlignment() const;
    ASPOSE_PDF_SHARED_API void set_ArtifactHorizontalAlignment(HorizontalAlignment value);
    ASPOSE_PDF_SHARED_API VerticalAlignment get_ArtifactVerticalAlignment() const;
    ASPOSE_PDF_SHARED_API void set_ArtifactVerticalAlignment(VerticalAlignment value);
    ASPOSE_PDF_SHARED_API double get_Rotation();
    ASPOSE_PDF_SHARED_API void set_Rotation(double value);
    ASPOSE_PDF_SHARED_API System::String get_Text();
    ASPOSE_PDF_SHARED_API void set_Text(System::String value);
    ASPOSE_PDF_SHARED_API System::SharedPtr<XImage> get_Image();
    ASPOSE_PDF_SHARED_API double get_Opacity() const;
    ASPOSE_PDF_SHARED_API void set_Opacity(double value);
    ASPOSE_PDF_SHARED_API System::SharedPtr<System::Collections::Generic::List<System::String>> get_Lines();
    ASPOSE_PDF_SHARED_API System::SharedPtr<Aspose::Pdf::Text::TextState> get_TextState() const;
    ASPOSE_PDF_SHARED_API void set_TextState(System::SharedPtr<Aspose::Pdf::Text::TextState> value);
    ASPOSE_PDF_SHARED_API bool get_IsBackground() const;
    ASPOSE_PDF_SHARED_API void set_IsBackground(bool value);
    
    ASPOSE_PDF_SHARED_API Artifact(System::String type, System::String subType);
    ASPOSE_PDF_SHARED_API Artifact(Artifact::ArtifactType type, Artifact::ArtifactSubtype subType);
    
    ASPOSE_PDF_SHARED_API void SetText(System::SharedPtr<Facades::FormattedText> formattedText);
    ASPOSE_PDF_SHARED_API void SetTextAndState(System::String text, System::SharedPtr<Aspose::Pdf::Text::TextState> textState);
    ASPOSE_PDF_SHARED_API void SetPageNumberReplacementString(System::String value);
    ASPOSE_PDF_SHARED_API void SetLinesAndState(System::ArrayPtr<System::String> text, System::SharedPtr<Aspose::Pdf::Text::TextState> textState);
    ASPOSE_PDF_SHARED_API void SetImage(System::SharedPtr<System::IO::Stream> imageStream);
    ASPOSE_PDF_SHARED_API void SetImage(System::String imageName);
    ASPOSE_PDF_SHARED_API void SetPdfPage(System::SharedPtr<Page> page);
    ASPOSE_PDF_SHARED_API void Dispose() override;
    ASPOSE_PDF_SHARED_API System::String GetValue(System::String name);
    ASPOSE_PDF_SHARED_API void SetValue(System::String name, System::String value);
    ASPOSE_PDF_SHARED_API void RemoveValue(System::String name);
    ASPOSE_PDF_SHARED_API void BeginUpdates();
    ASPOSE_PDF_SHARED_API void SaveUpdates();
    
protected:

    double topMargin;
    double bottomMargin;
    double leftMargin;
    double rightMargin;
    HorizontalAlignment horizontalAlignment;
    VerticalAlignment verticalAlignment;
    System::SharedPtr<Engine::Data::IPdfDictionary> engineDict;
    System::WeakPtr<ArtifactCollection> owner;
    System::SharedPtr<System::Collections::Generic::List<System::String>> text;
    System::SharedPtr<Aspose::Pdf::Text::TextState> textState;
    System::SharedPtr<System::IO::Stream> imageStream;
    double opacity;
    static System::String AsposeTag;
    
    System::SharedPtr<Aspose::Pdf::Matrix> get_Matrix();
    System::String get_Tag() const;
    System::String get_Name();
    System::SharedPtr<ArtifactCollection> get_Owner() const;
    void set_Owner(System::SharedPtr<ArtifactCollection> value);
    System::SharedPtr<Aspose::Pdf::Resources> get_Resources() const;
    void set_Resources(System::SharedPtr<Aspose::Pdf::Resources> value);
    System::SharedPtr<Engine::Data::IPdfDictionary> get_EngineDict();
    System::SharedPtr<System::IO::Stream> get_ImageStream();
    
    Artifact(System::SharedPtr<ArtifactCollection> owner, System::SharedPtr<Artifact::ArtifactContext> context, System::SharedPtr<System::Collections::Generic::List<System::SharedPtr<Operator>>> _contents, System::SharedPtr<Engine::Data::IPdfDictionary> _properties);
    
    MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION(Artifact, CODEPORTING_ARGS(System::SharedPtr<ArtifactCollection> owner, System::SharedPtr<Artifact::ArtifactContext> context, System::SharedPtr<System::Collections::Generic::List<System::SharedPtr<Operator>>> _contents, System::SharedPtr<Engine::Data::IPdfDictionary> _properties));
    System::SharedPtr<System::Collections::Generic::List<System::SharedPtr<Operator>>> GetContents();
    virtual ASPOSE_PDF_SHARED_API System::SharedPtr<System::Collections::Generic::List<System::SharedPtr<Operator>>> GetOperators();
    virtual ASPOSE_PDF_SHARED_API void WriteSpecialInfo(System::SharedPtr<XForm> form);
    virtual ASPOSE_PDF_SHARED_API void ModifyContents(System::SharedPtr<OperatorCollection> contents);
    virtual ASPOSE_PDF_SHARED_API System::SharedPtr<Artifact> CreateInstance();
    System::SharedPtr<Artifact> LowLevelClone();
    virtual ASPOSE_PDF_SHARED_API System::SharedPtr<Artifact> Clone();
    
    virtual ASPOSE_PDF_SHARED_API ~Artifact();
    
private:

    bool updateRequest;
    bool updatesDelayed;
    System::String type;
    System::String subType;
    System::SharedPtr<System::Collections::Generic::List<System::SharedPtr<Operator>>> contents;
    System::SharedPtr<Point> position;
    double rotation;
    bool ownsImageStream;
    System::SharedPtr<Page> page;
    System::SharedPtr<Aspose::Pdf::Matrix> matrix;
    System::SharedPtr<System::Collections::Generic::List<System::SharedPtr<Operator>>> customContents;
    System::SharedPtr<Artifact::ArtifactContext> context;
    System::SharedPtr<Operators::ConcatenateMatrix> setMatrixOperator;
    System::SharedPtr<Operators::Do> doOperator;
    System::SharedPtr<Operators::SelectFont> tfOperator;
    System::SharedPtr<Operators::SetRGBColor> rgOperator;
    System::SharedPtr<Operators::GS> gsOperator;
    System::String name;
    System::SharedPtr<System::Collections::Generic::Dictionary<System::String, System::String>> customData;
    System::String tag;
    static System::String AsposeCustomData;
    System::String _pageNumberReplacementString;
    
    double get_Scale();
    
    bool _isBackground;
    
    void CollectOperators();
    System::String AssembleText();
    System::SharedPtr<XImage> SearchImageInForm(System::SharedPtr<XForm> form);
    System::SharedPtr<XImage> GetImage(System::SharedPtr<Aspose::Pdf::Resources> res, System::String name);
    System::SharedPtr<Aspose::Pdf::Text::TextState> TranslateFormattedTextToTextState(System::SharedPtr<Facades::FormattedText> formattedText);
    System::SharedPtr<Aspose::Pdf::Matrix> GetMatrix();
    System::SharedPtr<Aspose::Pdf::Rectangle> GetRect();
    System::SharedPtr<Point> GetPosition();
    System::String SubstPageNumber(System::String text);
    System::String ShowText();
    System::String ShowImage();
    System::String ShowPage();
    System::SharedPtr<System::Collections::Generic::List<System::SharedPtr<Operator>>> SetOpacity();
    void InitializeCustomData();
    void Update();
    
};

} // namespace Pdf
} // namespace Aspose

template<>
struct EnumMetaInfo<Aspose::Pdf::Artifact::ArtifactType>
{
    static const ASPOSE_PDF_SHARED_API std::array<std::pair<Aspose::Pdf::Artifact::ArtifactType, const char_t*>, 5>& values();
};

template<>
struct EnumMetaInfo<Aspose::Pdf::Artifact::ArtifactSubtype>
{
    static const ASPOSE_PDF_SHARED_API std::array<std::pair<Aspose::Pdf::Artifact::ArtifactSubtype, const char_t*>, 5>& values();
};