offapi/com/sun/star/ui/dialogs/XWizardController.idl

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