# ipe::PdfDict Class Reference
Ipe Base

The PDF dictionary and stream objects. More...

`#include <ipepdfparser.h>`

Inherits ipe::PdfObj.

List of all members.

## Classes

- struct Item

## Public Member Functions

- PdfDict ()
- ~PdfDict ()
- virtual const PdfDict * dict () const
- virtual void write (Stream &stream) const
- void setStream (const Buffer &stream)
- void add (String key, const PdfObj *obj)
- const PdfObj * get (String key, const PdfFile *file) const
- int count () const
- String key (int index) const
- Buffer stream () const
- bool deflated () const

## Detailed Description

The PDF dictionary and stream objects.

A dictionary may or may not have attached stream data.

## Constructor & Destructor Documentation

ipe::PdfDict::PdfDict | ( |  | ) | `[inline, explicit]`

PdfDict::~PdfDict | ( |  | ) |

## Member Function Documentation

const PdfDict * PdfDict::dict | ( |  | ) | const`[virtual]`

Return this object as PDF dictionary object.

Reimplemented from ipe::PdfObj.

void PdfDict::write | ( | Stream & | stream | ) | const`[virtual]`

Implements ipe::PdfObj.

void PdfDict::setStream | ( | const Buffer & | stream | ) |

Add stream data to this dictionary.

void PdfDict::add | ( | String | key,
|  | const PdfObj * | obj
| ) |  |

Add a (key, value) pair to the dictionary.

Dictionary takes ownership of obj.

const PdfObj * PdfDict::get | ( | String | key,
|  | const PdfFile * | file
| ) |  | const

Look up key in dictionary.

Indirect objects (references) are looked up if file is not zero, and the object referred to is returned. Returns 0 if key is not in dictionary.

int ipe::PdfDict::count | ( |  | ) | const`[inline]`

String ipe::PdfDict::key | ( | int | index | ) | const`[inline]`

Buffer ipe::PdfDict::stream | ( |  | ) | const`[inline]`

bool PdfDict::deflated | ( |  | ) | const

Is this stream compressed with flate compression?

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

- ipepdfparser.h
- ipepdfparser.cpp