blob: 6a51a67360fe392818d3f3977fbff62b57223999 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
|
/*************************************************************************
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org 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 Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef __com_sun_star_ui_dialogs_XWizardController_idl__
#define __com_sun_star_ui_dialogs_XWizardController_idl__
#include <com/sun/star/ui/dialogs/XWizardPage.idl>
//==================================================================================================================
module com { module sun { module star { module ui { module dialogs {
//==================================================================================================================
/** is the interface of a client-provided controller of a custom <type>Wizard</type>.
*/
interface XWizardController
{
/** creates a page
<p>Wizard pages are created on demand, when the respective page is reached during traveling through the
wizard. Effectively, this means the method is called at most once for each possible page ID.</p>
@param ParentWindow
the parent window to use for the page window
@param PageId
the ID of the page.
@return
the requested page.
*/
XWizardPage createPage( [in] ::com::sun::star::awt::XWindow ParentWindow, [in] short PageId );
/** provides the title of a page given by ID
<p>The page titles are displayed in the wizard's roadmap.</p>
*/
string getPageTitle( [in] short PageId );
boolean canAdvance();
/** called when a new page in the wizard is being activated
*/
void onActivatePage( [in] short PageId );
/** called when a page in the wizard is being deactivated
*/
void onDeactivatePage( [in] short PageId );
/** called when the wizard is about to be finished.
<p>This method allows the controller to do any final checks, and ultimatively veto finishing the wizard.</p>
*/
boolean confirmFinish();
};
//==================================================================================================================
}; }; }; }; };
//==================================================================================================================
#endif
|
