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