xref: /trunk/main/offapi/com/sun/star/form/inspection/ButtonNavigationHandler.idl (revision d1766043)

/**************************************************************
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/



#ifndef __com_sun_star_form_ButtonNavigationHandler_idl__
#define __com_sun_star_form_ButtonNavigationHandler_idl__

#ifndef __com_sun_star_inspection_XPropertyHandler_idl__
#include <com/sun/star/inspection/XPropertyHandler.idl>
#endif

//=============================================================================

module com {  module sun {  module star {  module form { module inspection {

//=============================================================================

/** implements a property handler for use with an <type scope="com::sun::star::inspection">ObjectInspector</type>
    which is able to enhance the <member scope="com::sun::star::form::component">CommandButton::ButtonType</member>
    and <member scope="com::sun::star::form::component">CommandButton::TargetURL</member> properties of a
    <type scope="com::sun::star::form::component">CommandButton</type>.

    <p>For this, the two properties are superseded by new versions, where as button type, additional
    possible values are added for navigating the parent form of the button. For instance, in an
    <type scope="com::sun::star::inspection">ObjectInspector</type> using this handler, the user will be able
    to choose a button type saying "move to the next record", which, when chosen, well, moves the parent
    database form of the button to the next record.</p>

    @see com::sun::star::inspection::XPropertyHandler
    @see com::sun::star::form::component::CommandButton
*/
service ButtonNavigationHandler
{
    interface com::sun::star::inspection::XPropertyHandler;
};

//=============================================================================

}; }; }; }; };

#endif