<html> <head> <title>Interface XDocumentTemplates</title> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <link rel="stylesheet" type="text/css" href="../../../../idl.css"> </head> <body> <div id="adc-idlref"> <a name="_top_"> </a><table class="navimain" border="0" cellpadding="3"> <tr> <td class="navimain"><a href="../module-ix.html" class="navimain">Overview</a></td> <td class="navimain"><a href="module-ix.html" class="navimain">Module</a></td> <td class="navimain"><a href="XDocumentTemplates-xref.html" class="navimain">Use</a></td> <td class="navimainnone">Devguide</td> <td class="navimain"><a href="../../../../index-files/index-1.html" class="navimain">Index</a></td> </tr> </table> <table class="navisub" border="0" cellpadding="0"> <tr> <td class="navisub"><a href="#MethodsSummary" class="navisub">Methods' Summary</a></td> <td class="navisub">Attributes' Summary</td> <td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td> <td class="navisub">Attributes' Details</td> </tr> </table> <hr> <table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;"> <tr> <td><p class="namechain"><a href="../../../../module-ix.html" class="namechain">::</a> <a href="../../../module-ix.html" class="namechain">com</a> :: <a href="../../module-ix.html" class="namechain">sun</a> :: <a href="../module-ix.html" class="namechain">star</a> :: <a href="module-ix.html" class="namechain">frame</a> :: </p> </td> </tr> <tr> <td class="title">interface XDocumentTemplates</td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>provides a high level API to organize document templates </dd> <dd><p> Template informations are saved as links to the original content and organized in groups. This data should be persistent and can be updated by calling special method <a href="XDocumentTemplates.html#update()">update()</a>. A real implementation of this interface can do that on top of an ucb content provider. Method <a href="XDocumentTemplates.html#getContent()">getContent()</a> force that. </p> </dd> </dl> </td> </tr> </table> <hr> <a name="MethodsSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Methods' Summary</td> </tr> <tr> <td class="imsum_left"><a href="#getContent">getContent</a></td> <td class="imsum_right">provides access to the root of internal used hierarchy </td> </tr> <tr> <td class="imsum_left"><a href="#storeTemplate">storeTemplate</a></td> <td class="imsum_right">creates the template with the given name in the given group using the data from the storable </td> </tr> <tr> <td class="imsum_left"><a href="#addTemplate">addTemplate</a></td> <td class="imsum_right">creates the template with the given name in the given group using the given URL </td> </tr> <tr> <td class="imsum_left"><a href="#removeTemplate">removeTemplate</a></td> <td class="imsum_right">remove a template from specified group </td> </tr> <tr> <td class="imsum_left"><a href="#renameTemplate">renameTemplate</a></td> <td class="imsum_right">rename a template inside specified group </td> </tr> <tr> <td class="imsum_left"><a href="#addGroup">addGroup</a></td> <td class="imsum_right">creates a new group </td> </tr> <tr> <td class="imsum_left"><a href="#removeGroup">removeGroup</a></td> <td class="imsum_right">remove an existing group </td> </tr> <tr> <td class="imsum_left"><a href="#renameGroup">renameGroup</a></td> <td class="imsum_right">rename an existing group </td> </tr> <tr> <td class="imsum_left"><a href="#update">update</a></td> <td class="imsum_right">force an update for internal structures </td> </tr> </table> <a name="MethodsDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Methods' Details</td> </tr> <tr> <td class="imdetail"><a name="getContent" class="membertitle">getContent</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">::com::sun::star::<a href="../ucb/module-ix.html">ucb</a>::<a href="../ucb/XContent.html">XContent</a></td> </tr> <tr> <td valign="top"><b>getContent</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>provides access to the root of internal used hierarchy </dd> <dd><p> This content can be used for accessing the groups directly. </p> </dd> <dt><b>Returns</b></dt> <dd>the ucb content for template configuration </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="storeTemplate" class="membertitle">storeTemplate</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">boolean</td> </tr> <tr> <td valign="top"><b>storeTemplate</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> GroupName,</td> </tr> <tr> <td/><td valign="top">[in] string</td> <td valign="bottom"> TemplateName,</td> </tr> <tr> <td/><td valign="top">[in] <a href="XStorable.html">XStorable</a></td> <td valign="bottom"> Storable );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>creates the template with the given name in the given group using the data from the storable </dd> <dt><b>Parameter GroupName</b></dt> <dd>specifies the group </dd> <dt><b>Parameter TemplateName</b></dt> <dd>specifies the template </dd> <dt><b>Parameter Storable</b></dt> <dd>specifies the target </dd> <dt><b>Returns</b></dt> <dd><b>true</b> if operation was successful <br> <b>false</b> otherwise </dd> <dt><b>See also</b></dt> <dd><a href="XDocumentTemplates.html">XDocumentTemplates</a>::<a href="XDocumentTemplates.html#addTemplate">addTemplate()</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="addTemplate" class="membertitle">addTemplate</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">boolean</td> </tr> <tr> <td valign="top"><b>addTemplate</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> GroupName,</td> </tr> <tr> <td/><td valign="top">[in] string</td> <td valign="bottom"> TemplateName,</td> </tr> <tr> <td/><td valign="top">[in] string</td> <td valign="bottom"> SourceURL );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>creates the template with the given name in the given group using the given URL </dd> <dt><b>Parameter GroupName</b></dt> <dd>specifies the group </dd> <dt><b>Parameter TemplateName</b></dt> <dd>specifies the template </dd> <dt><b>Parameter SourceURL</b></dt> <dd>specifies the position of template </dd> <dt><b>Returns</b></dt> <dd><b>true</b> if operation was successful <br> <b>false</b> otherwise </dd> <dt><b>See also</b></dt> <dd><a href="XDocumentTemplates.html">XDocumentTemplates</a>::<a href="XDocumentTemplates.html#storeTemplate">storeTemplate()</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="removeTemplate" class="membertitle">removeTemplate</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">boolean</td> </tr> <tr> <td valign="top"><b>removeTemplate</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> GroupName,</td> </tr> <tr> <td/><td valign="top">[in] string</td> <td valign="bottom"> TemplateName );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>remove a template from specified group </dd> <dt><b>Parameter GroupName</b></dt> <dd>specifies the group which include the template </dd> <dt><b>Parameter TemplateName</b></dt> <dd>specifies the template for delete </dd> <dt><b>Returns</b></dt> <dd><b>true</b> if operation was successful <br> <b>false</b> otherwise </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="renameTemplate" class="membertitle">renameTemplate</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">boolean</td> </tr> <tr> <td valign="top"><b>renameTemplate</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> GroupName,</td> </tr> <tr> <td/><td valign="top">[in] string</td> <td valign="bottom"> OldTemplateName,</td> </tr> <tr> <td/><td valign="top">[in] string</td> <td valign="bottom"> NewTemplateName );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>rename a template inside specified group </dd> <dt><b>Parameter GroupName</b></dt> <dd>specifies the group which include the template </dd> <dt><b>Parameter TemplateName</b></dt> <dd>specifies the template for renaming </dd> <dt><b>Returns</b></dt> <dd><b>true</b> if operation was successful <br> <b>false</b> otherwise </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="addGroup" class="membertitle">addGroup</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">boolean</td> </tr> <tr> <td valign="top"><b>addGroup</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> GroupName );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>creates a new group </dd> <dt><b>Parameter GroupName</b></dt> <dd>the name of the group to be created </dd> <dt><b>Returns</b></dt> <dd><b>true</b> if operation was successful <br> <b>false</b> otherwise </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="removeGroup" class="membertitle">removeGroup</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">boolean</td> </tr> <tr> <td valign="top"><b>removeGroup</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> GroupName );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>remove an existing group </dd> <dt><b>Parameter GroupName</b></dt> <dd>the name of the group to be removed </dd> <dt><b>Returns</b></dt> <dd><b>true</b> if operation was successful <br> <b>false</b> otherwise </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="renameGroup" class="membertitle">renameGroup</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">boolean</td> </tr> <tr> <td valign="top"><b>renameGroup</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> OldGroupName,</td> </tr> <tr> <td/><td valign="top">[in] string</td> <td valign="bottom"> NewGroupName );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>rename an existing group </dd> <dt><b>Parameter OldGroupName</b></dt> <dd>the old name of the group </dd> <dt><b>Parameter NewGroupName</b></dt> <dd>the new name of the group </dd> <dt><b>Returns</b></dt> <dd><b>true</b> if operation was successful <br> <b>false</b> otherwise </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="update" class="membertitle">update</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">[oneway] void</td> </tr> <tr> <td valign="top"><b>update</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>force an update for internal structures </dd> <dd><p> Because the templates are well known by links and not as direct content they can be outdated. An update force actualization of that to find wrong links. </p> </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2000, 2012 LibreOffice contributors and/or their affiliates. All rights reserved.</p><p class="copyright" align="center">LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.</p><p class="copyright" align="center">The Document Foundation acknowledges all community members, please find more info <a href="http://www.libreoffice.org/about-us/credits/" target="_blank">at our website</a>.<p> </p><p class="copyright" align="center"><a href="http://www.libreoffice.org/privacy" target="_blank">Privacy Policy</a> | <a href="http://www.libreoffice.org/imprint" target="_blank">Impressum (Legal Info)</a> | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (<a href="http://www.libreoffice.org/download/license/" target="_blank">LGPLv3</a>). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our <a href="http://wiki.documentfoundation.org/TradeMark_Policy" target="_blank">trademark policy</a>.</p> </div> <!-- id="adc-idlref" --> </body> </html>
