Discussion for Home page

Daniel Zwirner — Sun, 20 Oct 2013 20:07:14 -0000

LibPdfFlow

LibPdfFlow is a library used to write PDF files from a C program. The idea behind this library is, to generate PDF
files as simple as HTML files (e.g. reports) on an embedded device with restricted resources.The library is
written in C and uses only libc and libHaru a free, cross platform, open source library for
generating PDF files. LibPdfFlow has only a few features, but it is small and does not need a lot of resources like
latex or similar libraries.

License

Permission to use, copy, modify, and distribute this software for any
purpose with or without fee is hereby granted, provided that the above
copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

Installation

Install libharu and type make.

Example

Hello World

Writes "Hello World" emphasized to the file test.pdf:

FPDF_WRITER * doc = FPDF_doc_new();
FPDF_em_start(doc);
FPDF_out(doc, "Hello World");
FPDF_em_end(doc);
FPDF_render(doc);
FPDF_doc_save(doc, "test.pdf");
FPDF_doc_free(doc);

Simple

The example simple (examples/simple) shows how to use the libpdfflow with a C programm.

mkd2pdf

The example mkd2pdf shows how to convert a markdown document into a PDF. As markdown parser, libsoldout is used.

API

FPDF_doc_new()

FPDF_WRITER * FPDF_doc_new(void)

Description

FPDF_doc_new() create an instance of a document object and initialize it.

Return Value

FPDF_doc_new() return a handle of document object on success and NULL on failure.

Description

FPDF_doc_free() revokes a document object and all resources.

Parameters

doc - The handle of a document object.

FPDF_doc_save()

void FPDF_doc_save(FPDF_WRITER * doc, const char * filename)

Description

Saves the document.

Parameters

doc - The handle of a document object.

filename - The name of the file to save.

FPDF_render()

void FPDF_render(FPDF_WRITER * doc)

Description

Renders the PDF file.

Parameters

doc - The handle of a document object.

FPDF_h_start()

void FPDF_h_start(FPDF_WRITER * doc, int level)

Description

Start a header section. This function corresponds to the HTML tag h1-h4.

Parameters

doc - The handle of a document object.

level - Header level 1-4

Description

End a haeder section. This function corresponds to the HTML tag /h1-/h4.

Parameters

doc - The handle of a document object.

FPDF_em_start()

void FPDF_em_start(FPDF_WRITER * doc);

Description

Start a emphasized section. This function corresponds to the HTML tag em.

Parameters

doc - The handle of a document object.

Description

End a emphasized section. This function corresponds to the HTML tag /em.

Parameters

doc - The handle of a document object.

FPDF_strong_start()

void FPDF_strong_start(FPDF_WRITER * doc);

Description

Start a important text section. This function corresponds to the HTML tag strong.

Parameters

doc - The handle of a document object.

Description

End a important text section. This function corresponds to the HTML tag /strong.

Parameters

doc - The handle of a document object.

FPDF_code_start()

void FPDF_code_start(FPDF_WRITER * doc)

Description

Start a source code section. This function corresponds to the HTML tag code.

Parameters

doc - The handle of a document object.

Description

End a source code section. This function corresponds to the HTML tag /code.

Parameters

doc - The handle of a document object.

FPDF_link_start()

void FPDF_link_start(FPDF_WRITER * doc, const char * link);

Description

Start a link section. This function corresponds to the HTML tag a.

Parameters

doc - The handle of a document object.

link - URL of destination to jump to.

Description

End a link section. This function corresponds to the HTML tag /a.

Parameters

doc - The handle of a document object.

FPDF_list_start()

void FPDF_list_start(FPDF_WRITER * doc, enum FPDF_LIST_STYLE style)

Description

Start a list. This function corresponds to the HTML tag ol or ul. To start a list item, use FPDF_listitem_start().

Parameters

doc - The handle of a document object.

style - One of the following values:

enum FPDF_LIST_STYLE	Description
FPDF_LIST_STYLE_NUMBERS	Numbered list (ol)
FPDF_LIST_STYLE_BULLETS	List with bullets (ul)

Description

End a list. This function corresponds to the HTML tag \ol or \ul.

Parameters

doc - The handle of a document object.

FPDF_listitem_start()

void FPDF_listitem_start(FPDF_WRITER * doc)

Description

Start a list item. This function corresponds to the HTML tag li.

Parameters

doc - The handle of a document object.

Description

End a list item. This function corresponds to the HTML tag \li.

Parameters

doc - The handle of a document object.

FPDF_blockquote_start()

void FPDF_blockquote_start(FPDF_WRITER * doc)

Description

Start a inserted section. This function corresponds to the HTML tag blockquote.

Parameters

doc - The handle of a document object.

Description

End a inserted section. This function corresponds to the HTML tag \blockquote.

Parameters

doc - The handle of a document object.

FPDF_paragraph_start()

void FPDF_paragraph_start(FPDF_WRITER * doc)

Description

Start a paragraph. This function corresponds to the HTML tag p.

Parameters

doc - The handle of a document object.

Description

End a paragraph. This function corresponds to the HTML tag /p.

Parameters

doc - The handle of a document object.

FPDF_pre_start()

void FPDF_pre_start(FPDF_WRITER * doc)

Description

Start a pre formatted section. This function corresponds to the HTML tag pre.

Parameters

doc - The handle of a document object.

Description

End a pre formatted section. This function corresponds to the HTML tag \pre.

Parameters

doc - The handle of a document object.

FPDF_out()

void FPDF_out(FPDF_WRITER * doc, const char * text)

Description

Write some text into the PDF file.

Parameters

doc - The handle of a document object.
text - Text to be written.

FPDF_out2()

void FPDF_out2(FPDF_WRITER * doc, const char * text, int length)

Description

Write some text into the PDF file.

Parameters

doc - The handle of a document object.
text - Text to be written.
length - Length of the text to be written.

FPDF_table_start()

void FPDF_table_start(FPDF_WRITER * doc, int * widths, int count)

Description

Start a table. This function corresponds to the HTML tag table.

Parameters

doc - The handle of a document object.

widths - List with the column widths in % or NULL. If widths is NULL all columns have the same width.

count - Number of entries in widths. If widths is NULL, count is ignored.

Description

End a table. This function corresponds to the HTML tag /table.

Parameters

doc - The handle of a document object.

FPDF_table_row_start()

void FPDF_table_row_start(FPDF_WRITER * doc)

Description

Start a row. This function corresponds to the HTML tag tr.

Parameters

doc - The handle of a document object.

Description

End a row. This function corresponds to the HTML tag /tr.

Parameters

doc - The handle of a document object.

FPDF_table_cell_start()

void FPDF_table_cell_start(FPDF_WRITER * doc)

Description

Start a cell. This function corresponds to the HTML tag td.

Parameters

doc - The handle of a document object.

Description

Start a cell. This function corresponds to the HTML tag /td.

Parameters

doc - The handle of a document object.

FPDF_header()

void FPDF_header(FPDF_WRITER * doc, const char * titel, const char * image)

Description

Add a titel and an image to each page. This function must be called after FPDF_render().

Parameters

doc - The handle of a document object.

titel - Document titel

image - Path to a PNG image or NULL.

FPDF_footer()

void FPDF_footer(FPDF_WRITER * doc)

Description

Add a page numbers to each page. This function must be called after FPDF_render().

Parameters

doc - The handle of a document object.

Home modified by Daniel Zwirner

Daniel Zwirner — Sun, 13 Oct 2013 09:30:14 -0000

Welcome to your wiki!

This is the default page, edit it as you see fit. To add a new page simply reference it within brackets, e.g.: [SamplePage].

The wiki uses Markdown syntax.

Project Members:

Daniel Zwirner (admin)

Recent changes to Home

Discussion for Home page

LibPdfFlow

License

Installation

Example

Hello World

Simple

mkd2pdf

API

FPDF_doc_new()

Description

Return Value

See also

FPDF_doc_free()

Description

Parameters

See also

FPDF_doc_save()

Description

Parameters

FPDF_render()

Description

Parameters

FPDF_h_start()

Description

Parameters

See also

FPDF_h_end()

Description

Parameters

See also

FPDF_em_start()

Description

Parameters

See also

FPDF_em_end()

Description

Parameters

See also

FPDF_strong_start()

Description

Parameters

See also

FPDF_strong_end()

Description

Parameters

See also

FPDF_code_start()

Description

Parameters

See also

FPDF_code_end()

Description

Parameters

See also

FPDF_link_start()

Description

Parameters

See also

FPDF_link_end()

Description

Parameters

See also

FPDF_list_start()

Description

Parameters

See also

FPDF_list_end()

Description

Parameters

See also

FPDF_listitem_start()

Description

Parameters

See also

FPDF_listitem_end()

Description

Parameters

See also