Класс PdfDocument
PdfDocument загружает и хранит документ. Подробнее...
| Подключение: | #include <PdfDocument> |
| Начиная с версии: | AmberPDF 1.0 |
Публичные типы
- enum DocumentStatus { Success, Unknown, FileError, FormatError, ..., InternalError }
Свойства
- fileVersion : const int
- pageCount : const int
- path : const QString
- status : const DocumentStatus
Публичные функции
- PdfDocument(QObject *parent = nullptr)
- virtual ~PdfDocument()
- QFuture<QVector<PdfBookmark> > bookmarks() const
- bool exportDocument(QIODevice *output) const
- int fileVersion() const
- void loadDocument(const QString &fileName, const QString &password = QString())
- void loadDocument(const QByteArray &buffer, const QString &password = QString())
- QFuture<QSharedPointer<PdfPage> > page(int pageIndex) const
- int pageCount() const
- QFuture<QSizeF> pageSize(int index) const
- QString path() const
- bool saveDocumentAs(const QString &path) const
- DocumentStatus status() const
Сигналы
- void fileVersionChanged(int version)
- void pageCountChanged(int pageCount)
- void pathChanged(QString path)
- void statusChanged(PdfDocument::DocumentStatus status)
Подробное описание
PdfDocument загружает и хранит документ.
Загружает выбранную страницу и страницу по размеру индекса. Для управления процессом загрузки документа PdfDocument предоставляет перечисление DocumentStatus.
Описание типов-членов
enum PdfDocument::DocumentStatus
| Константа | Значение |
|---|---|
PdfDocument::Success |
0 |
PdfDocument::Unknown |
1 |
PdfDocument::FileError |
2 |
PdfDocument::FormatError |
3 |
PdfDocument::PasswordError |
4 |
PdfDocument::SecurityError |
5 |
PdfDocument::ContentError |
6 |
PdfDocument::Loading |
99 |
PdfDocument::InternalError |
100 |
Описание свойств
fileVersion : const int
Функции доступа:
- int fileVersion() const
Сигнал уведомления:
- void fileVersionChanged(int version)
pageCount : const int
Функции доступа:
- int pageCount() const
Сигнал уведомления:
- void pageCountChanged(int pageCount)
path : const QString
Функции доступа:
- QString path() const
Сигнал уведомления:
- void pathChanged(QString path)
status : const DocumentStatus
Функции доступа:
- DocumentStatus status() const
Сигнал уведомления:
- void statusChanged(PdfDocument::DocumentStatus status)
Описание функций-членов
PdfDocument::PdfDocument(QObject *parent = nullptr)
По умолчанию создает экземпляр PdfDocument.
[virtual] PdfDocument::~PdfDocument()
Уничтожает экземпляр PdfDocument. Деструктор является виртуальным.
QFuture<QVector<PdfBookmark> > PdfDocument::bookmarks() const
bool PdfDocument::exportDocument(QIODevice *output) const
void PdfDocument::loadDocument(const QString &fileName, const QString &password = QString())
Пробует загрузить документ по заданным fileName и password.
void PdfDocument::loadDocument(const QByteArray &buffer, const QString &password = QString())
QFuture<QSharedPointer<PdfPage> > PdfDocument::page(int pageIndex) const
Возвращается future object, результат которого содержит SharedPointer на PdfPage
по pageIndex.
int PdfDocument::pageCount() const
Количество страниц возвращённого документа.
Примечание. Геттер для свойства pageCount.
[signal] void PdfDocument::pageCountChanged(int pageCount)
Испускается при изменении документа pageCount.
Примечание. Сигнал уведомления для свойства pageCount.
QFuture<QSizeF> PdfDocument::pageSize(int index) const
Возвращает размер страницы по index.
QString PdfDocument::path() const
Возвращенный путь к документу.
Примечание. Геттер для свойства path.
[signal] void PdfDocument::pathChanged(QString path)
Испукается при изменении path у документа.
Примечание. Сигнал уведомления для свойства path.
bool PdfDocument::saveDocumentAs(const QString &path) const
DocumentStatus PdfDocument::status() const
Возврат статуса загрузки документа.
Примечание. Геттер для свойства status.
[signal] void PdfDocument::statusChanged(PdfDocument::DocumentStatus status)
Испускается при изменении status у документа.
Примечание. Сигнал уведомления для свойства status.