xref: /aoo41x/main/offapi/com/sun/star/form/XGridPeer.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_XGridPeer_idl__
#define __com_sun_star_form_XGridPeer_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

#ifndef __com_sun_star_container_XIndexContainer_idl__
#include <com/sun/star/container/XIndexContainer.idl>
#endif


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

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

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

/** represents the window peer of a GridControl and allows you to set
	and retrieve the model data.

	<p>Usually, the columns used are the columns as supplied by the grid control model.</p>

	<p>You should use this interface only if you know exactly what you are doing. Tampering
	with the columns of a grid control which is part of a complex form can really hurt ....</p>

	@deprecated
	@see com::sun::star::awt::XWindowPeer
	@see com::sun::star::form::component::GridControl
 */
published interface XGridPeer: com::sun::star::uno::XInterface
{
	//-------------------------------------------------------------------------

	/** retrieves the currently used column definitions of the peer.
	 */
	com::sun::star::container::XIndexContainer getColumns();

	//-------------------------------------------------------------------------

	/** sets the column definition for the peer.
	 */
	[oneway] void setColumns( [in] com::sun::star::container::XIndexContainer aColumns );

};

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

}; }; }; };

/*=============================================================================

=============================================================================*/
#endif