/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   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 .
 */


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
 */

published 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;
};


}; }; }; }; };

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
