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

LibreOffice LibreOffice 26.8 SDK API Reference

Loading...
Searching...
No Matches
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
20module com { module sun { module star { module ui { module dialogs {
21
22
23interface XWizardPage;
24
67 interface XWizard
68{
69 interface XExecutableDialog;
70
73 [attribute] string HelpURL;
74
75 [attribute, readonly] ::com::sun::star::awt::XWindow
76 DialogWindow;
77
80 XWizardPage
81 getCurrentPage();
82
95 void enableButton( [in] short WizardButton, [in] boolean Enable );
96
106 void setDefaultButton( [in] short WizardButton );
107
113 boolean travelNext();
114
119 boolean travelPrevious();
120
136 void enablePage( [in] short PageID, [in] boolean Enable )
137 raises ( ::com::sun::star::container::NoSuchElementException
138 , ::com::sun::star::util::InvalidStateException );
139
148 void updateTravelUI();
149
156 boolean advanceTo( [in] short PageId );
157
163 boolean goBackTo( [in] short PageId );
164
202 void activatePath( [in] short PathIndex, [in] boolean Final )
203 raises ( ::com::sun::star::container::NoSuchElementException
204 , ::com::sun::star::util::InvalidStateException );
205};
206
207
208}; }; }; }; };
209
210
211/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::container::NoSuchElementException
is thrown by child access methods of collections, if the addressed child does not exist.
Definition NoSuchElementException.idl:31
com::sun::star::util::InvalidStateException
is thrown when an object's state does not allow to call requested functionality.
Definition InvalidStateException.idl:27
com::sun::star::awt::XWindow
specifies the basic operations for a window component.
Definition XWindow.idl:33
com::sun::star::ui::dialogs::XWizardPage
is a single page of a Wizard
Definition XWizardPage.idl:29
com::sun::star::ui::dialogs::XWizard
is the main interface implemented by the Wizard services.
Definition XWizard.idl:68
com::sun::star::ui::dialogs::XWizard::XExecutableDialog
interface XExecutableDialog
Definition XWizard.idl:69
com::sun::star::ui::dialogs::XWizard::getCurrentPage
XWizardPage getCurrentPage()
provides access to the current page of the wizard
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::DialogWindow
::com::sun::star::awt::XWindow DialogWindow
Definition XWizard.idl:76
com::sun::star::ui::dialogs::XWizard::updateTravelUI
void updateTravelUI()
updates the wizard elements which are related to traveling.
com::sun::star::ui::dialogs::XWizard::HelpURL
string HelpURL
is the help URL of the wizard's main window.
Definition XWizard.idl:73
com::sun::star::ui::dialogs::XWizard::travelPrevious
boolean travelPrevious()
travels to the next page, if possible
com::sun::star::ui::dialogs::XWizard::activatePath
void activatePath([in] short PathIndex, [in] boolean Final)
activates a path
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::setDefaultButton
void setDefaultButton([in] short WizardButton)
sets a button in the wizard as default button
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::travelNext
boolean travelNext()
travels to the next page, if possible
com::sun::star::ui::dialogs::WizardButton
denotes the buttons found in a Wizard
Definition WizardButton.idl:29
com
Definition Ambiguous.idl:20