The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
ODF-lpOD-0.113
River stage one • 2 direct dependents • 2 total dependents
3 ++
/ ODF::lpOD::StructuredContainer

NAME

ODF::lpOD::StructuredContainer - High-level structures other than tables

DESCRIPTION

This manual page is related to the sections, item lists and draw pages. These element types are implemented through the odf_section, odf_list, and odf_draw_page classes, respectively.

Note: In the present development version, odf_section is the only one already implemented.

Sections

A section is a named region in a text document. It's a high level container that can include one or more content elements of any kind (including sections, that may be nested).

The purpose of a section is either to assign certain formatting properties to a document region, or to include an external content.

A section is created using odf_create_section with a mandatory name as the first argument and the following optional parameters:

  • style: the name of a section style, already existing or to be defined;

  • url : the URL of an external resource that will provide the content of the section;

  • protected: a boolean that, if TRUE, means that the section should be write-protected when the document is edited through a user-oriented, interactive application (of course, such a protection doesn't prevent an lpOD-based tool from modifying the table)(default is FALSE);

  • protection key: a (supposedly encrypted) string that represents a password; if this parameter is set and if protected is TRUE, a end-user interactive application should ask for a password that matches this string before removing the write-protection (beware, such a protection is not a security feature);

  • display: boolean, tells that the section should be visible (default is TRUE).

A new section may be inserted or appended somewhere using insert_element or append_element. (Of course, an existing section may be copied and pasted thanks to the common clone method.)

A section may be retrieved using get_section with the unique name of the needed section as argument, while get_section_list returns all the sections (if any) of the context.

COPYRIGHT & LICENSE

Copyright (c) 2010 Ars Aperta, Itaapy, Pierlis, Talend.

This work was sponsored by the Agence Nationale de la Recherche (http://www.agence-nationale-recherche.fr).

lpOD is free software; you can redistribute it and/or modify it under the terms of either:

a) the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. lpOD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with lpOD. If not, see http://www.gnu.org/licenses/.

b) the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0