File indexing completed on 2024-05-05 04:47:27

 /****************************************************************************************
  * Copyright (c) 2009 Nikolaj Hald Nielsen <nhn@kde.org>                                *
  *                                                                                      *
  * 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, see <http://www.gnu.org/licenses/>.                           *
  ****************************************************************************************/
 
 #define DEBUG_PREFIX "BrowserBreadcrumbWidget"
 
 #include "BrowserBreadcrumbWidget.h"
 
 #include "amarokurls/AmarokUrl.h"
 #include "BrowserBreadcrumbItem.h"
 #include "BrowserCategoryList.h"
 #include "browsers/filebrowser/FileBrowser.h"
 #include "MainWindow.h"
 #include "widgets/BreadcrumbItemButton.h"
 
 #include <QBoxLayout>
 #include <QDir>
 #include <QMenu>
 #include <QResizeEvent>
 #include <QTimer>
 
 #include <KLocalizedString>
 
 
 BrowserBreadcrumbWidget::BrowserBreadcrumbWidget( QWidget * parent )
     : BoxWidget( false, parent)
     , m_rootList( nullptr )
 {
     setFixedHeight( 28 );
     setContentsMargins( 3, 0, 3, 0 );
 
     m_breadcrumbArea = new BoxWidget( false, this );
     m_breadcrumbArea->setContentsMargins( 0, 0, 0, 0 );
     layout()->setStretchFactor( m_breadcrumbArea, 10 );
 
     new BreadcrumbUrlMenuButton( QStringLiteral("navigate"), this );
 }
 
 BrowserBreadcrumbWidget::~BrowserBreadcrumbWidget()
 {
 }
 
 void
 BrowserBreadcrumbWidget::clearCrumbs()
 {
     const QList<QWidget *> childCrumbs = m_breadcrumbArea->findChildren<QWidget *>(QString(), Qt::FindDirectChildrenOnly);
     for( auto item : childCrumbs)
     {
         item->deleteLater();
     }
 }
 
 void
 BrowserBreadcrumbWidget::setRootList( BrowserCategoryList * rootList )
 {
     m_rootList = rootList;
 
     //update the breadcrumbs every time the view changes.
     connect( m_rootList, &BrowserCategoryList::viewChanged, this, &BrowserBreadcrumbWidget::updateBreadcrumbs );
 
     updateBreadcrumbs();
 }
 
 void
 BrowserBreadcrumbWidget::updateBreadcrumbs()
 {
     if( !m_rootList )
         return;
 
     clearCrumbs();
 
     addLevel( m_rootList );
 
     // spacer is the right-most widget
     new QWidget(m_breadcrumbArea);
 
     showAsNeeded();
 }
 
 void
 BrowserBreadcrumbWidget::addLevel( BrowserCategoryList *list )
 {
     BrowserBreadcrumbItem *item = list->breadcrumb();
     addBreadCrumbItem( item );
 
     BrowserCategory *childCategory = list->activeCategory();
 
     if( childCategory )
     {
         item->setActive( false );
 
         //check if this is also a list
         BrowserCategoryList *childList = qobject_cast<BrowserCategoryList*>( childCategory );
         if( childList )
         {
             addLevel( childList );
         }
         else
         {
             BrowserBreadcrumbItem *leaf = childCategory->breadcrumb();
             addBreadCrumbItem( leaf );
 
             const QList<BrowserBreadcrumbItem*> additionalItems = childCategory->additionalItems();
             //no children, but check if there are additional breadcrumb levels (for internal navigation in the category) that should be added anyway.
             for( BrowserBreadcrumbItem *addItem : additionalItems )
             {
                 //hack to ensure that we have not already added it to the front of the breadcrumb...
                 addBreadCrumbItem( addItem );
             }
 
             if( !additionalItems.isEmpty() )
                 additionalItems.last()->setActive( true );
             else
                 leaf->setActive( true );
         }
     }
     else
     {
         //if this item has children, add a menu button for selecting these.
         BrowserCategoryList *childList = qobject_cast<BrowserCategoryList*>( list );
         if( childList )
         {
             auto childMenuButton = new BreadcrumbItemMenuButton( m_breadcrumbArea );
 
             auto menu = new QMenu( item );
             menu->hide();
 
             QMap<QString,BrowserCategory *> childMap =  childList->categories();
 
             const QStringList childNames = childMap.keys();
 
             for( const QString &siblingName : childNames )
             {
                 //no point in adding ourselves to this menu
                 if ( siblingName == list->name() )
                     continue;
 
                 BrowserCategory * siblingCategory = childMap.value( siblingName );
 
                 QAction * action = menu->addAction( siblingCategory->icon(), siblingCategory->prettyName() );
                 connect( action, &QAction::triggered, childMap.value( siblingName ), &BrowserCategory::activate );
 
             }
 
             childMenuButton->setMenu( menu );
 
             //do a little magic to line up items in the menu with the current item
             int offset = 6;
             menu->setContentsMargins( offset, 1, 1, 2 );
 
         }
         item->setActive( true );
     }
 }
 
 void
 BrowserBreadcrumbWidget::addBreadCrumbItem( BrowserBreadcrumbItem *item )
 {
     item->setParent( m_breadcrumbArea );
 }
 
 void BrowserBreadcrumbWidget::resizeEvent( QResizeEvent *event )
 {
     Q_UNUSED( event )
     // we need to postpone the call, because showAsNeeded() itself may trigger resizeEvent
     QTimer::singleShot( 0 , this, &BrowserBreadcrumbWidget::showAsNeeded );
 }
 
 void BrowserBreadcrumbWidget::showAsNeeded()
 {
     /* we need to check if there is enough space for all items, if not, we start hiding
      * items from the left (excluding the home item) until they fit (we never hide the
      * rightmost item) we also add the hidden levels to the drop down menu of the last
      * item so they are accessible.
      */
 
     //make a temp list that includes both regular items and add items
     QList<BrowserBreadcrumbItem *> allItems;
 
     allItems.append( m_breadcrumbArea->findChildren<BrowserBreadcrumbItem *>(QString(), Qt::FindDirectChildrenOnly));
 
     if( allItems.isEmpty() )
         return;
 
     int sizeOfFirst = allItems.first()->nominalWidth();
     int sizeOfLast = allItems.last()->nominalWidth();
 
     int spaceLeft = width() - ( sizeOfFirst + sizeOfLast + 28 );
     allItems.first()->show();
     allItems.last()->show();
 
     int numberOfItems = allItems.count();
 
     for( int i = numberOfItems - 2; i > 0; i-- )
     {
         if( allItems.at( i )->nominalWidth() <= spaceLeft )
         {
             allItems.at( i )->show();
             spaceLeft -= allItems.at( i )->nominalWidth();
         }
         else
         {
             //set spaceLeft to 0 so no items further to the left are shown
             spaceLeft = 0;
             allItems.at( i )->hide();
         }
     }
 }