gecko-dev/widget/public/nsIListBox.h

/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
 *
 * The contents of this file are subject to the Netscape Public License
 * Version 1.0 (the "NPL"); you may not use this file except in
 * compliance with the NPL.  You may obtain a copy of the NPL at
 * http://www.mozilla.org/NPL/
 *
 * Software distributed under the NPL is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
 * for the specific language governing rights and limitations under the
 * NPL.
 *
 * The Initial Developer of this code under the NPL is Netscape
 * Communications Corporation.  Portions created by Netscape are
 * Copyright (C) 1998 Netscape Communications Corporation.  All Rights
 * Reserved.
 */

#ifndef nsIListBox_h__
#define nsIListBox_h__

#include "nsIListWidget.h"
#include "nsString.h"

// {F8030014-C342-11d1-97F0-00609703C14E}
#define NS_ILISTBOX_IID \
{ 0xf8030014, 0xc342, 0x11d1, { 0x97, 0xf0, 0x0, 0x60, 0x97, 0x3, 0xc1, 0x4e } };

/**
 * Single or multi selection list of items.
 * Unlike a nsIWidget, The the list widget must automatically clear 
 * itself to the background color when paint messages are generated.
 * The listbox always has a vertical scrollbar. It never has a
 * horizontal scrollbar.
 */

class nsIListBox : public nsIListWidget {

public:

    /**
     * Set the listbox to be multi-select.
     * @param   aMultiple PR_TRUE can have multiple selections. PR_FALSE single
     *          selections only.
     * @return  void
     *
     */

    virtual void  SetMultipleSelection(PRBool aMultipleSelections) = 0;

    /**
     * Return the number of selected items. For single selection list box this
     * @return the number of selected items
     * can be 1 or 0. 
     *
     */
    virtual PRInt32  GetSelectedCount() = 0;

    /**
     * Retrieves the indices of the selected items.
     * @param aIndices Array to hold the selected items. Use GetSelectedCount to
     *        determine how large the array needs to be.
     * @param aSize Size of the aIndices array
     *
     */
    virtual void  GetSelectedIndices(PRInt32 aIndices[], PRInt32 aSize) = 0;

};

#endif // nsIListBox_h__