LibreOffice LibreOffice 26.2 SDK API Reference

XWizardController.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
21module com { module sun { module star { module ui { module dialogs {
22
23
28 interface XWizardController
29{
42 XWizardPage createPage( [in] ::com::sun::star::awt::XWindow ParentWindow, [in] short PageId );
43
48 string getPageTitle( [in] short PageId );
49
50 boolean canAdvance();
51
54 void onActivatePage( [in] short PageId );
55
58 void onDeactivatePage( [in] short PageId );
59
64 boolean confirmFinish();
65};
66
67
68}; }; }; }; };
69
70
71/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::awt::XWindow
specifies the basic operations for a window component.
Definition: XWindow.idl:33
com::sun::star::ui::dialogs::XWizardController
is the interface of a client-provided controller of a custom Wizard.
Definition: XWizardController.idl:29
com::sun::star::ui::dialogs::XWizardController::onActivatePage
void onActivatePage([in] short PageId)
called when a new page in the wizard is being activated
com::sun::star::ui::dialogs::XWizardController::createPage
XWizardPage createPage([in] ::com::sun::star::awt::XWindow ParentWindow, [in] short PageId)
creates a page
com::sun::star::ui::dialogs::XWizardController::confirmFinish
boolean confirmFinish()
called when the wizard is about to be finished.
com::sun::star::ui::dialogs::XWizardController::getPageTitle
string getPageTitle([in] short PageId)
provides the title of a page given by ID
com::sun::star::ui::dialogs::XWizardController::onDeactivatePage
void onDeactivatePage([in] short PageId)
called when a page in the wizard is being deactivated
com::sun::star::ui::dialogs::XWizardController::canAdvance
boolean canAdvance()
com::sun::star::ui::dialogs::XWizardPage
is a single page of a Wizard
Definition: XWizardPage.idl:29
com
Definition: Ambiguous.idl:20