SkPDFDict Class Reference

#include <SkPDFTypes.h>

Inheritance diagram for SkPDFDict:

Public Member Functions
	SkPDFDict (const char type[]=nullptr)
	~SkPDFDict () override
void	emitObject (SkWStream *stream) const override
size_t	size () const
void	reserve (int n)
void	insertObject (const char key[], std::unique_ptr< SkPDFObject > &&)
void	insertObject (SkString, std::unique_ptr< SkPDFObject > &&)
void	insertRef (const char key[], SkPDFIndirectReference)
void	insertRef (SkString, SkPDFIndirectReference)
void	insertBool (const char key[], bool value)
void	insertInt (const char key[], int32_t value)
void	insertInt (const char key[], size_t value)
void	insertScalar (const char key[], SkScalar value)
void	insertColorComponentF (const char key[], SkScalar value)
void	insertName (const char key[], const char nameValue[])
void	insertName (const char key[], SkString nameValue)
void	insertByteString (const char key[], const char value[])
void	insertTextString (const char key[], const char value[])
void	insertByteString (const char key[], SkString value)
void	insertTextString (const char key[], SkString value)
void	insertUnion (const char key[], SkPDFUnion &&)
Public Member Functions inherited from SkPDFObject
	SkPDFObject ()=default
virtual	~SkPDFObject ()=default

Detailed Description

A dictionary object in a PDF.

Definition at line 146 of file SkPDFTypes.h.

Constructor & Destructor Documentation

SkPDFDict()

SkPDFDict::SkPDFDict ( const char  type[] = nullptr )

explicit

Create a PDF dictionary.

Parameters

type	The value of the Type entry, nullptr for no type.

Definition at line 444 of file SkPDFTypes.cpp.

                                      {
    if (type) {
        this->insertName("Type", type);
    }
}

~SkPDFDict()

SkPDFDict::~SkPDFDict ( )

override

Definition at line 442 of file SkPDFTypes.cpp.

{}

Member Function Documentation

emitObject()

void SkPDFDict::emitObject ( SkWStream *  stream ) const

overridevirtual

Subclasses must implement this method to print the object to the PDF file.

Parameters

catalog	The object catalog to use.
stream	The writable output stream to send the output to.

Implements SkPDFObject.

Definition at line 450 of file SkPDFTypes.cpp.

                                                  {
    stream->writeText("<<");
    for (size_t i = 0; i < fRecords.size(); ++i) {
        const std::pair<SkPDFUnion, SkPDFUnion>& record = fRecords[i];
        record.first.emitObject(stream);
        stream->writeText(" ");
        record.second.emitObject(stream);
        if (i + 1 < fRecords.size()) {
            stream->writeText("\n");
        }
    }
    stream->writeText(">>");
}

insertBool()

void SkPDFDict::insertBool	(	const char	key[],
		bool	value
	)

Add the value to the dictionary with the given key.

Parameters

key	The text of the key for this dictionary entry.
value	The value for this dictionary entry.

Definition at line 486 of file SkPDFTypes.cpp.

                                                       {
    fRecords.emplace_back(SkPDFUnion::Name(key), SkPDFUnion::Bool(value));
}

insertByteString() [1/2]

void SkPDFDict::insertByteString	(	const char	key[],
		const char	value[]
	)

Definition at line 514 of file SkPDFTypes.cpp.

                                                                     {
    fRecords.emplace_back(SkPDFUnion::Name(key), SkPDFUnion::ByteString(value));
}

insertByteString() [2/2]

void SkPDFDict::insertByteString	(	const char	key[],
		SkString	value
	)

Definition at line 522 of file SkPDFTypes.cpp.

                                                                 {
    fRecords.emplace_back(SkPDFUnion::Name(key), SkPDFUnion::ByteString(std::move(value)));
}

insertColorComponentF()

void SkPDFDict::insertColorComponentF	(	const char	key[],
		SkScalar	value
	)

Definition at line 498 of file SkPDFTypes.cpp.

                                                                      {
    fRecords.emplace_back(SkPDFUnion::Name(key), SkPDFUnion::ColorComponentF(value));
}

insertInt() [1/2]

void SkPDFDict::insertInt	(	const char	key[],
		int32_t	value
	)

Definition at line 490 of file SkPDFTypes.cpp.

                                                         {
    fRecords.emplace_back(SkPDFUnion::Name(key), SkPDFUnion::Int(value));
}

insertInt() [2/2]

void SkPDFDict::insertInt	(	const char	key[],
		size_t	value
	)

Definition at line 494 of file SkPDFTypes.cpp.

                                                        {
    this->insertInt(key, SkToS32(value));
}

insertName() [1/2]

void SkPDFDict::insertName	(	const char	key[],
		const char	nameValue[]
	)

Definition at line 506 of file SkPDFTypes.cpp.

                                                              {
    fRecords.emplace_back(SkPDFUnion::Name(key), SkPDFUnion::Name(name));
}

insertName() [2/2]

void SkPDFDict::insertName	(	const char	key[],
		SkString	nameValue
	)

Definition at line 510 of file SkPDFTypes.cpp.

                                                          {
    fRecords.emplace_back(SkPDFUnion::Name(key), SkPDFUnion::Name(std::move(name)));
}

insertObject() [1/2]

void SkPDFDict::insertObject	(	const char	key[],
		std::unique_ptr< SkPDFObject > &&	objSp
	)

Add the value to the dictionary with the given key.

Parameters

key	The text of the key for this dictionary entry.
value	The value for this dictionary entry.

Definition at line 478 of file SkPDFTypes.cpp.

                                                                                 {
    fRecords.emplace_back(SkPDFUnion::Name(key), SkPDFUnion::Object(std::move(objSp)));
}

insertObject() [2/2]

void SkPDFDict::insertObject	(	SkString	key,
		std::unique_ptr< SkPDFObject > &&	objSp
	)

Definition at line 481 of file SkPDFTypes.cpp.

                                                                             {
    fRecords.emplace_back(SkPDFUnion::Name(std::move(key)),
                          SkPDFUnion::Object(std::move(objSp)));
}

insertRef() [1/2]

void SkPDFDict::insertRef	(	const char	key[],
		SkPDFIndirectReference	ref
	)

Definition at line 470 of file SkPDFTypes.cpp.

                                                                      {
    fRecords.emplace_back(SkPDFUnion::Name(key), SkPDFUnion::Ref(ref));
}

insertRef() [2/2]

void SkPDFDict::insertRef	(	SkString	key,
		SkPDFIndirectReference	ref
	)

Definition at line 474 of file SkPDFTypes.cpp.

                                                                  {
    fRecords.emplace_back(SkPDFUnion::Name(std::move(key)), SkPDFUnion::Ref(ref));
}

insertScalar()

void SkPDFDict::insertScalar	(	const char	key[],
		SkScalar	value
	)

Definition at line 502 of file SkPDFTypes.cpp.

                                                             {
    fRecords.emplace_back(SkPDFUnion::Name(key), SkPDFUnion::Scalar(value));
}

insertTextString() [1/2]

void SkPDFDict::insertTextString	(	const char	key[],
		const char	value[]
	)

Definition at line 518 of file SkPDFTypes.cpp.

                                                                     {
    fRecords.emplace_back(SkPDFUnion::Name(key), SkPDFUnion::TextString(value));
}

insertTextString() [2/2]

void SkPDFDict::insertTextString	(	const char	key[],
		SkString	value
	)

Definition at line 526 of file SkPDFTypes.cpp.

                                                                 {
    fRecords.emplace_back(SkPDFUnion::Name(key), SkPDFUnion::TextString(std::move(value)));
}

insertUnion()

void SkPDFDict::insertUnion	(	const char	key[],
		SkPDFUnion &&	value
	)

Definition at line 530 of file SkPDFTypes.cpp.

                                                                {
    fRecords.emplace_back(SkPDFUnion::Name(key), std::move(value));
}

reserve()

void SkPDFDict::reserve

(

int

n

)

Preallocate space for n key-value pairs

Definition at line 466 of file SkPDFTypes.cpp.

                             {
    fRecords.reserve(n);
}

size()

size_t SkPDFDict::size

(

)

const

The size of the dictionary.

Definition at line 464 of file SkPDFTypes.cpp.

{ return fRecords.size(); }

---

The documentation for this class was generated from the following files:

• third_party/skia/src/pdf/SkPDFTypes.h
• third_party/skia/src/pdf/SkPDFTypes.cpp