YMenuWidget.h

/*
  Copyright (c) [2020] 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:     YMenuWidget.h

  Author:   Stefan Hundhammer <shundhammer@suse.de>

/-*/

#ifndef YMenuWidget_h
#define YMenuWidget_h

#include "YSelectionWidget.h"
#include "YMenuItem.h"

class YMenuWidgetPrivate;


class YMenuWidget: public YSelectionWidget
{
protected:
    YMenuWidget( YWidget * parent, const std::string & label = "" );

public:

    virtual ~YMenuWidget();

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

    virtual void rebuildMenuTree() = 0;

    virtual void addItems( const YItemCollection & itemCollection );

    virtual void addItem( YItem * item_disown );

    virtual void deleteAllItems();

    void resolveShortcutConflicts();

    virtual void setItemEnabled( YMenuItem * item, bool enabled );

    virtual void setItemVisible( YMenuItem * item, bool visible );

    YMenuItem * findItem( std::vector<std::string> & path ) const;

    virtual void activateItem( YMenuItem * item ) = 0;

    YMenuItem * findMenuItem( int index );


    // No propertySet(), setProperty(), getProperty() on this level:
    //
    // This is left to derived widgets (very much like for YSelectionWidget)
    // so they can be tailored to what they really can provide.
    //
    // There is infrastructure for properties like "EnabledItems" here and in
    // the UI bindings, though, to easily support those properties.

protected:

    void resolveShortcutConflicts( YItemConstIterator begin,
                                   YItemConstIterator end );

    YMenuItem * findMenuItem( int                index,
                              YItemConstIterator begin,
                              YItemConstIterator end );

    YMenuItem * findItem( std::vector<std::string>::iterator path_begin,
                          std::vector<std::string>::iterator path_end,
                          YItemConstIterator                 begin,
                          YItemConstIterator                 end ) const;

    YMenuItem * itemAt( int index )
    { return findMenuItem( index ); }

    void assignUniqueIndex( YItemIterator begin, YItemIterator end );


private:

    ImplPtr<YMenuWidgetPrivate> priv;
};


#endif  // YMenuWidget_h