YSelectionWidget.h

/*
  Copyright (C) 2000-2012 Novell, Inc
  This library is free software; you can redistribute it and/or modify
  it under the terms of the GNU Lesser General Public License as
  published by the Free Software Foundation; either version 2.1 of the
  License, or (at your option) version 3.0 of the License. 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., 51 Franklin Street, Fifth
  Floor, Boston, MA 02110-1301 USA
*/


/*-/

  File:     YSelectionWidget.h

  Author:       Stefan Hundhammer <shundhammer@suse.de>

/-*/

#ifndef YSelectionWidget_h
#define YSelectionWidget_h

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

class YSelectionWidgetPrivate;

class YSelectionWidget : public YWidget
{
protected:

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

public:
    virtual ~YSelectionWidget();

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

    std::string label() const;

    virtual void setLabel( const std::string & newLabel );

    virtual void addItem( YItem * item_disown );

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

    void addItem( const std::string & itemLabel,
          const std::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 * itemAt( int index ) const;

    YItem * firstItem() const;

    virtual YItem * selectedItem();

    virtual YItemCollection selectedItems();

    bool hasSelectedItem();

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

    virtual void setItemStatus( YItem * item, int status );

    virtual void deselectAllItems();

    void setIconBasePath( const std::string & basePath );

    std::string iconBasePath() const;

    std::string iconFullPath( const std::string & iconName ) const;

    std::string iconFullPath( YItem * item ) const;

    bool itemsContain( YItem * item ) const;

    YItem * findItem( const std::string & itemLabel ) const;

    void dumpItems() const;

    bool enforceSingleSelection() const;

    virtual void shortcutChanged() {}

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

    virtual void setShortcutString( const std::string & str );


protected:

    void setEnforceSingleSelection( bool on );

    void setEnforceInitialSelection( bool on );

    bool enforceInitialSelection() 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 std::string &   wantedItemLabel,
              YItemConstIterator    begin,
              YItemConstIterator    end ) const;

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


private:

    ImplPtr<YSelectionWidgetPrivate> priv;
};


#endif // YSelectionWidget_h