pawsmusicwindow.h

Go to the documentation of this file.

/*
 * pawsmusicwindow.h, Author: Andrea Rizzi <88whacko@gmail.com>
 *
 * Copyright (C) 2001-2011 Atomic Blue (info@planeshift.it, http://www.atomicblue.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 (version 2 of the License)
 * 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, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 *
 */

#ifndef PAWS_MUSIC_WINDOW_H
#define PAWS_MUSIC_WINDOW_H


//====================================================================================
// Project Includes
//====================================================================================
#include <clientsongmngr.h>
#include <net/cmdbase.h>
#include <paws/pawsmeterpromptwindow.h>
#include <paws/pawsstringpromptwindow.h>

//------------------------------------------------------------------------------------
// Forward Declarations
//------------------------------------------------------------------------------------
class Chord;
class Measure;
class SheetLine;
class pawsSheetLine;

class pawsMusicWindow: public pawsWidget, public psClientNetSubscriber,
    public iOnStringEnteredAction, public iOnMeterEnteredListener, iSongManagerListener
{
public:
    enum
    {
        UNALTERED,
        FLAT,
        NATURAL,
        SHARP
    };

    enum
    {
        NO_SELECTED,

        // duration buttons
        SIXTEENTH_BUTTON = 200,
        EIGHTH_BUTTON,
        QUARTER_BUTTON,
        HALF_BUTTON,
        WHOLE_BUTTON,

        // alteration buttons
        FLAT_BUTTON = 300,
        NATURAL_BUTTON,
        SHARP_BUTTON,
    };

    pawsMusicWindow();

    pawsMusicWindow(const pawsMusicWindow* origin);

    virtual ~pawsMusicWindow();

    void OnChordSelection(SheetLine* sheetLine, Measure* measure, Chord* chord, int notePosition, bool before);

    void GetMeter(int &beats, int &beatType);

    uint GetDivisions();

    // From iSongManagerListener
    virtual void OnMainPlayerSongStop();

    // From iOnMeterEnteredListener
    virtual void OnMeterEntered(const char* name, csString beats, csString beatType);

    // From iOnStringEnteredAction
    //-----------------------------
    virtual void OnStringEntered(const char* name, int param, const char* value);

    // From psClientNetSubscriber
    //----------------------------
    virtual void HandleMessage(MsgEntry* message);

    // From pawsWidget
    //-----------------
    virtual double CalcFunction(MathEnvironment* env, const char* functionName, const double* params);
    virtual void Hide();
    virtual bool PostSetup();
    virtual bool OnButtonPressed(int mouseButton, int keyModifier, pawsWidget* widget);
    virtual bool OnScroll(int scrollDirection, pawsScrollBar* widget);

private:
    friend class pawsSheetLine;

    int fifths;                        
    csString beats;                    
    csString beatType;                 
    uint tempo;                        
    uint playedTempo;                  

    SheetLine* linesHead;              
    Measure* measuresHead;             

    Chord* selectedChord;              
    Measure* selectedMeasure;          

    SheetLine* selectedSheetLine;

    int  selectedDurButton;            
    int  selectedAlterButton;          

    uint32_t currentItemID;            
    bool readOnly;                     
    bool edited;                       
    bool pendingString;                
    bool editMode;                     
    bool insertMode;                   

    pawsButton* editButton;
    pawsButton* playButton;
    pawsWidget* loadButton;
    pawsWidget* saveButton;
    pawsWidget* titleButton;

    pawsButton* doubleStaffButton;
    pawsWidget* tonalityButton;
    pawsWidget* meterButton;
    pawsWidget* bpmButton;
    pawsButton* restButton;

    pawsButton* sixteenthButton;
    pawsButton* eighthButton;
    pawsButton* quarterButton;
    pawsButton* halfButton;
    pawsButton* wholeButton;
    pawsButton* dotButton;

    pawsButton* flatButton;
    // pawsButton* naturalButton; TODO support natural notes in song stream before use this
    pawsButton* sharpButton;

    pawsWidget* deleteChordButton;
    pawsWidget* deleteMeasureButton;
    pawsButton* insertNoteButton;
    pawsWidget* insertMeasureButton;

    pawsButton* startRepeatButton;
    pawsButton* endRepeatButton;
    pawsButton* endingButton;

    pawsSheetLine* pawsLine1;
    pawsSheetLine* pawsLine2;

    pawsScrollBar* scrollBar;

    static void OnSheetLineCallback(void* object, SheetLine* sheetLine);

    void Unload();

    bool LoadXML(csRef<iDocument> sheet);

    csString ToXML(bool usePlayedTempo);

    SheetLine* GetSheetLine(int index);

    SheetLine* GetSelectedSheetLine();

    void UpdateScrollBar();

    void UpdateLines(SheetLine* line, bool forceAll);

    void DisplaySelectedMeasure();

    pawsButton* GetButton(int buttonID);

    void DeleteSelectedChord();

    void DeleteSelectedMeasure();

    void InsertMeasure();

    void SetInsertMode(bool toggle);

    void ToggleEditMode(bool toggle);

    void PlayStop();

    void Save();

    void Load();

    void ChangeSongTitle();

    void SwitchDoubleStaff();

    void ChangeTonality();

    void ChangeMeter();

    void ChangeBPM();

    void SetPlayedBPM();

    void ChangeChordDuration();

    void SetEndRepeat();

    void SetEnding();

    int GetSelectedDuration();

    void SetDurationButton(int duration);

    void SelectDuration(int buttonID);

    void SelectAlteration(int buttonID);

    void SetToolbarButtons();

    void ResetState();

    void DeleteAll();
};

CREATE_PAWS_FACTORY(pawsMusicWindow);

#endif // PAWS_MUSIC_WINDOW_H