/data/gitorious.org/libyui/libyui-master/src/YSelectionWidget.h

/**************************************************************************
Copyright (C) 2000 - 2010 Novell, Inc.
All Rights Reserved.

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

This program 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 General Public License for more details.

You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

**************************************************************************/


/*---------------------------------------------------------------------\
|                                                                      |
|                      __   __    ____ _____ ____                      |
|                      \ \ / /_ _/ ___|_   _|___ \                     |
|                       \ V / _` \___ \ | |   __) |                    |
|                        | | (_| |___) || |  / __/                     |
|                        |_|\__,_|____/ |_| |_____|                    |
|                                                                      |
|                               core system                            |
|                                                        (C) SuSE GmbH |
\----------------------------------------------------------------------/

  File:         YSelectionWidget.h

  Author:       Stefan Hundhammer <sh@suse.de>

/-*/

#ifndef YSelectionWidget_h
#define YSelectionWidget_h

#include "YWidget.h"
#include "YItem.h"
#include "ImplPtr.h"

using std::string;
class YSelectionWidgetPrivate;

class YSelectionWidget : public YWidget
{
protected:

    YSelectionWidget( YWidget *         parent,
                      const string &    label,
                      bool              enforceSingleSelection,
                      bool              recurisveSelection = false );

public:
    virtual ~YSelectionWidget();

    virtual const char * widgetClass() const { return "YSelectionWidget"; }

    string label() const;

    virtual void setLabel( const string & newLabel );

    virtual void addItem( YItem * item_disown );

    void addItem( const string & itemLabel, bool selected = false );

    void addItem( const string & itemLabel,
                  const string & iconName,
                  bool selected = false );

    virtual void addItems( const YItemCollection & itemCollection );

    virtual void deleteAllItems();

    void setItems( const YItemCollection & itemCollection )
        { deleteAllItems(); addItems( itemCollection ); }

    YItemIterator       itemsBegin();
    YItemConstIterator  itemsBegin() const;

    YItemIterator       itemsEnd();
    YItemConstIterator  itemsEnd() const;

    bool hasItems() const;

    int itemsCount() const;

    YItem * firstItem() const;

    virtual YItem * selectedItem();

    virtual YItemCollection selectedItems();

    bool hasSelectedItem();

    virtual void selectItem( YItem * item, bool selected = true );

    virtual void deselectAllItems();

    void setIconBasePath( const string & basePath );

    string iconBasePath() const;

    string iconFullPath( const string & iconName ) const;
    
    string iconFullPath( YItem * item ) const;

    bool itemsContain( YItem * item ) const;

    YItem * findItem( const string & itemLabel ) const;

    virtual string shortcutString() const { return label(); }

    virtual void setShortcutString( const string & str )
        { setLabel( str ); }

protected:

    void setEnforceSingleSelection( bool on );

    bool enforceSingleSelection() const;

    bool recursiveSelection() const;

    YItem * findSelectedItem( YItemConstIterator begin,
                              YItemConstIterator end );

    void findSelectedItems( YItemCollection &   selectedItems,
                            YItemConstIterator  begin,
                            YItemConstIterator  end );

    void deselectAllItems( YItemIterator        begin,
                           YItemIterator        end );
    YItem * findItem    ( const string &        wantedItemLabel,
                          YItemConstIterator    begin,
                          YItemConstIterator    end ) const;

    bool itemsContain   ( YItem *               wantedItem,
                          YItemConstIterator    begin,
                          YItemConstIterator    end ) const;
    YItem * itemAt( int index ) const;


private:

    ImplPtr<YSelectionWidgetPrivate> priv;
};


#endif // YSelectionWidget_h