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

   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
  21 module com { module sun { module star { module ui { module dialogs {
  22
  23
  24 /** is a single page of a Wizard
  25
  26     @since OOo 3.3
  27  */
  28 interface XWizardPage : ::com::sun::star::lang::XComponent
  29 {
  30     /** provides read-only access to the window of the page
  31     */
  32     [attribute, readonly]   ::com::sun::star::awt::XWindow  Window;
  33
  34     /** denotes the ID of the page.
  35
  36         <p>Within a wizard, no two pages are allowed to have the same ID.</p>
  37     */
  38     [attribute, readonly]   short PageId;
  39
  40     /** called when the page is activated
  41     */
  42     void    activatePage();
  43
  44     /** is called when the page is about to be left
  45
  46         <p>An implementation can veto the leave by returning `FALSE` here. Usually, the decision about this
  47         depends on the current state of the page.</p>
  48
  49         @param Reason
  50             is one of the WizardTravelType constants denoting the reason why the page should be
  51             committed.
  52     */
  53     boolean commitPage( [in] short Reason );
  54
  55     /** determines whether it is allowed to travel to a later page in the wizard
  56
  57         <p>You should base this decision on the state of the page only, not on a global state of the wizard. Usually,
  58         you return `FALSE` here if and only if not all necessary input on the page has been provided by the user,
  59         or the provided input is not valid.</p>
  60
  61         <p>If checked for validity is expensive, or if you prefer giving your user more detailed feedback on validity
  62         than a disabled <code>Next</code> button in the wizard, then move your checks to the commitPage()
  63         method.</p>
  64     */
  65     boolean canAdvance();
  66 };
  67
  68
  69 }; }; }; }; };
  70
  71
  72 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */