72 lines
2.5 KiB
Text
72 lines
2.5 KiB
Text
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
|
|
/*
|
|
* This file is part of the LibreOffice project.
|
|
*
|
|
* This Source Code Form is subject to the terms of the Mozilla Public
|
|
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
|
*
|
|
* This file incorporates work covered by the following license notice:
|
|
*
|
|
* Licensed to the Apache Software Foundation (ASF) under one or more
|
|
* contributor license agreements. See the NOTICE file distributed
|
|
* with this work for additional information regarding copyright
|
|
* ownership. The ASF licenses this file to you under 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 .
|
|
*/
|
|
|
|
|
|
module com { module sun { module star { module ui { module dialogs {
|
|
|
|
|
|
/** is a single page of a Wizard
|
|
|
|
@since OOo 3.3
|
|
*/
|
|
interface XWizardPage : ::com::sun::star::lang::XComponent
|
|
{
|
|
/** provides read-only access to the window of the page
|
|
*/
|
|
[attribute, readonly] ::com::sun::star::awt::XWindow Window;
|
|
|
|
/** denotes the ID of the page.
|
|
|
|
<p>Within a wizard, no two pages are allowed to have the same ID.</p>
|
|
*/
|
|
[attribute, readonly] short PageId;
|
|
|
|
/** called when the page is activated
|
|
*/
|
|
void activatePage();
|
|
|
|
/** is called when the page is about to be left
|
|
|
|
<p>An implementation can veto the leave by returning `FALSE` here. Usually, the decision about this
|
|
depends on the current state of the page.</p>
|
|
|
|
@param Reason
|
|
is one of the WizardTravelType constants denoting the reason why the page should be
|
|
committed.
|
|
*/
|
|
boolean commitPage( [in] short Reason );
|
|
|
|
/** determines whether it is allowed to travel to a later page in the wizard
|
|
|
|
<p>You should base this decision on the state of the page only, not on a global state of the wizard. Usually,
|
|
you return `FALSE` 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 commitPage()
|
|
method.</p>
|
|
*/
|
|
boolean canAdvance();
|
|
};
|
|
|
|
|
|
}; }; }; }; };
|
|
|
|
|
|
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|