<html> <head> <title>Interface XWizardPage</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="XWizardPage-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"><a href="#AttributesSummary" class="navisub">Attributes' Summary</a></td> <td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td> <td class="navisub"><a href="#AttributesDetails" class="navisub">Attributes' Details</a></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">ui</a> :: <a href="module-ix.html" class="namechain">dialogs</a> :: </p> </td> </tr> <tr> <td class="title"><table class="title-table" width="99%"> <tr> <td width="25%" class="title2">unpublished </td> <td width="50%" class="title">interface XWizardPage</td> <td width="*"/></tr> </table> </td> </tr> <tr> <td><dl> <dt><b>Base Interfaces</b></dt> <dd><pre style="font-family:monospace;"><strong>XWizardPage</strong> ┗ ::com::sun::star::<a href="../../lang/module-ix.html">lang</a>::<a href="../../lang/XComponent.html">XComponent</a> </pre></dd> <dd><a name/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="crosstitle"> <tr> <td class="imsum_left">::com::sun::star::<a href="../../lang/module-ix.html">lang</a>::<a href="../../lang/XComponent.html">XComponent</a></td> <td class="imsum_right"><dl> <dt>(referenced interface's summary:)</dt> <dd>allows to exclicitly free resources and break cyclic references. </dd> </dl> </td> </tr> </table> </dd> </dl> </td> </tr> <tr> <td><dl> <dt><b>Usage Restrictions</b></dt> <dd><i>not published</i></dd> <dt><b>Description</b></dt> <dd>is a single page of a <a href="Wizard.html">Wizard</a> </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="#activatePage">activatePage</a></td> <td class="imsum_right">called when the page is activated </td> </tr> <tr> <td class="imsum_left"><a href="#commitPage">commitPage</a></td> <td class="imsum_right">is called when the page is about to be left </td> </tr> <tr> <td class="imsum_left"><a href="#canAdvance">canAdvance</a></td> <td class="imsum_right">determines whether it is allowed to travel to a later page in the wizard </td> </tr> </table> <a name="AttributesSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Attributes' Summary</td> </tr> <tr> <td class="imsum_left"><a href="#Window">Window</a></td> <td class="imsum_right">provides read-only access to the window of the page </td> </tr> <tr> <td class="imsum_left"><a href="#PageId">PageId</a></td> <td class="imsum_right">denotes the ID of the page. </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="activatePage" class="membertitle">activatePage</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">void</td> </tr> <tr> <td valign="top"><b>activatePage</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>called when the page is activated </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="commitPage" class="membertitle">commitPage</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>commitPage</b>(</td> <td valign="top">[in] short</td> <td valign="bottom"> Reason );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>is called when the page is about to be left </dd> <dd><p>An implementation can veto the leave by returning <b>false</b> here. Usually, the decision about this depends on the current state of the page.</p> </dd> <dt><b>Parameter Reason</b></dt> <dd>is one of the <a href="WizardTravelType.html">WizardTravelType</a> constants denoting the reason why the page should be committed. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="canAdvance" class="membertitle">canAdvance</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>canAdvance</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>determines whether it is allowed to travel to a later page in the wizard </dd> <dd><p>You should base this decision on the state of the page only, not on a global state of the wizard. Usually, you return <b>false</b> here if and only if not all necessary input on the page has been provided by the user, or the provided input is not valid.</p> <p>If checked for validity is expensive, or if you prefer giving your user more detailed feedback on validity than a disabled <code>Next</code> button in the wizard, then move your checks to the <a href="#commitPage">commitPage</a> method.</p> </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a name="AttributesDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Attributes' Details</td> </tr> <tr> <td class="imdetail"><a name="Window" class="membertitle">Window</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ readonly ] ::com::sun::star::<a href="../../awt/module-ix.html">awt</a>::<a href="../../awt/XWindow.html">XWindow</a> <b>Window</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>provides read-only access to the window of the page </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="PageId" class="membertitle">PageId</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ readonly ] short <b>PageId</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>denotes the ID of the page. </dd> <dd><p>Within a wizard, no two pages are allowed to have the same ID.</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>
