Различия
Здесь показаны различия между двумя версиями данной страницы.
| Предыдущая версия справа и слева Предыдущая версия Следующая версия | Предыдущая версия | ||
|
wiki:pypdf_documentation [2012/07/27 16:02] [Класс PageObject] |
wiki:pypdf_documentation [2012/09/18 22:21] (текущий) [Класс PageObject] |
||
|---|---|---|---|
| Строка 1: | Строка 1: | ||
| - | ====== Документация к pyPDF (в процессе перевода на русский) ====== | + | ====== Документация к pyPDF ====== |
| - | <note important>Если вы попали сюда, не злитесь из-за того, что не все переведено. Перевод документации - дело довольно непростое. Нужно быть внимательным к мелочам, что я и стараюсь делать.</note> | + | <note warning>Это любительский перевод документации. Не стоит относится к нему со 100%-ным доверием.</note> |
| + | <note important>Много оригинальных английских предложений есть в сносках (активируются при наведении.)</note> | ||
| - | ''**[[pypdf_documentation#класс_destination|Destination(title, page, typ, *args)]]** (класс)'' | + | ''**[[#класс_destination|Destination(title, page, typ, *args)]]** (класс)'' |
| <колонки 60% 5%><новаяколонка> | <колонки 60% 5%><новаяколонка> | ||
| Класс олицетворяет //пункт назначения// в PDF файле. | Класс олицетворяет //пункт назначения// в PDF файле. | ||
| Строка 9: | Строка 10: | ||
| </колонки> | </колонки> | ||
| - | '' **[[pypdf_documentation#класс_documentinformation|DocumentInformation()]]** (класс) '' | + | '' **[[#класс_documentinformation|DocumentInformation()]]** (класс) '' |
| <колонки 60% 5%><новаяколонка> | <колонки 60% 5%><новаяколонка> | ||
| Класс предоставляет элементарные метаданные, содержащиеся в PDF файле. | Класс предоставляет элементарные метаданные, содержащиеся в PDF файле. | ||
| Строка 15: | Строка 16: | ||
| </колонки> | </колонки> | ||
| - | '' **[[pypdf_documentation#класс_pageobject|PageObject(pdf)]]** (класс) '' | + | '' **[[#класс_pageobject|PageObject(pdf)]]** (класс) '' |
| <колонки 60% 5%><новаяколонка> | <колонки 60% 5%><новаяколонка> | ||
| Класс олицетворяет страницу из PDF файла, одну страницу. | Класс олицетворяет страницу из PDF файла, одну страницу. | ||
| Строка 21: | Строка 22: | ||
| </колонки> | </колонки> | ||
| - | '' **[[pypdf_documentation#класс_pdffilereader|PdfFileReader(stream)]]** (класс) '' | + | '' **[[#класс_pdffilereader|PdfFileReader(stream)]]** (класс) '' |
| <колонки 60% 5%><новаяколонка> | <колонки 60% 5%><новаяколонка> | ||
| Инициализирует объект PdfFileReader. | Инициализирует объект PdfFileReader. | ||
| Строка 29: | Строка 30: | ||
| </колонки> | </колонки> | ||
| - | '' **[[pypdf_documentation#класс_pdffilewriter|PdfFileWriter()]]** (класс) '' | + | '' **[[#класс_pdffilewriter|PdfFileWriter()]]** (класс) '' |
| <колонки 60% 5%><новаяколонка> | <колонки 60% 5%><новаяколонка> | ||
| - | Этот класс поддерживает запись PDF файлов на диск, которые сделаны другим классом: [[pypdf_documentation#класс_pdffilereader|PdfFileReader]]. | + | Этот класс поддерживает запись PDF файлов на диск, которые сделаны другим классом: [[#класс_pdffilereader|PdfFileReader]]. |
| </колонки> | </колонки> | ||
| Строка 52: | Строка 53: | ||
| ((Each item in the outline or each thumbnail image can be associated with a corresponding //destination// in the document, so that the user can jump directly to the destination by clickingwith the mouse.)) | ((Each item in the outline or each thumbnail image can be associated with a corresponding //destination// in the document, so that the user can jump directly to the destination by clickingwith the mouse.)) | ||
| - | [[pypdf_documentation#раздел_821_из_спецификации_pdf|Раздел 8.2.1 вы можете найти здесь]], так как он слишком объемный. | + | [[#раздел_821_из_спецификации_pdf|Раздел 8.2.1 вы можете найти здесь]], так как он слишком объемный. |
| </note> | </note> | ||
| Строка 182: | Строка 183: | ||
| ''**PageObject(pdf)** (класс)'' | ''**PageObject(pdf)** (класс)'' | ||
| <колонки 80% 3%><новаяколонка> | <колонки 80% 3%><новаяколонка> | ||
| - | Класс олицетворяет одиночную страницу в PDF файле. Банально этот объект может быть создан с помощью доступа к функции PdfFileReader.getPage, принадлежащей классу [[pypdf_documentation#класс_pdffilereader|PdfFileReader]]. | + | Класс олицетворяет одиночную страницу в PDF файле. Банально этот объект может быть создан с помощью доступа к функции PdfFileReader.getPage, принадлежащей классу [[#класс_pdffilereader|PdfFileReader]]. |
| </колонки> | </колонки> | ||
| Строка 188: | Строка 189: | ||
| **''artBox''** | **''artBox''** | ||
| <колонки 80% 3%><новаяколонка> | <колонки 80% 3%><новаяколонка> | ||
| - | A rectangle (RectangleObject), expressed in default user space units, defining the extent of the page's meaningful content as intended by the page's creator. | + | Прямоугольник (RectangleObject), выраженный в дефолтных пользовательских единицах измерения, определяющий размеры значимого контента, как было задумано создателем. ((A rectangle (RectangleObject), expressed in default user space units, defining the extent of the page's meaningful content as intended by the page's creator.)) |
| |//Стабильность:// | Добавлено в v1.1, будет существовать во всех будущих 1.х выпусках. | | |//Стабильность:// | Добавлено в v1.1, будет существовать во всех будущих 1.х выпусках. | | ||
| Строка 195: | Строка 196: | ||
| ''**bleedBox**'' | ''**bleedBox**'' | ||
| <колонки 80% 3%><новаяколонка> | <колонки 80% 3%><новаяколонка> | ||
| - | A rectangle (RectangleObject), expressed in default user space units, defining the region to which the contents of the page should be clipped when output in a production enviroment. | + | Прямоугольник (RectangleObject), выраженный в дефолтных пользовательских единицах измерения, определяющий область, в которую контент страницы должен быть обрезан, когда производится вывод в реальный мир. ((A rectangle (RectangleObject), expressed in default user space units, defining the region to which the contents of the page should be clipped when output in a production enviroment.)) |
| |//Стабильность:// | Добавлено в v1.1, будет существовать во всех будущих 1.х выпусках. | | |//Стабильность:// | Добавлено в v1.1, будет существовать во всех будущих 1.х выпусках. | | ||
| Строка 202: | Строка 203: | ||
| **''compressContentStreams()''** | **''compressContentStreams()''** | ||
| <колонки 80% 3%><новаяколонка> | <колонки 80% 3%><новаяколонка> | ||
| - | Compresses the size of this page by joining all content streams and applying a FlateDecode filter. | + | Сжимает размер этой страницы, объединяя все контентные потоки и применяя FlateDecode фильтр.((Compresses the size of this page by joining all content streams and applying a FlateDecode filter.)) |
| |//Стабильность:// |Added in v1.6, will exist for all future v1.x releases. However, it is possible that this function will perform no action if content stream compression becomes "automatic" for some reason. | | |//Стабильность:// |Added in v1.6, will exist for all future v1.x releases. However, it is possible that this function will perform no action if content stream compression becomes "automatic" for some reason. | | ||
| Строка 209: | Строка 210: | ||
| **''cropBox''** | **''cropBox''** | ||
| <колонки 80% 3%><новаяколонка> | <колонки 80% 3%><новаяколонка> | ||
| - | A rectangle (RectangleObject), expressed in default user space units, defining the visible region of default user space. When the page is displayed or printed, its contents are to be clipped (cropped) to this rectangle and then imposed on the output medium in some implementation-defined manner. Default value: same as MediaBox. | + | Прямоугольник (RectangleObject), выраженный в дефолтных пользовательских единицах измерения, определяющий видимую область дефолтного пользовательского пространства. Когда страница отображается, или распечатывается, ее контент должен быть обрезан этим прямоугольником и затем наложен на внешнюю среду каким-нибудь способом.((A rectangle (RectangleObject), expressed in default user space units, defining the visible region of default user space. When the page is displayed or printed, its contents are to be clipped (cropped) to this rectangle and then imposed on the output medium in some implementation-defined manner.)) |
| + | ^Значение по умолчанию:| same as MediaBox.| | ||
| |//Стабильность:// | Добавлено в v1.1, будет существовать во всех будущих 1.х выпусках.| | |//Стабильность:// | Добавлено в v1.1, будет существовать во всех будущих 1.х выпусках.| | ||
| </колонки> | </колонки> | ||
| Строка 216: | Строка 218: | ||
| **''extractText()''** | **''extractText()''** | ||
| <колонки 80% 3%><новаяколонка> | <колонки 80% 3%><новаяколонка> | ||
| - | Locate all text drawing commands, in the order they are provided in the content stream, and extract the text. This works well for some PDF files, but poorly for others, depending on the generator used. This will be refined in the future. Do not rely on the order of text coming out of this function, as it will change if this function is made more sophisticated. | ||
| - | ^//Возвращает:// | a unicode string object | | + | Найти все рисующие текст команды, в порядке их представления в потоке содержания, и извлечь текст. ((Locate all text drawing commands, in the order they are provided in the content stream, and extract the text.)) |
| - | |//Стабильность:// | Добавлено в v1.1, будет существовать во всех будущих 1.х выпусках. May be overhauled to provide more ordered text in the future.| | + | Это хорошо работает для некоторых PDF, но ужасно для других, это зависит от используемого генератора. Это будет усовершенствовано в будущем. Не полагайтесь на порядок текста, исходящий от этой функции, из-за того, что он может изменится при усложнении функции. |
| + | |||
| + | ^//Возвращает:// | unicode string-объект | | ||
| + | |//Стабильность:// | Добавлено в v1.1, будет существовать во всех будущих 1.х выпусках. Может быть переписана с нуля, чтобы предоставить более упорядоченный текст в будущем.| | ||
| </колонки> | </колонки> | ||
| ''**mediaBox**'' | ''**mediaBox**'' | ||
| <колонки 80% 3%><новаяколонка> | <колонки 80% 3%><новаяколонка> | ||
| - | A rectangle (RectangleObject), expressed in default user space units, defining the boundaries of the physical medium on which the page is intended to be displayed or printed. | + | Прямоугольник (RectangleObject), выраженный в дефолтных пользовательских единицах измерения, определяющий границы физической среды, на которой страница предназначена быть показанной или распечатанной.((A rectangle (RectangleObject), expressed in default user space units, defining the boundaries of the physical medium on which the page is intended to be displayed or printed.)) |
| |//Стабильность:// | Добавлено в v1.1, будет существовать во всех будущих 1.х выпусках.| | |//Стабильность:// | Добавлено в v1.1, будет существовать во всех будущих 1.х выпусках.| | ||
| Строка 231: | Строка 235: | ||
| ''**mergePage(page2)**'' | ''**mergePage(page2)**'' | ||
| <колонки 80% 3%><новаяколонка> | <колонки 80% 3%><новаяколонка> | ||
| - | Merges the content streams of two pages into one. Resource references (i.e. fonts) are maintained from both pages. The mediabox/cropbox/etc of this page are not altered. The parameter page's content stream will be added to the end of this page's content stream, meaning that it will be drawn after, or "on top" of this page. | + | Объединяет потоки с контентом двух страниц в один. Ссылки на ресурсы (вроде шрифтов) поддерживаются из обоих страниц. mediabox/cropbox/прочее, принадлежащее этой страницы не изменится. Параметр контентного потока страницы будет добавлен в конец контентного потока этой страницы. Это означает, что все будет дорисовано после, или на вершине этой страницы. |
| - | ^page2 |An instance of {@link #PageObject PageObject} to be merged into this one.| | + | ^page2 | Экземпляр класса [[#класс_pageobject|PageObject]], который нужно объединить с текущим. | |
| - | |//Стабильность:// | Added in v1.4, will exist for all future 1.x releases.| | + | |//Стабильность:// | Добавлено в версии 1.4, будет существовать во всех будущих выпусках. | |
| </колонки> | </колонки> | ||
| Строка 240: | Строка 244: | ||
| **''rotateClockwise(angle)''** | **''rotateClockwise(angle)''** | ||
| <колонки 80% 3%><новаяколонка> | <колонки 80% 3%><новаяколонка> | ||
| - | Rotates a page clockwise by increments of 90 degrees. | ||
| - | ^ angle | Angle to rotate the page. Must be an increment of 90 deg.| | + | Поворачивает страницу по часовой стрелки на число градусов, кратное 90. |
| + | |||
| + | ^angle|Угол на который нужно повернуть страницу. Должен увеличиваться только на 90 градусов за раз.| | ||
| |//Стабильность:// | Добавлено в v1.1, будет существовать во всех будущих 1.х выпусках.| | |//Стабильность:// | Добавлено в v1.1, будет существовать во всех будущих 1.х выпусках.| | ||
| Строка 250: | Строка 255: | ||
| **''rotateCounterClockwise(angle)''** | **''rotateCounterClockwise(angle)''** | ||
| <колонки 80% 3%><новаяколонка> | <колонки 80% 3%><новаяколонка> | ||
| - | Rotates a page counter-clockwise by increments of 90 degrees. | + | Поворачивает страницу против часовой стрелки на число градусов, кратное 90. |
| - | ^angle|Angle to rotate the page. Must be an increment of 90 deg.| | + | ^angle|Угол на который нужно повернуть страницу. Должен увеличиваться только на 90 градусов за раз.| |
| |//Стабильность:// | Добавлено в v1.1, будет существовать во всех будущих 1.х выпусках.| | |//Стабильность:// | Добавлено в v1.1, будет существовать во всех будущих 1.х выпусках.| | ||
| Строка 259: | Строка 264: | ||
| **''trimBox''** | **''trimBox''** | ||
| <колонки 80% 3%><новаяколонка> | <колонки 80% 3%><новаяколонка> | ||
| - | A rectangle (RectangleObject), expressed in default user space units, defining the intended dimensions of the finished page after trimming. | + | Прямоугольник (RectangleObject), выраженный в дефолтных пользовательских единицах измерения, определяющий придуманные вами габариты конечной страницы после обрезки. ((A rectangle (RectangleObject), expressed in default user space units, defining the intended dimensions of the finished page after trimming.)) |
| |//Стабильность:// | Добавлено в v1.1, будет существовать во всех будущих 1.х выпусках. | | |//Стабильность:// | Добавлено в v1.1, будет существовать во всех будущих 1.х выпусках. | | ||
| Строка 301: | Строка 306: | ||
| Возвращает экземпляр DocumentInformation или None, если ничего не существует. | Возвращает экземпляр DocumentInformation или None, если ничего не существует. | ||
| - | ^//Возвращает:// | Экземпляр [[pypdf_documentation#класс_documentinformation|DocumentInformation]] или None если ничего нет.| | + | ^//Возвращает:// | Экземпляр [[#класс_documentinformation|DocumentInformation]] или None если ничего нет.| |
| //Стабильность: Добавлено в версии 1.6. Будет существовать во всех 1.х выпусках.// | //Стабильность: Добавлено в версии 1.6. Будет существовать во всех 1.х выпусках.// | ||
| Строка 340: | Строка 345: | ||
| ^pageNumber| Номер извлекаемой страницы. | | ^pageNumber| Номер извлекаемой страницы. | | ||
| - | ^//Возвращает:// | Экземпляр класса [[pypdf_documentation#класс_pageobject|PageObject]] | | + | ^//Возвращает:// | Экземпляр класса [[#класс_pageobject|PageObject]] | |
| //Стабильность: Добавлено в версии 1.0. Будет существовать во всех 1.х выпусках.// | //Стабильность: Добавлено в версии 1.0. Будет существовать во всех 1.х выпусках.// | ||
| Строка 383: | Строка 388: | ||
| <колонки 80% 3%><новаяколонка> | <колонки 80% 3%><новаяколонка> | ||
| - | Этот класс поддерживает запись PDF объектов на диск, которые сделаны классом [[pypdf_documentation#класс_pdffilereader|PdfFileReader]]. | + | Этот класс поддерживает запись PDF объектов на диск, которые сделаны классом [[#класс_pdffilereader|PdfFileReader]]. |
| </колонки> | </колонки> | ||
| Строка 389: | Строка 394: | ||
| <колонки 80% 3%><новаяколонка> | <колонки 80% 3%><новаяколонка> | ||
| - | Добавляет страницу к этому PDF файлу. Страница обычно получена от экземпляра [[pypdf_documentation#класс_pdffilereader|PdfFileReader]]. | + | Добавляет страницу к этому PDF файлу. Страница обычно получена от экземпляра [[#класс_pdffilereader|PdfFileReader]]. |
| - | ^page|Страницу, которую нужно добавить к документу. Аргумент должен быть экземпляром класса [[pypdf_documentation#класс_pageobject|PageObject]] | | + | ^page|Страницу, которую нужно добавить к документу. Аргумент должен быть экземпляром класса [[#класс_pageobject|PageObject]] | |
| //Стабильность: Добавлено в версии 1.0. Будет существовать во всех 1.х выпусках.// | //Стабильность: Добавлено в версии 1.0. Будет существовать во всех 1.х выпусках.// | ||
