LibreOffice: com/sun/star/ui/dialogs/XWizard.idl Source File

LibreOffice LibreOffice 6.4 SDK API Reference

XWizard.idl
Go to the documentation of this file.
1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 /*
3 * This file is part of the LibreOffice project.
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * This file incorporates work covered by the following license notice:
10 *
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 */
19
20 #ifndef __com_sun_star_ui_dialogs_XWizard_idl__
21 #define __com_sun_star_ui_dialogs_XWizard_idl__
22
23 #include <com/sun/star/ui/dialogs/XExecutableDialog.idl>
24 #include <com/sun/star/util/InvalidStateException.idl>
25 #include <com/sun/star/container/NoSuchElementException.idl>
26 #include <com/sun/star/awt/XWindow.idl>
27
28 module com { module sun { module star { module ui { module dialogs {
29
30
31 interface XWizardPage;
32
75 interface XWizard
76 {
77 interface XExecutableDialog;
78
81 [attribute] string HelpURL;
82
83 [attribute, readonly] ::com::sun::star::awt::XWindow
84 DialogWindow;
85
88 XWizardPage
89 getCurrentPage();
90
103 void enableButton( [in] short WizardButton, [in] boolean Enable );
104
114 void setDefaultButton( [in] short WizardButton );
115
121 boolean travelNext();
122
127 boolean travelPrevious();
128
144 void enablePage( [in] short PageID, [in] boolean Enable )
145 raises ( ::com::sun::star::container::NoSuchElementException
146 , ::com::sun::star::util::InvalidStateException );
147
156 void updateTravelUI();
157
164 boolean advanceTo( [in] short PageId );
165
171 boolean goBackTo( [in] short PageId );
172
210 void activatePath( [in] short PathIndex, [in] boolean Final )
211 raises ( ::com::sun::star::container::NoSuchElementException
212 , ::com::sun::star::util::InvalidStateException );
213 };
214
215
216 }; }; }; }; };
217
218
219 #endif
220
221 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
XExecutableDialog.idl
com::sun::star::ui::dialogs::XWizard::getCurrentPage
XWizardPage getCurrentPage()
provides access to the current page of the wizard
com::sun::star::ui::dialogs::XExecutableDialog
Specifies an interface for an executable dialog.
Definition: XExecutableDialog.idl:34
com::sun::star::ui::dialogs::XWizard::travelNext
boolean travelNext()
travels to the next page, if possible
XWindow.idl
com::sun::star::ui::dialogs::XWizard::DialogWindow
::com::sun::star::awt::XWindow DialogWindow
Definition: XWizard.idl:84
InvalidStateException.idl
com::sun::star::container::NoSuchElementException
is thrown by child access methods of collections, if the addressed child does not exist.
Definition: NoSuchElementException.idl:35
com::sun::star::ui::dialogs::XWizard::HelpURL
string HelpURL
is the help URL of the wizard's main window.
Definition: XWizard.idl:77
com::sun::star::awt::XWindow
specifies the basic operations for a window component.
Definition: XWindow.idl:51
com::sun::star::ui::dialogs::XWizard::enablePage
void enablePage([in] short PageID, [in] boolean Enable)
enables or disables the given page
com::sun::star::ui::dialogs::XWizard::advanceTo
boolean advanceTo([in] short PageId)
advances to the given page, if possible.
com::sun::star::ui::dialogs::XWizard::goBackTo
boolean goBackTo([in] short PageId)
goes back to the given page, if possible.
com::sun::star::ui::dialogs::XWizard::enableButton
void enableButton([in] short WizardButton, [in] boolean Enable)
enables or disables a certain button in the wizard
com::sun::star::ui::dialogs::XWizard::activatePath
void activatePath([in] short PathIndex, [in] boolean Final)
activates a path
com::sun::star::ui::dialogs::XWizard
is the main interface implemented by the Wizard services.
Definition: XWizard.idl:76
com::sun::star::util::InvalidStateException
is thrown when an object's state does not allow to call requested functionality.
Definition: InvalidStateException.idl:32
com::sun::star::ui::dialogs::XWizard::travelPrevious
boolean travelPrevious()
travels to the next page, if possible
com
Definition: Ambiguous.idl:22
NoSuchElementException.idl
com::sun::star::ui::dialogs::XWizard::setDefaultButton
void setDefaultButton([in] short WizardButton)
sets a button in the wizard as default button
com::sun::star::ui::dialogs::XWizardPage
is a single page of a Wizard
Definition: XWizardPage.idl:34
com::sun::star::ui::dialogs::XWizard::updateTravelUI
void updateTravelUI()
updates the wizard elements which are related to traveling.