offapi/com/sun/star/form/inspection/ButtonNavigationHandler.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 #ifndef __com_sun_star_form_inspection_ButtonNavigationHandler_idl__
  21 #define __com_sun_star_form_inspection_ButtonNavigationHandler_idl__
  22
  23 #include <com/sun/star/inspection/XPropertyHandler.idl>
  24
  25
  26 module com {  module sun {  module star {  module form { module inspection {
  27
  28
  29 /** implements a property handler for use with an com::sun::star::inspection::ObjectInspector
  30     which is able to enhance the com::sun::star::form::component::CommandButton::ButtonType
  31     and com::sun::star::form::component::CommandButton::TargetURL properties of a
  32     com::sun::star::form::component::CommandButton.
  33
  34     <p>For this, the two properties are superseded by new versions, where as button type, additional
  35     possible values are added for navigating the parent form of the button. For instance, in an
  36     com::sun::star::inspection::ObjectInspector using this handler, the user will be able
  37     to choose a button type saying "move to the next record", which, when chosen, well, moves the parent
  38     database form of the button to the next record.</p>
  39
  40     @see com::sun::star::inspection::XPropertyHandler
  41     @see com::sun::star::form::component::CommandButton
  42 */
  43 service ButtonNavigationHandler
  44 {
  45     interface com::sun::star::inspection::XPropertyHandler;
  46 };
  47
  48
  49 }; }; }; }; };
  50
  51 #endif
  52
  53 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */