musicwidgetplugin/inc/musicwidget.h
author hgs
Tue, 21 Sep 2010 11:40:39 -0500
changeset 59 cd9e40a08dda
parent 55 f3930dda3342
permissions -rw-r--r--
201037
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
36
hgs
parents:
diff changeset
     1
/*
hgs
parents:
diff changeset
     2
* Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).
hgs
parents:
diff changeset
     3
* All rights reserved.
hgs
parents:
diff changeset
     4
* This component and the accompanying materials are made available
hgs
parents:
diff changeset
     5
* under the terms of "Eclipse Public License v1.0"
hgs
parents:
diff changeset
     6
* which accompanies this distribution, and is available
hgs
parents:
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
hgs
parents:
diff changeset
     8
*
hgs
parents:
diff changeset
     9
* Initial Contributors:
hgs
parents:
diff changeset
    10
* Nokia Corporation - initial contribution.
hgs
parents:
diff changeset
    11
*
hgs
parents:
diff changeset
    12
* Contributors:
hgs
parents:
diff changeset
    13
*
hgs
parents:
diff changeset
    14
* Description:  Music player home screen widget
hgs
parents:
diff changeset
    15
*
hgs
parents:
diff changeset
    16
*/
hgs
parents:
diff changeset
    17
hgs
parents:
diff changeset
    18
#ifndef MUSICWIDGET_H
hgs
parents:
diff changeset
    19
#define MUSICWIDGET_H
hgs
parents:
diff changeset
    20
59
hgs
parents: 55
diff changeset
    21
// includes
36
hgs
parents:
diff changeset
    22
#include <hbwidget.h>
hgs
parents:
diff changeset
    23
#include <xqappmgr.h>
hgs
parents:
diff changeset
    24
hgs
parents:
diff changeset
    25
// Forward declarations
hgs
parents:
diff changeset
    26
class HbLabel;
hgs
parents:
diff changeset
    27
class HbPushButton;
hgs
parents:
diff changeset
    28
class HbIcon;
hgs
parents:
diff changeset
    29
class HbMarqueeItem;
hgs
parents:
diff changeset
    30
class MpEngine;
43
hgs
parents: 36
diff changeset
    31
class MpAlbumCoverWidget;
59
hgs
parents: 55
diff changeset
    32
class MpApplicationMonitor;
hgs
parents: 55
diff changeset
    33
class MpPlaybackData;
36
hgs
parents:
diff changeset
    34
hgs
parents:
diff changeset
    35
/**
hgs
parents:
diff changeset
    36
 * Media key identifier for push button events
hgs
parents:
diff changeset
    37
 */
59
hgs
parents: 55
diff changeset
    38
enum MediaKeyIdentifier {
36
hgs
parents:
diff changeset
    39
    EPrevious = 1,
hgs
parents:
diff changeset
    40
    EPlayPause,
hgs
parents:
diff changeset
    41
    ENext
hgs
parents:
diff changeset
    42
};
hgs
parents:
diff changeset
    43
hgs
parents:
diff changeset
    44
/**
hgs
parents:
diff changeset
    45
 * Music Player launch source identifier
hgs
parents:
diff changeset
    46
 */    
59
hgs
parents: 55
diff changeset
    47
enum LaunchIdentifier {
hgs
parents: 55
diff changeset
    48
    ELaunchToMainView,
hgs
parents: 55
diff changeset
    49
    ELaunchToNowPlayingView,
hgs
parents: 55
diff changeset
    50
    ELaunchToNowPlayingViewWithShuffle
36
hgs
parents:
diff changeset
    51
};
hgs
parents:
diff changeset
    52
hgs
parents:
diff changeset
    53
class MusicWidget: public HbWidget
hgs
parents:
diff changeset
    54
{
hgs
parents:
diff changeset
    55
    Q_OBJECT
hgs
parents:
diff changeset
    56
    
hgs
parents:
diff changeset
    57
public:    
hgs
parents:
diff changeset
    58
    MusicWidget(QGraphicsItem *parent = 0, Qt::WindowFlags flags = 0);
hgs
parents:
diff changeset
    59
    ~MusicWidget();
hgs
parents:
diff changeset
    60
hgs
parents:
diff changeset
    61
private:
hgs
parents:
diff changeset
    62
    
hgs
parents:
diff changeset
    63
    /**
hgs
parents:
diff changeset
    64
     * Setup graphics
hgs
parents:
diff changeset
    65
     */    
hgs
parents:
diff changeset
    66
    void setupUi();
hgs
parents:
diff changeset
    67
    
hgs
parents:
diff changeset
    68
    /**
hgs
parents:
diff changeset
    69
     * Get latest song data, player state and album art 
hgs
parents:
diff changeset
    70
     */      
hgs
parents:
diff changeset
    71
    void refreshData();
hgs
parents:
diff changeset
    72
    
hgs
parents:
diff changeset
    73
    /**
hgs
parents:
diff changeset
    74
     * Launch Music Player to view
hgs
parents:
diff changeset
    75
     */      
59
hgs
parents: 55
diff changeset
    76
    void launchMusicPlayer( int launchMode );
36
hgs
parents:
diff changeset
    77
    
hgs
parents:
diff changeset
    78
    /**
59
hgs
parents: 55
diff changeset
    79
     * Update widget buttons according to Music Player state
hgs
parents: 55
diff changeset
    80
     */       
hgs
parents: 55
diff changeset
    81
    void updateButtons();
hgs
parents: 55
diff changeset
    82
hgs
parents: 55
diff changeset
    83
    /**
hgs
parents: 55
diff changeset
    84
     * Connect/disconnect Music Player engine and playback data
hgs
parents: 55
diff changeset
    85
     */           
hgs
parents: 55
diff changeset
    86
    void connectMusicPlayerEngine( bool connect );
36
hgs
parents:
diff changeset
    87
    
hgs
parents:
diff changeset
    88
    /**
59
hgs
parents: 55
diff changeset
    89
     * Get the playback state
hgs
parents: 55
diff changeset
    90
     */
hgs
parents: 55
diff changeset
    91
    int getPlaybackState();
hgs
parents: 55
diff changeset
    92
hgs
parents: 55
diff changeset
    93
    /**
hgs
parents: 55
diff changeset
    94
     * Clear the song data
hgs
parents: 55
diff changeset
    95
     */
hgs
parents: 55
diff changeset
    96
    void clearData();
36
hgs
parents:
diff changeset
    97
    
hgs
parents:
diff changeset
    98
public slots:
hgs
parents:
diff changeset
    99
hgs
parents:
diff changeset
   100
    /**
59
hgs
parents: 55
diff changeset
   101
     * Widget related
36
hgs
parents:
diff changeset
   102
     */    
hgs
parents:
diff changeset
   103
    void onInitialize();
hgs
parents:
diff changeset
   104
    void onShow();
hgs
parents:
diff changeset
   105
    void onHide();
hgs
parents:
diff changeset
   106
    void onUninitialize();
hgs
parents:
diff changeset
   107
    
hgs
parents:
diff changeset
   108
    /**
59
hgs
parents: 55
diff changeset
   109
     * MpEngine related
hgs
parents: 55
diff changeset
   110
     */    
55
hgs
parents: 43
diff changeset
   111
    void libraryUpdateStarted();
36
hgs
parents:
diff changeset
   112
    void libraryUpdated();
hgs
parents:
diff changeset
   113
    void usbBlocked( bool blocked );    
hgs
parents:
diff changeset
   114
hgs
parents:
diff changeset
   115
    /**
59
hgs
parents: 55
diff changeset
   116
     * MpPlaybackData related
36
hgs
parents:
diff changeset
   117
     */        
hgs
parents:
diff changeset
   118
    void albumArtReady();
hgs
parents:
diff changeset
   119
    void playbackStateChanged();
hgs
parents:
diff changeset
   120
    void playbackInfoChanged();    
hgs
parents:
diff changeset
   121
    
hgs
parents:
diff changeset
   122
private slots:
hgs
parents:
diff changeset
   123
hgs
parents:
diff changeset
   124
    /**
hgs
parents:
diff changeset
   125
     * Slots to be called after button press
hgs
parents:
diff changeset
   126
     */    
59
hgs
parents: 55
diff changeset
   127
    void handlePrevButtonClicked();
hgs
parents: 55
diff changeset
   128
    void handlePlayButtonClicked();
hgs
parents: 55
diff changeset
   129
    void handleNextButtonClicked();
hgs
parents: 55
diff changeset
   130
    void handleAlbumArtClicked();
hgs
parents: 55
diff changeset
   131
    
hgs
parents: 55
diff changeset
   132
    /**
hgs
parents: 55
diff changeset
   133
     * MpApplicationMonitor related
hgs
parents: 55
diff changeset
   134
     */
hgs
parents: 55
diff changeset
   135
    void applicationStatusChanged( bool isrunning );
36
hgs
parents:
diff changeset
   136
    
hgs
parents:
diff changeset
   137
private:  
hgs
parents:
diff changeset
   138
    //mSongDataLayout items
59
hgs
parents: 55
diff changeset
   139
    HbLabel *mSongDataBackground;
36
hgs
parents:
diff changeset
   140
    HbMarqueeItem *mMarqueeText;
hgs
parents:
diff changeset
   141
    
hgs
parents:
diff changeset
   142
    // mControlButtonsLayout items
hgs
parents:
diff changeset
   143
    HbPushButton *mPreviousPushButton;
hgs
parents:
diff changeset
   144
    HbPushButton *mPlayPushButton;
hgs
parents:
diff changeset
   145
    HbPushButton *mNextPushButton;
hgs
parents:
diff changeset
   146
    
hgs
parents:
diff changeset
   147
    // MusicPlayer related state identifiers
hgs
parents:
diff changeset
   148
    bool mMusicPlayerUpdating;
hgs
parents:
diff changeset
   149
    bool mMusicPlayerBlocked;
59
hgs
parents: 55
diff changeset
   150
    bool mMusicPlayerRunning;
36
hgs
parents:
diff changeset
   151
    
hgs
parents:
diff changeset
   152
    // Album art for background
43
hgs
parents: 36
diff changeset
   153
    MpAlbumCoverWidget *mAlbumArt;
36
hgs
parents:
diff changeset
   154
    
hgs
parents:
diff changeset
   155
    // Used to launch MusicPlayer
hgs
parents:
diff changeset
   156
    XQApplicationManager mApplicationManager;
hgs
parents:
diff changeset
   157
    
hgs
parents:
diff changeset
   158
    // MusicPlayer control and state updates
59
hgs
parents: 55
diff changeset
   159
    MpEngine *mMpEngine;
hgs
parents: 55
diff changeset
   160
    MpPlaybackData *mMpPlaybackData;
hgs
parents: 55
diff changeset
   161
    
hgs
parents: 55
diff changeset
   162
    // Music Player observer
hgs
parents: 55
diff changeset
   163
    MpApplicationMonitor *mMpApplicationMonitor;
36
hgs
parents:
diff changeset
   164
};
hgs
parents:
diff changeset
   165
hgs
parents:
diff changeset
   166
#endif // MUSICWIDGET_H