Commit 0b483e71 authored by Carlos Garcia Campos's avatar Carlos Garcia Campos

2007-09-03 Carlos Garcia Campos <carlosgc@gnome.org>

	* gtk-doc.make:
	* glib/poppler-document.cc:
	* glib/poppler-form-field.cc:
	* glib/poppler-page.cc:
	* glib/reference/poppler-docs.sgml:
	* glib/reference/poppler-sections.txt:
	* glib/reference/poppler.types:
	* glib/reference/tmpl/poppler-action.sgml:
	* glib/reference/tmpl/poppler-attachment.sgml:
	* glib/reference/tmpl/poppler-document.sgml:
	* glib/reference/tmpl/poppler-enums.sgml:
	* glib/reference/tmpl/poppler-form-field.sgml:
	* glib/reference/tmpl/poppler-page.sgml:
	* glib/reference/tmpl/poppler-private.sgml:
	* glib/reference/tmpl/poppler.sgml: Update glib bindings API
	documentation.
parent 289e3893
2007-09-03 Carlos Garcia Campos <carlosgc@gnome.org>
* gtk-doc.make:
* glib/poppler-document.cc:
* glib/poppler-form-field.cc:
* glib/poppler-page.cc:
* glib/reference/poppler-docs.sgml:
* glib/reference/poppler-sections.txt:
* glib/reference/poppler.types:
* glib/reference/tmpl/poppler-action.sgml:
* glib/reference/tmpl/poppler-attachment.sgml:
* glib/reference/tmpl/poppler-document.sgml:
* glib/reference/tmpl/poppler-enums.sgml:
* glib/reference/tmpl/poppler-form-field.sgml:
* glib/reference/tmpl/poppler-page.sgml:
* glib/reference/tmpl/poppler-private.sgml:
* glib/reference/tmpl/poppler.sgml: Update glib bindings API
documentation.
2007-09-02 Albert Astals Cid <aacid@kde.org>
* poppler/PDFDoc.cc: Don't enforce %%EOF at the end of file
......
......@@ -1407,6 +1407,16 @@ poppler_ps_file_free (PopplerPSFile *ps_file)
g_object_unref (ps_file);
}
/**
* poppler_document_get_form_field:
* @document: a #PopplerDocument
* @id: an id of a #PopplerFormField
*
* Returns the #PopplerFormField for the given @id. It must be freed with
* g_object_unref()
*
* Return value: a new #PopplerFormField or NULL if not found
**/
PopplerFormField *
poppler_document_get_form_field (PopplerDocument *document,
gint id)
......
This diff is collapsed.
......@@ -443,7 +443,7 @@ poppler_page_render (PopplerPage *page,
#endif
/**
* poppler_page_render:
* poppler_page_render_to_pixbuf:
* @page: the page to render from
* @src_x: x coordinate of upper left corner
* @src_y: y coordinate of upper left corner
......@@ -515,6 +515,7 @@ poppler_page_get_text_output_dev (PopplerPage *page)
* poppler_page_get_selection_region:
* @page: a #PopplerPage
* @scale: scale specified as pixels per point
* @style: a #PopplerSelectionStyle
* @selection: start and end point of selection as a rectangle
*
* Returns a region containing the area that would be rendered by
......@@ -647,6 +648,7 @@ poppler_page_set_selection_alpha (PopplerPage *page,
* @cairo: cairo context to render to
* @selection: start and end point of selection as a rectangle
* @old_selection: previous selection
* @style: a #PopplerSelectionStyle
* @glyph_color: color to use for drawing glyphs
* @background_color: color to use for the selection background
*
......@@ -731,6 +733,7 @@ poppler_page_render_selection (PopplerPage *page,
* @pixbuf: pixbuf to render to
* @selection: start and end point of selection as a rectangle
* @old_selection: previous selection
* @style: a #PopplerSelectionStyle
* @glyph_color: color to use for drawing glyphs
* @background_color: color to use for the selection background
*
......@@ -895,11 +898,12 @@ poppler_page_get_thumbnail_size (PopplerPage *page,
/**
* poppler_page_get_text:
* @page: a #PopplerPage
* @rect: the rectangle including the text
* @style: a #PopplerSelectionStyle
* @selection: the #PopplerRectangle including the text
*
* Retrieves the contents of the specified rectangle as text
* Retrieves the contents of the specified @selection as text.
*
* Return value: a pointer to the contents of the rectangle
* Return value: a pointer to the contents of the @selection
* as a string
**/
char *
......
......@@ -12,6 +12,8 @@
<xi:include href="xml/poppler-document.xml"/>
<xi:include href="xml/poppler-page.xml"/>
<xi:include href="xml/poppler-action.xml"/>
<xi:include href="xml/poppler-attachment.xml"/>
<xi:include href="xml/poppler-form-field.xml"/>
<xi:include href="xml/poppler-enums.xml"/>
</chapter>
</book>
<SECTION>
<FILE>poppler-page</FILE>
poppler_page_render
poppler_page_render_to_pixbuf
poppler_page_get_size
poppler_page_get_index
poppler_page_get_thumbnail
poppler_page_get_thumbnail_size
poppler_page_find_text
poppler_page_render_to_ps
poppler_page_find_text
poppler_page_get_text
poppler_page_get_duration
poppler_page_get_transition
poppler_page_get_link_mapping
poppler_page_free_link_mapping
poppler_page_get_image_mapping
poppler_page_free_image_mapping
poppler_page_get_form_field_mapping
poppler_page_free_form_field_mapping
poppler_page_get_selection_region
poppler_page_render_selection
poppler_page_render_selection_to_pixbuf
POPPLER_TYPE_RECTANGLE
PopplerRectangle
poppler_rectangle_get_type
poppler_rectangle_new
poppler_rectangle_copy
poppler_rectangle_free
POPPLER_TYPE_PAGE_TRANSITION
PopplerPageTransition
poppler_page_transition_get_type
poppler_page_transition_new
poppler_page_transition_copy
poppler_page_transition_free
POPPLER_TYPE_LINK_MAPPING
PopplerLinkMapping
poppler_link_mapping_get_type
poppler_link_mapping_new
poppler_link_mapping_copy
poppler_link_mapping_free
POPPLER_TYPE_IMAGE_MAPPING
PopplerImageMapping
poppler_image_mapping_get_type
poppler_image_mapping_new
poppler_image_mapping_copy
poppler_image_mapping_free
POPPLER_TYPE_FORM_FIELD_MAPPING
PopplerFormFieldMapping
poppler_form_field_mapping_get_type
poppler_form_field_mapping_new
poppler_form_field_mapping_copy
poppler_form_field_mapping_free
<SUBSECTION Standard>
POPPLER_PAGE
POPPLER_IS_PAGE
......@@ -39,10 +65,15 @@ PopplerFontType
PopplerViewerPreferences
PopplerPermissions
poppler_document_new_from_file
poppler_document_new_from_data
poppler_document_save
poppler_document_get_n_pages
poppler_document_get_page
poppler_document_get_page_by_label
poppler_document_find_dest
poppler_document_has_attachments
poppler_document_get_attachments
poppler_document_get_form_field
poppler_index_iter_get_type
poppler_index_iter_new
poppler_index_iter_copy
......@@ -90,8 +121,69 @@ PopplerAction
POPPLER_TYPE_ACTION
POPPLER_ACTION
poppler_action_get_type
poppler_action_free
poppler_action_copy
poppler_action_free
POPPLER_TYPE_DEST
poppler_dest_get_type
poppler_dest_copy
poppler_dest_free
</SECTION>
<SECTION>
<FILE>poppler-attachment</FILE>
PopplerAttachment
poppler_attachment_save
poppler_attachment_save_to_callback
PopplerAttachmentSaveFunc
<SUBSECTION Standard>
POPPLER_ATTACHMENT
POPPLER_IS_ATTACHMENT
POPPLER_TYPE_ATTACHMENT
poppler_attachment_get_type
</SECTION>
</SECTION>
<SECTION>
<FILE>poppler-form-field</FILE>
PopplerFormField
PopplerFormButtonType
PopplerFormChoiceType
PopplerFormFieldType
PopplerFormTextType
poppler_form_field_get_id
poppler_form_field_get_field_type
poppler_form_field_is_read_only
poppler_form_field_get_font_size
poppler_form_field_button_get_button_type
poppler_form_field_button_get_state
poppler_form_field_button_set_state
poppler_form_field_choice_can_select_multiple
poppler_form_field_choice_commit_on_change
poppler_form_field_choice_do_spell_check
poppler_form_field_choice_get_choice_type
poppler_form_field_choice_get_item
poppler_form_field_choice_get_n_items
poppler_form_field_choice_get_text
poppler_form_field_choice_is_editable
poppler_form_field_choice_is_item_selected
poppler_form_field_choice_select_item
poppler_form_field_choice_set_text
poppler_form_field_choice_toggle_item
poppler_form_field_choice_unselect_all
poppler_form_field_text_do_scroll
poppler_form_field_text_do_spell_check
poppler_form_field_text_get_max_len
poppler_form_field_text_get_text
poppler_form_field_text_get_text_type
poppler_form_field_text_is_password
poppler_form_field_text_is_rich_text
poppler_form_field_text_set_text
<SUBSECTION Standard>
POPPLER_FORM_FIELD
POPPLER_IS_FORM_FIELD
POPPLER_TYPE_FORM_FIELD
poppler_form_field_get_type
</SECTION>
<SECTION>
......@@ -110,6 +202,14 @@ POPPLER_TYPE_VIEWER_PREFERENCES
poppler_viewer_preferences_get_type
POPPLER_TYPE_PERMISSIONS
poppler_permissions_get_type
POPPLER_TYPE_SELECTION_STYLE
poppler_selection_style_get_type
POPPLER_TYPE_PAGE_TRANSITION_TYPE
poppler_page_transition_type_get_type
POPPLER_TYPE_PAGE_TRANSITION_ALIGNMENT
poppler_page_transition_alignment_get_type
POPPLER_TYPE_PAGE_TRANSITION_DIRECTION
poppler_page_transition_direction_get_type
POPPLER_TYPE_ERROR
poppler_error_get_type
POPPLER_TYPE_ORIENTATION
......@@ -128,6 +228,10 @@ PopplerDocument
PopplerIndexIter
PopplerFontsIter
PopplerRectangle
PopplerSelectionStyle
PopplerPageTransitionType
PopplerPageTransitionAlignment
PopplerPageTransitionDirection
PopplerLinkMapping
PopplerPage
PopplerFontInfo
......
......@@ -2,3 +2,5 @@
poppler_document_get_type
poppler_page_get_type
poppler_attachment_get_type
poppler_form_field_get_type
......@@ -155,20 +155,52 @@ poppler-action
@Returns:
<!-- ##### FUNCTION poppler_action_free ##### -->
<!-- ##### FUNCTION poppler_action_copy ##### -->
<para>
</para>
@action:
@Returns:
<!-- ##### FUNCTION poppler_action_copy ##### -->
<!-- ##### FUNCTION poppler_action_free ##### -->
<para>
</para>
@action:
<!-- ##### MACRO POPPLER_TYPE_DEST ##### -->
<para>
</para>
<!-- ##### FUNCTION poppler_dest_get_type ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION poppler_dest_copy ##### -->
<para>
</para>
@dest:
@Returns:
<!-- ##### FUNCTION poppler_dest_free ##### -->
<para>
</para>
@dest:
<!-- ##### SECTION Title ##### -->
PopplerAttachment
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT PopplerAttachment ##### -->
<para>
</para>
<!-- ##### FUNCTION poppler_attachment_save ##### -->
<para>
</para>
@attachment:
@filename:
@error:
@Returns:
<!-- ##### FUNCTION poppler_attachment_save_to_callback ##### -->
<para>
</para>
@attachment:
@save_func:
@user_data:
@error:
@Returns:
<!-- ##### USER_FUNCTION PopplerAttachmentSaveFunc ##### -->
<para>
Specifies the type of the function passed to
poppler_attachment_save_to_callback(). It is called once for each block of
bytes that is "written" by poppler_attachment_save_to_callback(). If
successful it should return %TRUE. If an error occurs it should set
@error and return %FALSE, in which case poppler_attachment_save_to_callback()
will fail with the same error.
</para>
@buf: buffer containing bytes to be written.
@count: number of bytes in @buf.
@data: A location to return an error.
@error: user data passed to poppler_attachment_save_to_callback()
@Returns: %TRUE if successful, %FALSE (with @error set) if failed.
......@@ -96,6 +96,18 @@ The #PopplerDocument is an object used to refer to a main document.
@Returns:
<!-- ##### FUNCTION poppler_document_new_from_data ##### -->
<para>
</para>
@data:
@length:
@password:
@error:
@Returns:
<!-- ##### FUNCTION poppler_document_save ##### -->
<para>
......@@ -136,6 +148,44 @@ The #PopplerDocument is an object used to refer to a main document.
@Returns:
<!-- ##### FUNCTION poppler_document_find_dest ##### -->
<para>
</para>
@document:
@link_name:
@Returns:
<!-- ##### FUNCTION poppler_document_has_attachments ##### -->
<para>
</para>
@document:
@Returns:
<!-- ##### FUNCTION poppler_document_get_attachments ##### -->
<para>
</para>
@document:
@Returns:
<!-- ##### FUNCTION poppler_document_get_form_field ##### -->
<para>
</para>
@document:
@id:
@Returns:
<!-- ##### FUNCTION poppler_index_iter_get_type ##### -->
<para>
......
......@@ -122,6 +122,66 @@ poppler-enums
@Returns:
<!-- ##### MACRO POPPLER_TYPE_SELECTION_STYLE ##### -->
<para>
</para>
<!-- ##### FUNCTION poppler_selection_style_get_type ##### -->
<para>
</para>
@Returns:
<!-- ##### MACRO POPPLER_TYPE_PAGE_TRANSITION_TYPE ##### -->
<para>
</para>
<!-- ##### FUNCTION poppler_page_transition_type_get_type ##### -->
<para>
</para>
@Returns:
<!-- ##### MACRO POPPLER_TYPE_PAGE_TRANSITION_ALIGNMENT ##### -->
<para>
</para>
<!-- ##### FUNCTION poppler_page_transition_alignment_get_type ##### -->
<para>
</para>
@Returns:
<!-- ##### MACRO POPPLER_TYPE_PAGE_TRANSITION_DIRECTION ##### -->
<para>
</para>
<!-- ##### FUNCTION poppler_page_transition_direction_get_type ##### -->
<para>
</para>
@Returns:
<!-- ##### MACRO POPPLER_TYPE_ERROR ##### -->
<para>
......
<!-- ##### SECTION Title ##### -->
PopplerFormField
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT PopplerFormField ##### -->
<para>
</para>
<!-- ##### ENUM PopplerFormButtonType ##### -->
<para>
</para>
@POPPLER_FORM_BUTTON_PUSH:
@POPPLER_FORM_BUTTON_CHECK:
@POPPLER_FORM_BUTTON_RADIO:
<!-- ##### ENUM PopplerFormChoiceType ##### -->
<para>
</para>
@POPPLER_FORM_CHOICE_COMBO:
@POPPLER_FORM_CHOICE_LIST:
<!-- ##### ENUM PopplerFormFieldType ##### -->
<para>
</para>
@POPPLER_FORM_FIELD_UNKNOWN:
@POPPLER_FORM_FIELD_BUTTON:
@POPPLER_FORM_FIELD_TEXT:
@POPPLER_FORM_FIELD_CHOICE:
@POPPLER_FORM_FIELD_SIGNATURE:
<!-- ##### ENUM PopplerFormTextType ##### -->
<para>
</para>
@POPPLER_FORM_TEXT_NORMAL:
@POPPLER_FORM_TEXT_MULTILINE:
@POPPLER_FORM_TEXT_FILE_SELECT:
<!-- ##### FUNCTION poppler_form_field_get_id ##### -->
<para>
</para>
@field:
@Returns:
<!-- ##### FUNCTION poppler_form_field_get_field_type ##### -->
<para>
</para>
@field:
@Returns:
<!-- ##### FUNCTION poppler_form_field_is_read_only ##### -->
<para>
</para>
@field:
@Returns:
<!-- ##### FUNCTION poppler_form_field_get_font_size ##### -->
<para>
</para>
@field:
@Returns:
<!-- ##### FUNCTION poppler_form_field_button_get_button_type ##### -->
<para>
</para>
@field:
@Returns:
<!-- ##### FUNCTION poppler_form_field_button_get_state ##### -->
<para>
</para>
@field:
@Returns:
<!-- ##### FUNCTION poppler_form_field_button_set_state ##### -->
<para>
</para>
@field:
@state:
<!-- ##### FUNCTION poppler_form_field_choice_can_select_multiple ##### -->
<para>
</para>
@field:
@Returns:
<!-- ##### FUNCTION poppler_form_field_choice_commit_on_change ##### -->
<para>
</para>
@field:
@Returns:
<!-- ##### FUNCTION poppler_form_field_choice_do_spell_check ##### -->
<para>
</para>
@field:
@Returns:
<!-- ##### FUNCTION poppler_form_field_choice_get_choice_type ##### -->
<para>
</para>
@field:
@Returns:
<!-- ##### FUNCTION poppler_form_field_choice_get_item ##### -->
<para>
</para>
@field:
@index:
@Returns:
<!-- ##### FUNCTION poppler_form_field_choice_get_n_items ##### -->
<para>
</para>
@field:
@Returns:
<!-- ##### FUNCTION poppler_form_field_choice_get_text ##### -->
<para>
</para>
@field:
@Returns:
<!-- ##### FUNCTION poppler_form_field_choice_is_editable ##### -->
<para>
</para>
@field:
@Returns:
<!-- ##### FUNCTION poppler_form_field_choice_is_item_selected ##### -->
<para>
</para>
@field:
@index:
@Returns:
<!-- ##### FUNCTION poppler_form_field_choice_select_item ##### -->
<para>
</para>
@field:
@index:
<!-- ##### FUNCTION poppler_form_field_choice_set_text ##### -->
<para>
</para>
@field:
@text:
<!-- ##### FUNCTION poppler_form_field_choice_toggle_item ##### -->
<para>
</para>
@field:
@index:
<!-- ##### FUNCTION poppler_form_field_choice_unselect_all ##### -->
<para>
</para>
@field: