src/kmk.h

   1 /***************************************************************************
   2  *   KMK - KDE Music Cataloger  -  the tool for personal                   *
   3  *                                 audio collection management             *
   4  *                                                                         *
   5  *   Copyright (C) 2006,2007 by Plamen Petrov                              *
   6  *   carpo@abv.bg                                                          *
   7  *                                                                         *
   8  *   This program is free software; you can redistribute it and/or modify  *
   9  *   it under the terms of the GNU General Public License as published by  *
  10  *   the Free Software Foundation; either version 2 of the License, or     *
  11  *   (at your option) any later version.                                   *
  12  *                                                                         *
  13  *   This program is distributed in the hope that it will be useful,       *
  14  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  15  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  16  *   GNU General Public License for more details.                          *
  17  *                                                                         *
  18  *   You should have received a copy of the GNU General Public License     *
  19  *   along with this program; if not, write to the                         *
  20  *   Free Software Foundation, Inc.,                                       *
  21  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  22  ***************************************************************************/
  23
  24 #ifndef _KMK_H_
  25 #define _KMK_H_
  26 #undef _KMK_DEBUG__
  27
  28 #ifdef HAVE_CONFIG_H
  29 #include "config.h"
  30 #endif
  31
  32 #include <kmainwindow.h>
  33 #include <kaction.h>
  34 //#include <kfiledialog.h>
  35 #include <ktoolbar.h>
  36 #include <klistview.h>
  37 #include <klineedit.h>
  38 #include <kdebug.h>
  39 //#include <qvaluelist.h>
  40 #include <qwidget.h>
  41 #include <qvariant.h>
  42 #include <qlayout.h>
  43 #include <qsplitter.h>
  44 #include <qtimer.h>
  45 #include <qdatetime.h>
  46 #include <qdragobject.h>
  47
  48 #include "kmk_progress_disp.h"
  49 #include "mmdata.h"
  50 #include "kmkglobalsettings.h"
  51 #include "kmkexternalplayer.h"
  52
  53 class QVBoxLayout;
  54 class QHBoxLayout;
  55 class QGridLayout;
  56 class QSpacerItem;
  57 class QTabWidget;
  58 class QSplitter;
  59 class KListView;
  60 class QListViewItem;
  61 class QPushButton;
  62 class QFrame;
  63 class QLabel;
  64 class KLineEdit;
  65 class KListView;
  66
  67 class kmk_progress_disp;
  68
  69 class kmk_tree_KListView : public KListView
  70 {
  71 Q_OBJECT
  72 public:
  73     kmk_tree_KListView (QWidget *parent = 0, const char *name = 0)
  74     : KListView ( parent, name )
  75     {}
  76     virtual ~kmk_tree_KListView()
  77     {}
  78 protected:
  79     virtual QDragObject *dragObject()
  80     {
  81       QListViewItem* lv = this->currentItem();
  82       if ( !lv ) return 0;
  83       QStringList l;
  84       QString p;
  85
  86       while ( TRUE ) {
  87          p.prepend( lv->text(0) );
  88          if( lv->parent() ) { p.prepend( "/" ); lv = lv->parent(); }
  89          else break;
  90       }
  91
  92       l << p;
  93
  94       QUriDrag *d = new QUriDrag( this, 0 );
  95       if ( !d ) return 0;
  96       d->setFileNames( l );
  97       return (QDragObject*) d;
  98     }
  99 };
 100
 101 class kmk_files_KListView : public KListView
 102 {
 103 Q_OBJECT
 104 public:
 105     kmk_files_KListView (QWidget *parent = 0, const char *name = 0)
 106     : KListView ( parent, name )
 107     {}
 108     virtual ~kmk_files_KListView()
 109     {}
 110 protected:
 111     virtual QDragObject *dragObject()
 112     {
 113       QStringList l;
 114       KListViewItem *node = (KListViewItem*) this->firstChild();
 115       if ( !node ) return 0;
 116
 117       while ( node )
 118        {
 119          if ( node->isSelected() )      l << node->text( 0 ) + "/" + node->text( 1 );
 120          node = (KListViewItem*) node->nextSibling();
 121        }
 122
 123       QUriDrag *d = new QUriDrag( this, 0 );
 124       if ( !d ) return 0;
 125       d->setFileNames( l );
 126       return (QDragObject*) d;
 127     }
 128 };
 129
 130 /**
 131  * @short kmk is the main widget which actually makes KMK what it is
 132  *
 133  * This Widget extends the functionality of QListView to honor the system
 134  * wide settings for Single Click/Double Click mode, AutoSelection and
 135  * ChangeCursorOverLink (TM).
 136  *
 137  * There is a new signal executed(). It gets connected to either
 138  * QListView::clicked() or QListView::doubleClicked() depending on the KDE
 139  * wide Single Click/Double Click settings. It is strongly recommended that
 140  * you use this signal instead of the above mentioned. This way you don�t
 141  * need to care about the current settings.
 142  * If you want to get informed when the user selects something connect to the
 143  * QListView::selectionChanged() signal.
 144  *
 145  * Drag-and-Drop is supported with the signal dropped(), just setAcceptDrops(true)
 146  * and connect it to a suitable slot.
 147  * To see where you are dropping, setDropVisualizer(true).
 148  * And also you'll need acceptDrag(QDropEvent*)
 149  *
 150  * KListView is drag-enabled, too: to benefit from that you have to derive from it.
 151  * Reimplement dragObject() and (possibly) startDrag(),
 152  * and setDragEnabled(true).
 153  *
 154  * @author Plamen Petrov <carpo@abv.bg>
 155  * @version 0.11
 156  */
 157 class kmk : public KMainWindow
 158 {
 159   Q_OBJECT
 160 public:
 161   /**
 162    * Default constructor
 163    */
 164   kmk();
 165
 166   /**
 167    * Default Destructor
 168    */
 169   virtual ~kmk();
 170
 171 private slots:
 172   /*$PRIVATE_SLOTS$*/
 173   /**
 174    *    Handle searching trough the selected dir - scan for files
 175    *    we recognize, and add them accordingly to the catalog tree;
 176    *    This SLOT initially cleans all contents of MusicCatalog,
 177    *    the Catalog tree KListView, and the two File list QTables
 178    */
 179   void slotFileNew();
 180   void slotFileOpen();
 181   void slotCatalogAddNewFolder();
 182 /** Saves the catalog in memory to the file @p catalogFileName;
 183  *  If the string, being a filename in @p catalogFileName does not have
 184  *  a .kmk extension - this slot adds it
 185  */
 186   void slotFileSave();
 187   void slotFileSaveAs();
 188   void slotCatalogFileClose();
 189   void slotCatalogFileStats();
 190   void slotFileQuit();
 191
 192   void slotProgramSettings();
 193
 194   /**
 195    * This is where the setup for kmkTagEdit takes place:
 196    * a QTable::selection(s) is traversersed and relevant data
 197    * extracted in MmDataList, for user manipulation in the TagEditor
 198    * modal() dialog
 199    */
 200   void slotTagEdit();
 201   void slotListTableToggleTitle();
 202
 203   /**
 204    * A private slot for kmk which takes care of making the external player
 205    * play the previous song - either the song before the current in its
 206    * playlist, or if it is in SHUFFLE mode - the previous played
 207    */
 208   void slotPlayerPrevious();
 209
 210   /**
 211    * A private slot for kmk which takes care of making the external player
 212    * play; if it was playing something at the time the command is issued
 213    * there should be no effect whatsoever
 214    */
 215   void slotPlayerPlay();
 216
 217   /**
 218    * A private slot for kmk which makes the external player
 219    * pause - in reality - if it was paused, it will continue;
 220    * if it was playing - it will pause
 221    */
 222   void slotPlayerPause();
 223
 224   /**
 225    * A private slot for kmk which makes the external player stop
 226    * playing if it is; if it isn't - there is no effect
 227    */
 228   void slotPlayerStop();
 229
 230   /**
 231    * Private kmk slot, which essentially behaves like kmk::playerPrevious()
 232    * only difference is the "direction"
 233    */
 234   void slotPlayerNext();
 235
 236   /**
 237    * This private kmk slot is resposible for enqueing whatever is selected
 238    * in the FileList() QTables, or SearchFileList() QTable - its native
 239    * call environment is from a popup menu after recieved
 240    * contextMenuRequested() signal
 241    */
 242   void slotPlayerEnqueue();
 243
 244   /**
 245    * Uses kmk::playerDir to enqueue
 246    */
 247   void slotPlayerEnqueueDir();
 248
 249   /**
 250    * Uses kmk::playerDir to enqueue selected folder AND all its subfolder(s) contents
 251    */
 252   void slotPlayerEnqueueDirSubdirs();
 253
 254   /**
 255    * Uses kmk::playerDir to play
 256    */
 257   void slotPlayerPlayDir();
 258
 259   /**
 260    * Uses kmk::playerDir to play selected folder AND all its subfolder(s) contents
 261    */
 262   void slotPlayerPlayDirSubdirs();
 263
 264   /**
 265    * This private slot should play whatever selection in FileList()
 266    * or kmkWidget::SearchTreeList() QTable objects
 267    */
 268   void slotPlayerPlaySelection();
 269
 270   /**
 271    * Triggers update on currently selected folder in TreeListView
 272    */
 273   void slotCatalogUpdateSubtree();
 274
 275   void slotTreeListViewPopupMenuRequested( QListViewItem* itm, const QPoint &pos, int col );
 276   void slotTreeListViewCurrentChanged( QListViewItem * itm );
 277
 278   void slotFileListTablePopupMenuRequested( QListViewItem* itm, const QPoint &pos, int col );
 279   void slotSearchListTablePopupMenuRequested( QListViewItem* itm, const QPoint &pos, int col );
 280
 281   /**
 282    * Available for selection in the search results table popup menu ONLY when
 283    * one item (row) is selected; shows the catalag AND selects the folder
 284    * containing the selected item (currently only files are listed).
 285    */
 286   void slotLocateRequested();
 287
 288   void slotSearchButtonClicked();
 289   void slotClearButtonClicked();
 290   void slotDoneButtonClicked();
 291
 292   void slotUpdateProgressDisp();
 293
 294 private:
 295
 296     QWidget * main_container_widget;
 297     QTabWidget* tabWidget1;
 298     QWidget* tab;
 299     QSplitter* splitter1;
 300     kmk_tree_KListView* treeListView;
 301     kmk_files_KListView* filesListView;
 302     kmk_files_KListView* searchFilesListView;
 303     QWidget* tab_2;
 304     QTabWidget* tabWidget2;
 305     QWidget* tab_3;
 306     QPushButton* pbSearch;
 307     QPushButton* pbClear;
 308     QPushButton* pbDone;
 309     QFrame* frame1;
 310     QLabel* textLabel1;
 311     KLineEdit* leSearchFor;
 312     QWidget* tab_4;
 313
 314   KToolBar* fileToolsToolbar;
 315   KToolBar* playerActionsToolbar;
 316   KAction* fileNewAction;
 317   KAction* fileOpenAction;
 318   KAction* catalogAddNewFolderAction;
 319   KAction* fileSaveAction;
 320   KAction* fileSaveAsAction;
 321   KAction* fileCatalogFileClose;
 322   KAction* fileCatalogFileStats;
 323   KAction* fileQuitAction;
 324   KAction* programSettingsAction;
 325   KAction* listTableToggleTitleAction;
 326   KAction* TagEditAction;
 327   KAction* listTableLocateAction;
 328   KAction* playerPreviousAction;
 329   KAction* playerPlayAction;
 330   KAction* playerPauseAction;
 331   KAction* playerStopAction;
 332   KAction* playerNextAction;
 333   KAction* playerEnqueueAction;
 334   KAction* playerEnqueueDirAction;
 335   KAction* playerEnqueueDirSubdirsAction;
 336   KAction* playerPlayDirAction;
 337   KAction* playerPlayDirSubdirsAction;
 338   KAction* playerPlaySelectionAction;
 339   KAction* catalogUpdateSubtreeAction;
 340
 341   QPopupMenu* CTree_PopupMenu;
 342   QPopupMenu* CList_PopupMenu;
 343   QPopupMenu* CSearchList_PopupMenu;
 344
 345   void init_interface();
 346
 347 //  kmkWidget* kmk_widg;
 348   KListViewItem* cur_vlItem;
 349   KListViewItem* listViewRootItem;
 350   MmDataList MusicCatalog;
 351
 352   enum CatalogStateEnum {
 353       NoCatalog=0,
 354       Modified,
 355       Saved
 356   };
 357
 358   CatalogStateEnum CatalogState;
 359   void setCatalogStateAndUpdate( const kmk::CatalogStateEnum state );
 360
 361   /**
 362    * locateMode [bool] if set to TRUE indicates to the
 363    * treeListViewCurrentChanged method that it should select
 364    * the row, containing DelSelFile AND DelSelDir, if it finds them
 365    * during the FileList() table update...
 366    */
 367   bool locateMode;
 368   QString DelSelFile;
 369   QString DelSelDir;
 370
 371   void clearCatalogData( const bool UpdateState = TRUE );
 372
 373   /**
 374    * Used to indicate whether we should stop a long disk operation:
 375    * scanning, updating, etc; checked were appropriate:
 376    * in traverse_tree( const QString& dir ); and bytes_to_read_by_traverse( const QString& dir );
 377    */
 378   bool break_long_disk_operation;
 379   kmk_progress_disp* kmkProgress;
 380   QTimer* kmkProgressTimer;
 381   QTime* kmkSmooth;
 382
 383   bool FileSaveCalledFromFileSaveAs;
 384
 385   /** Finds all files in kmkWidget::TreeList() currentItem and all its subfolders
 386    *  and passes them to player_bin with parameter @param act
 387    */
 388   void playerDir( uint act );
 389
 390   /**
 391    * This private function implements recursive search at the
 392    * top level dir, specified in the @p dir parameter;
 393    * currently there are absolutely no checks if the dir is valid -
 394    * first, because this function is called from controlled environment;
 395    * second, as I described - it is recursive, so we don't want to loose
 396    * any speed, checking if we are called with valid input
 397    */
 398   unsigned long traverse_tree( const QString& dir, const QString& pf = "AUTO" );
 399
 400   /**
 401    * Remove a folder inside a MmData list and all of its children
 402    * (file AND folders)
 403    * NOTE: @p folder must NOT have the slash / symbol in the end!!!
 404    * @return 0        - on succes
 405    *         non-zero - error
 406    */
 407   uint rem_MmData_Folder( MmDataList* list, const QString& folder );
 408
 409   /**
 410    * This private function starts by clearing current contents of
 411    * Tree KListView; next it goes trough kmk's MusicCatalog, recreating
 412    * the tree, described in the MmData structure, inside the Tree view
 413    */
 414   void update_tree_view();
 415   bool tree_needs_update;
 416   void bytes_to_read_by_traverse( const QString& dir );
 417   void generateListViewXML( const KListView *list, QDomDocument doc, QDomElement e );
 418   uint generateListViewSubtreeXML( const KListViewItem *item, QDomDocument doc, QDomElement e, const uint add_lv );
 419   MmData* findMmData( const QString& folder, const QString& filename );
 420   void loadCatalog( const QString & fileName );
 421   unsigned int subDlevel;
 422   /**
 423    * Holds TRUE if Enqueue dir in kmkWidget::FileList() popup
 424    * menu should add subdirs, FALSE if not
 425    */
 426   bool _kmk_include_subdirs;
 427   /**
 428    * This boolean variable, local and private for kmk indicates
 429    * wether a popup menu, including id3 tag editor submenu
 430    * was requested at file list in the catalog tab,
 431    * or at the search result file list.
 432    */
 433   bool _popup_at_search;
 434   const QString formatted_string_from_seconds( const Q_ULLONG t );
 435   const bool catalog_has_dir( const QString & );
 436   void update_catalog_stats( MmDataList* list );
 437   /** Some stats variables
 438    * \endcode */
 439   Q_ULLONG bytes_to_read;
 440   Q_ULLONG files_to_read;
 441   Q_ULLONG total_bytes;
 442   Q_ULLONG total_files;
 443   Q_ULLONG total_folders;
 444   Q_ULLONG total_play_time;
 445   Q_ULLONG average_file_size;
 446   QString savedCaption;
 447   QString catalogFileName;
 448
 449   KmkGlobalSettings * s;
 450   KmkExtPlayer * player;
 451
 452 protected:
 453   void closeEvent( QCloseEvent* ce );
 454
 455   QVBoxLayout* kmkwidgetbaseLayout;
 456   QVBoxLayout* tabLayout;
 457   QVBoxLayout* tabLayout_2;
 458   QVBoxLayout* layout5;
 459
 460 };
 461
 462 #endif // _KMK_H_