[][src]Crate zathura_plugin_sys

Re-exports

pub use self::zathura_plugin_error_e as zathura_error_t;
pub use self::zathura_document_information_type_e as zathura_document_information_type_t;
pub use self::zathura_adjust_mode_e as zathura_adjust_mode_t;
pub use self::zathura_link_type_e as zathura_link_type_t;
pub use self::zathura_link_destination_type_e as zathura_link_destination_type_t;
pub use self::zathura_form_type_e as zathura_form_type_t;

Structs

_cairo
_cairo_surface
girara_list_s
girara_tree_node_s
zathura_content_type_context_s
zathura_dbus_s
zathura_device_factors_s

Device scaling structure.

zathura_document_information_entry_s
zathura_document_s
zathura_form_s

Form element

zathura_image_buffer_s

Image buffer

zathura_image_s

Image structure

zathura_index_element_s

Index element

zathura_jump_s

Jump

zathura_link_s
zathura_link_target_s
zathura_page_s
zathura_page_widget_class_s
zathura_page_widget_s
zathura_plugin_definition_s
zathura_plugin_functions_s
zathura_plugin_manager_s
zathura_plugin_s
zathura_plugin_version_s
zathura_rectangle_s

Rectangle structure. The coordinate system has its origin in the left upper corner. The x axes goes to the right, the y access goes down.

zathura_render_request_s
zathura_renderer_s
zathura_s

Constants

zathura_adjust_mode_e_ZATHURA_ADJUST_BESTFIT

< Adjust to best-fit

zathura_adjust_mode_e_ZATHURA_ADJUST_INPUTBAR

< Focusing the inputbar

zathura_adjust_mode_e_ZATHURA_ADJUST_MODE_NUMBER

< Number of adjust modes

zathura_adjust_mode_e_ZATHURA_ADJUST_NONE

< No adjustment

zathura_adjust_mode_e_ZATHURA_ADJUST_WIDTH

< Adjust to width

zathura_document_information_type_e_ZATHURA_DOCUMENT_INFORMATION_AUTHOR

< Author of the document

zathura_document_information_type_e_ZATHURA_DOCUMENT_INFORMATION_CREATION_DATE

< Creation data

zathura_document_information_type_e_ZATHURA_DOCUMENT_INFORMATION_CREATOR

< Creator of the document

zathura_document_information_type_e_ZATHURA_DOCUMENT_INFORMATION_KEYWORDS

< Keywords of the document

zathura_document_information_type_e_ZATHURA_DOCUMENT_INFORMATION_MODIFICATION_DATE

< Modification data

zathura_document_information_type_e_ZATHURA_DOCUMENT_INFORMATION_OTHER

< Any other information

zathura_document_information_type_e_ZATHURA_DOCUMENT_INFORMATION_PRODUCER

< Producer of the document

zathura_document_information_type_e_ZATHURA_DOCUMENT_INFORMATION_SUBJECT

< Subject of the document

zathura_document_information_type_e_ZATHURA_DOCUMENT_INFORMATION_TITLE

< Title of the document

zathura_form_type_e_ZATHURA_FORM_CHECKBOX

< Checkbox

zathura_form_type_e_ZATHURA_FORM_TEXTFIELD

< Textfield

zathura_link_destination_type_e_ZATHURA_LINK_DESTINATION_FIT
zathura_link_destination_type_e_ZATHURA_LINK_DESTINATION_FITB
zathura_link_destination_type_e_ZATHURA_LINK_DESTINATION_FITBH
zathura_link_destination_type_e_ZATHURA_LINK_DESTINATION_FITBV
zathura_link_destination_type_e_ZATHURA_LINK_DESTINATION_FITH
zathura_link_destination_type_e_ZATHURA_LINK_DESTINATION_FITR
zathura_link_destination_type_e_ZATHURA_LINK_DESTINATION_FITV
zathura_link_destination_type_e_ZATHURA_LINK_DESTINATION_UNKNOWN
zathura_link_destination_type_e_ZATHURA_LINK_DESTINATION_XYZ
zathura_link_type_e_ZATHURA_LINK_GOTO_DEST

< Links to a page

zathura_link_type_e_ZATHURA_LINK_GOTO_REMOTE

< Links to a page

zathura_link_type_e_ZATHURA_LINK_INVALID

< Invalid type

zathura_link_type_e_ZATHURA_LINK_LAUNCH

< Links to an external source

zathura_link_type_e_ZATHURA_LINK_NAMED

< Links to an external source

zathura_link_type_e_ZATHURA_LINK_NONE

< No action

zathura_link_type_e_ZATHURA_LINK_URI

< Links to an external source

zathura_plugin_error_e_ZATHURA_ERROR_INVALID_ARGUMENTS

< Invalid arguments have been passed

zathura_plugin_error_e_ZATHURA_ERROR_INVALID_PASSWORD

< The provided password is invalid

zathura_plugin_error_e_ZATHURA_ERROR_NOT_IMPLEMENTED

< The called function has not been implemented

zathura_plugin_error_e_ZATHURA_ERROR_OK

< No error occurred

zathura_plugin_error_e_ZATHURA_ERROR_OUT_OF_MEMORY

< Out of memory

zathura_plugin_error_e_ZATHURA_ERROR_UNKNOWN

< An unknown error occurred

Functions

zathura_document_attachment_save

Save document attachment

zathura_document_attachments_get

Get list of attachments

zathura_document_free

Free the document

zathura_document_get_adjust_mode

Returns the adjust mode of the document

zathura_document_get_basename

Returns the basename of the document

zathura_document_get_cell_size

Return the size of a cell from the document's layout table in pixels. Assumes that the table is homogeneous (i.e. every cell has the same dimensions). It takes the current scale into account.

zathura_document_get_current_page_number

Returns the current page number

zathura_document_get_data

Returns the private data of the document

zathura_document_get_device_factors

Return the current device scale factors (guaranteed to be non-zero).

zathura_document_get_document_size

Compute the size of the entire document to be displayed in pixels. Takes into account the scale, the layout of the pages, and the padding between them. It should be equal to the allocation of zathura->ui.page_widget once it's shown.

zathura_document_get_first_page_column

Returns the column for the first page (first column = 1)

zathura_document_get_information

Returns a string of the requested information

zathura_document_get_number_of_pages

Returns the number of pages

zathura_document_get_page

Returns the page at the given index

zathura_document_get_page_offset

Returns the page offset of the document

zathura_document_get_page_padding

Returns the padding in pixels between pages

zathura_document_get_pages_per_row

Returns the number of pages per row

zathura_document_get_password

Returns the password of the document

zathura_document_get_path

Returns the path of the document

zathura_document_get_position_x

Returns the X position, as a value relative to the document width (0=left, 1=right).

zathura_document_get_position_y

Returns the Y position as value relative to the document height (0=top, 1=bottom)

zathura_document_get_rotation

Returns the rotation value of zathura (0..360)

zathura_document_get_scale

Returns the current scale value of the document (based on zoom and screen PPI)

zathura_document_get_uri

Returns the URI of the document

zathura_document_get_viewport_ppi

Return the viewport PPI (pixels per inch: the resolution of the monitor, after scaling with the device factor).

zathura_document_get_viewport_size

Return the size of the viewport in pixels.

zathura_document_get_zoom

Returns the current zoom value of the document

zathura_document_index_generate

Generate the document index

zathura_document_information_entry_free

Frees a document information entry

zathura_document_information_entry_list_new

Creates a list that should be used to store \ref zathura_document_information_entry_t entries

zathura_document_information_entry_new

Creates a new document information entry

zathura_document_open

Open the document

zathura_document_save_as

Save the document

zathura_document_set_adjust_mode

Sets the new adjust mode of the document

zathura_document_set_current_page_number

Sets the number of pages

zathura_document_set_data

Sets the private data of the document

zathura_document_set_device_factors

Set the device scale factors (e.g. for HiDPI). These are generally integers and equal for x and y. These scaling factors are only used when rendering to the screen.

zathura_document_set_number_of_pages

Sets the number of pages

zathura_document_set_page_layout

Sets the layout of the pages in the document

zathura_document_set_page_offset

Sets the new page offset of the document

zathura_document_set_position_x

Sets the X position as a value relative to the document width (0=left, 1=right)

zathura_document_set_position_y

Sets the Y position as a value relative to the document height (0=top, 1=bottom)

zathura_document_set_rotation

Sets the new rotation value

zathura_document_set_viewport_height

Sets the height of the viewport in pixels.

zathura_document_set_viewport_ppi

Sets the viewport PPI (pixels per inch: the resolution of the monitor, after scaling with the device factor).

zathura_document_set_viewport_width

Sets the width of the viewport in pixels.

zathura_document_set_zoom

Sets the new zoom value of the document

zathura_image_buffer_create

Creates an image buffer

zathura_image_buffer_free

Frees the image buffer

zathura_index_element_free

Free index element

zathura_index_element_new

Create new index element

zathura_link_display

Display a link using girara_notify

zathura_link_evaluate

Evaluate link

zathura_link_free

Free link

zathura_link_get_position

Returns the position of the link

zathura_link_get_target

The target value of the link

zathura_link_get_type

Returns the type of the link

zathura_link_new

Creates a new zathura link

zathura_page_form_fields_free

Free list of form fields

zathura_page_form_fields_get

Get list of form fields

zathura_page_free

Frees the page object

zathura_page_get_data

Returns the custom data

zathura_page_get_document

Returns the associated document

zathura_page_get_height

Returns the height of the page

zathura_page_get_index

Returns the set id of the page

zathura_page_get_label

Get page label. Note that the page label might not exist, in this case NULL is returned.

zathura_page_get_text

Get text for selection @param page Page @param rectangle Selection @param error Set to an error value (see \ref zathura_error_t) if an error occurred @return The selected text (needs to be deallocated with g_free)

zathura_page_get_visibility

Returns the visibility of the page

zathura_page_get_width

Returns the width of the page

zathura_page_image_get_cairo

Get image

zathura_page_images_get

Get list of images

zathura_page_links_free

Free page links

zathura_page_links_get

Get page links

zathura_page_new

Get the page object

zathura_page_render

Render page

zathura_page_search_text

Search page

zathura_page_set_data

Sets the custom data

zathura_page_set_height

Sets the new height of the page

zathura_page_set_visibility

Sets the visibility of the page

zathura_page_set_width

Sets the new width of the page

Type Definitions

cairo_surface_t

cairo_surface_t:

cairo_t

cairo_t:

girara_list_t
girara_tree_node_t
zathura_adjust_mode_e

Adjust mode

zathura_content_type_context_t

Context for MIME type detection

zathura_device_factors_t
zathura_document_information_entry_t

Document information entry

zathura_document_information_type_e

Possible information entry types

zathura_document_t

Document

zathura_form_t
zathura_form_type_e

Form type

zathura_image_buffer_t
zathura_image_t
zathura_index_element_t
zathura_jump_t
zathura_link_destination_type_e
zathura_link_t

Link

zathura_link_target_t
zathura_link_type_e

Possible link types

zathura_page_t

Page

zathura_plugin_definition_t
zathura_plugin_document_attachment_save_t

Save attachment to a file

zathura_plugin_document_attachments_get_t

Get list of attachments

zathura_plugin_document_free_t

Frees the document

zathura_plugin_document_get_information_t

Get document information

zathura_plugin_document_index_generate_t

Generates the document index

zathura_plugin_document_open_t

Opens a document

zathura_plugin_document_save_as_t

Save the document

zathura_plugin_error_e

Error types

zathura_plugin_functions_t
zathura_plugin_manager_t

Plugin manager

zathura_plugin_page_clear_t

Free page

zathura_plugin_page_form_fields_get_t

Get form fields

zathura_plugin_page_get_label_t

Get page label.

zathura_plugin_page_get_text_t

Get text for selection

zathura_plugin_page_image_get_cairo_t

Get the image

zathura_plugin_page_images_get_t

Get list of images

zathura_plugin_page_init_t

Gets the page object

zathura_plugin_page_links_get_t

Get links on a page

zathura_plugin_page_render_cairo_t

Renders the page to a cairo surface.

zathura_plugin_page_render_t

Renders the page

zathura_plugin_page_search_text_t

Search text

zathura_plugin_t

Plugin

zathura_plugin_version_t
zathura_rectangle_t
zathura_t

Zathura