xref: /aoo42x/main/offapi/com/sun/star/form/XGridControl.idl (revision cdf0e10c)

/*************************************************************************
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
************************************************************************/

#ifndef __com_sun_star_form_XGridControl_idl__
#define __com_sun_star_form_XGridControl_idl__

#include <com/sun/star/form/XGrid.idl>
#include <com/sun/star/form/XGridControlListener.idl>
#include <com/sun/star/form/XGridFieldDataSupplier.idl>

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

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

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

/** specifies (some) functionality provided by a grid control (aka table control)

    @since OOo 3.1
 */
interface XGridControl
{
    /** allows access to the current column position within the grid control
    */
    interface XGrid;

    /** registers a listener which is to be notified about state changes in
        the grid control
    */
    void    addGridControlListener( [in] XGridControlListener _listener );

    /** revokes a previously registered grid control listener
    */
    void    removeGridControlListener( [in] XGridControlListener _listener );

    /// provides access to the data in the control, even in non-current rows
    interface XGridFieldDataSupplier;
};

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

}; }; }; };

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

#endif