Component files of a document.
Use Document.files to obtain instances of this class.
File indexing is zero-based, i.e. files[0] stands for the very first file.
len(files) might raise NotAvailable when called before receiving a DocInfoMessage.
Component file of a document.
Use Document.files[N] to obtain instances of this class.
Returns: | the component file number. |
---|
File indexing is zero-based, i.e. 0 stands for the very first file.
Attempt to obtain information about the component file.
If wait is true, wait until the information is available.
Raises: |
|
---|
Returns: | the type of the compound file. |
---|
The following types are possible:
Raises: |
|
---|
Returns: | the page number, or None when not applicable. |
---|
Page indexing is zero-based, i.e. 0 stands for the very first page.
Raises: |
|
---|
Returns: | the page, or None when not applicable. |
---|---|
Raises: |
|
Returns: | the compound file size, or None when unknown. |
---|---|
Raises: |
|
Returns: | the compound file identifier, or None. |
---|---|
Raises: |
|
Returns: | the compound file name, or None. |
---|---|
Raises: |
|
Returns: | the compound file title, or None. |
---|---|
Raises: |
|
Returns: | a text describing the contents of the file using the same format as the djvudump command. |
---|
If the information is not available, raise NotAvailable exception. Then, PageInfoMessage messages with empty page_job may be emitted.
Raises NotAvailable: | |
---|---|
see above. |