offapi/com/sun/star/form/inspection/ButtonNavigationHandler.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: ButtonNavigationHandler.idl,v $
  10  * $Revision: 1.3 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __com_sun_star_form_ButtonNavigationHandler_idl__
  32 #define __com_sun_star_form_ButtonNavigationHandler_idl__
  33
  34 #ifndef __com_sun_star_inspection_XPropertyHandler_idl__
  35 #include <com/sun/star/inspection/XPropertyHandler.idl>
  36 #endif
  37
  38 //=============================================================================
  39
  40 module com {  module sun {  module star {  module form { module inspection {
  41
  42 //=============================================================================
  43
  44 /** implements a property handler for use with an <type scope="com::sun::star::inspection">ObjectInspector</type>
  45     which is able to enhance the <member scope="com::sun::star::form::component">CommandButton::ButtonType</member>
  46     and <member scope="com::sun::star::form::component">CommandButton::TargetURL</member> properties of a
  47     <type scope="com::sun::star::form::component">CommandButton</type>.
  48
  49     <p>For this, the two properties are superseded by new versions, where as button type, additional
  50     possible values are added for navigating the parent form of the button. For instance, in an
  51     <type scope="com::sun::star::inspection">ObjectInspector</type> using this handler, the user will be able
  52     to choose a button type saying "move to the next record", which, when chosen, well, moves the parent
  53     database form of the button to the next record.</p>
  54
  55     @see com::sun::star::inspection::XPropertyHandler
  56     @see com::sun::star::form::component::CommandButton
  57 */
  58 service ButtonNavigationHandler
  59 {
  60     interface com::sun::star::inspection::XPropertyHandler;
  61 };
  62
  63 //=============================================================================
  64
  65 }; }; }; }; };
  66
  67 #endif
  68