/*************************************************************************
 *
 *  $RCSfile: ControlActions.idl,v $
 *
 *  $Revision: 1.2.6.2 $
 *
 *  last change: $Author: mi $ $Date: 2003/01/21 17:52:07 $
 *
 *  The Contents of this file are made available subject to the terms of
 *  either of the following licenses
 *
 *         - GNU Lesser General Public License Version 2.1
 *         - Sun Industry Standards Source License Version 1.1
 *
 *  Sun Microsystems Inc., October, 2000
 *
 *  GNU Lesser General Public License Version 2.1
 *  =============================================
 *  Copyright 2000 by Sun Microsystems, Inc.
 *  901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License version 2.1, as published by the Free Software Foundation.
 *
 *  This library 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 for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *  MA  02111-1307  USA
 *
 *
 *  Sun Industry Standards Source License Version 1.1
 *  =================================================
 *  The contents of this file are subject to the Sun Industry Standards
 *  Source License Version 1.1 (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.openoffice.org/license.html.
 *
 *  Software provided under this License is provided on an "AS IS" basis,
 *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
 *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
 *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
 *  See the License for the specific provisions governing your rights and
 *  obligations concerning the Software.
 *
 *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
 *
 *  Copyright: 2000 by Sun Microsystems, Inc.
 *
 *  All Rights Reserved.
 *
 *  Contributor(s): _______________________________________
 *
 *
 ************************************************************************/

#ifndef __com_sun_star_ui_dialog_ControlActions_idl__
#define __com_sun_star_ui_dialog_ControlActions_idl__


module com { module sun { module star { module ui { module dialogs {

//=============================================================================
/**	Control actions for common and extended controls of a FilePicker.

	@see com::sun::star::ui::dialogs::XFilePickerControlAccess
	@see com::sun::star::ui::dialogs::CommonFilePickerElementIds
	@see com::sun::star::ui::dialogs::ExtendedFilePickerElementIds
 */

constants ControlActions
{
	//---------------------------------------------------------------------
	/** Adds an item to the content of the listbox. The given item has to 
		be a string.
	 */
	const short ADD_ITEM        = 1;

	//---------------------------------------------------------------------
	/** Adds a sequence of strings to the content of the listbox. 
	 */
	const short ADD_ITEMS	    = 2;			

	//---------------------------------------------------------------------
	/** Removes an item from a listbox. The given value has to be a 
		position. If the position is invalid an exception will be thrown.
		The index of the first position is 0.
		The value should be a sal_Int32.
	 */
	const short DELETE_ITEM     = 3;

	//---------------------------------------------------------------------
	/** Removes all items from the listbox.
	*/
	const short DELETE_ITEMS    = 4;

	//---------------------------------------------------------------------
	/** Selects an item in a listbox. The given value has to be a position.
		The index of the first position is 0. A value of -1 removes the 
		selection.
		If the given position is invalid an exception will be thrown.
		The value should be a sal_Int32.
	 */
	const short SET_SELECT_ITEM = 5;

	//---------------------------------------------------------------------
	/** Returns all items of the listbox as a sequence of strings.
	*/
	const short GET_ITEMS       = 6;				

	//---------------------------------------------------------------------
	/** Returns the currently selected item. The returned item is an empty
		string if the listbox is empty or no item is selected.
	 */
	const short GET_SELECTED_ITEM = 7;

	//---------------------------------------------------------------------
	/** Returns the zero based index of the currently selected item. 
		If the listbox is empty or there is no item selected -1 will be 
		returned. The returned value is a sal_Int32.
	 */

	const short GET_SELECTED_ITEM_INDEX = 8;

	//---------------------------------------------------------------------
	/** Sets the help URL of a control.
	 */
	const short SET_HELP_URL = 100;

	//---------------------------------------------------------------------
	/** Retrieves the help URL of a control.
	 */
	const short GET_HELP_URL = 101;
};

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

}; }; }; }; };

#endif
