xref: /trunk/main/offapi/com/sun/star/form/control/InteractionGridControl.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_component_InteractionGridControl_idl__
#define __com_sun_star_form_component_InteractionGridControl_idl__

#ifndef __com_sun_star_form_control_GridControl_idl__
#include <com/sun/star/form/control/GridControl.idl>
#endif
#ifndef __com_sun_star_frame_XDispatch_idl__
#include <com/sun/star/frame/XDispatch.idl>
#endif

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

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

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

/** is an extended grid control, which allows the user to customize some of it's user interface's aspects.
*/
published service InteractionGridControl
{
	service com::sun::star::form::control::GridControl;

	/** allows access to the UI features of the control

		<p>Though concret implementations of the service may offer different sets of aspects which can be customized,
		the following commands have, if supported, a defined meaning:
		<dl>
			<dt>.uno:GridSlots/BrowserAttribs</dt><dd> (interactively) customize the overall appearance of the grid (font etc.)</dd>
			<dt>.uno:GridSlots/RowHeight</dt><dd> (interactively) customize the row height appearance of the grid</dd>
			<dt>.uno:GridSlots/ColumnAttribs</dt><dd> (interactively) customize the format of a given column</dd>
			<dt>.uno:GridSlots/ColumnWidth</dt><dd> (interactively) customize the width of a given column</dd>
		</dl>
		</p>

		<p>The following parameters may be passed when dispatching the commands above (as before, concrete implementations
		may extend this list):
		<dl>
			<dt>ColumnId</dt><dd> the id of the column in question, if the command is executed for a column</dd>
			<dt>ColumnModelPos</dt><dd> the model position of the column in question, if the command is executed for a column</dd>
			<dt>ColumnViewPos</dt><dd> the view position of the column in question, if the command is executed for a column. The
			view position may differ from the model position, as in a grid control, columns can be hidden.</dd>
		</dl>
		</p>
	*/
	interface com::sun::star::frame::XDispatch;
};

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

}; }; }; }; };

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

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

#endif