YItemSelector.h

/*
  Copyright (c) [2019] SUSE LLC
  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:     YItemSelector.h

  Author:   Stefan Hundhammer <shundhammer@suse.de>

/-*/

#ifndef YItemSelector_h
#define YItemSelector_h

#include "YSelectionWidget.h"
#include "YDescribedItem.h"
#include "YItemCustomStatus.h"


class YItemSelectorPrivate;

class YItemSelector: public YSelectionWidget
{
public:

    YItemSelector( YWidget *    parent,
                   bool         enforceSingleSelection = true );

    YItemSelector( YWidget *                            parent,
                   const YItemCustomStatusVector &      customStates );

    virtual ~YItemSelector();

    virtual const char * widgetClass() const;

    int visibleItems() const;

    virtual void setVisibleItems( int newVal );

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

    bool usingCustomStatus() const;

    int customStatusCount() const;

    const YItemCustomStatus & customStatus( int index );

    bool validCustomStatusIndex( int index ) const;

    int cycleCustomStatus( int oldStatus );

    virtual bool setProperty( const std::string    & propertyName,
                  const YPropertyValue & val );

    virtual YPropertyValue getProperty( const std::string & propertyName );

    virtual const YPropertySet & propertySet();

    const char * userInputProperty() { return YUIProperty_Value; }

    virtual void activateItem( YItem * item ) = 0;

protected:

    virtual void updateCustomStatusIndicator( YItem * item ) {}


private:

    void init();

    void checkCustomStates();


    // Data members

    ImplPtr<YItemSelectorPrivate> priv;

};      // class YItemSelector

#endif  // YItemSelector_h