blob: c7c1be2fadeb6e8de69aba8d5129016d7f11d2e2 (
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
|
/* -*- 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 .
*/
#ifndef __com_sun_star_ui_dialogs_XWizardPage_idl__
#define __com_sun_star_ui_dialogs_XWizardPage_idl__
#include <com/sun/star/awt/XWindow.idl>
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();
};
}; }; }; }; };
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
