ff_ui.h

/*
 * File:   ff_ui.h
 * Author: Jari Williamsson
 *
 * Created on den 16 januari 2011, 16:27
 *
 * User interface stuff.
 */

#ifndef FF_UI_H
#define FF_UI_H

#include "ff_base.h"

#if OPERATING_SYSTEM == MAC_OS
#include "ff_cocoa_cppinterface.h"
#endif


class FCUI : public __FCBase
{
    /* Use Finale's API for verifying font exist (default is OFF on Windows only, for performance reasons) */
    bool _useFinaleFontExistAPI;
    
    EWND _parentwindow;

        bool _starttimerfound, _endtimerfound, _performancefrequencyfound;  /* For the performance timer */
    
#if OPERATING_SYSTEM == MAC_OS
    _FCUI_cocoa _fcuicocoa;
#endif

#if OPERATING_SYSTEM == WINDOWS

    int __Windows_MessageBox(FCString* pMessage, FCString* pTitle, int styles);
#endif
public:
    enum ALERT_RETURNS {

        OKRETURN = 0,

        CANCELRETURN,

        YESRETURN,

        NORETURN,

        UNKNOWNRETURN
    };

    enum MENU_COMMANDS {
        MENUCMD_NULL = 0,

        MENUCMD_NOTESPACING,

                MENUCMD_BEATSPACING,

                MENUCMD_TIMESIGSPACING,

                MENUCMD_RESPELLNOTES,
                
                MENUCMD_MOVETOPREVSYSTEM,

                MENUCMD_MOVETONEXTSYSTEM,

                MENUCMD_LOCKSYSTEMS,

                MENUCMD_UNLOCKSYSTEMS,
                
                MENUCMD_CHECKTIES,

                MENUCMD_FILLWITHRESTS,

                MENUCMD_REMOVEMANUALSLURADJUSTMENTS,

                MENUCMD_RESETALLGROUPSANDBRACKETS,

                MENUCMD_STEMDIRECTIONUP,

                MENUCMD_STEMDIRECTIONDOWN,

                MENUCMD_STEMDIRECTIONDEFAULT,

                MENUCMD_CLEARALLITEMS,

                MENUCMD_EHSPELLING_DEFAULT,

                MENUCMD_EHSPELLING_FAVORSHARPS,

                MENUCMD_EHSPELLING_FAVORFLATS,

                MENUCMD_EHSPELLING_USESPELLINGTABLES,

        MENUCMD_REBEAM,

        MENUCMD_VIEWSCROLLVIEW,

                MENUCMD_VIEWPAGEVIEW,

                MENUCMD_VIEWSTUDIOVIEW,

                MENUCMD_REDRAWSCREEN,

        MENUCMD_EDITSCORE,

        MENUCMD_STAFFSETALLSTAVES,

        MENUCMD_STAFFSET1,

        MENUCMD_STAFFSET2,

        MENUCMD_STAFFSET3,

        MENUCMD_STAFFSET4,

        MENUCMD_STAFFSET5,

        MENUCMD_STAFFSET6,

        MENUCMD_STAFFSET7,

        MENUCMD_STAFFSET8,

        MENUCMD_RETRANSCRIBE,

                MENUCMD_CREATEMMRESTS,

                MENUCMD_BREAKMMRESTS,

                MENUCMD_SELECTIONTOOL,

                MENUCMD_STAFFTOOL,

                MENUCMD_MEASURETOOL,

                MENUCMD_KEYSIGTOOL,

                MENUCMD_TIMESIGTOOL,

                MENUCMD_CLEFTOOL,

                MENUCMD_REPEATTOOL,

        MENUCMD_ARTICULATIONTOOL,

        MENUCMD_CHORDTOOL,
        
        MENUCMD_EXPRESSIONTOOL,
        
        MENUCMD_GRAPHICSTOOL,
        
        MENUCMD_HANDGRABBERTOOL,
        
        MENUCMD_HYPERSCRIBETOOL,
        
        MENUCMD_LYRICSTOOL,
        
        MENUCMD_MIDITOOL,
        
        MENUCMD_MIRRORTOOL,
        
        MENUCMD_NOTEMOVERTOOL,
        
        MENUCMD_OSSIATOOL,
        
        MENUCMD_PAGELAYOUTTOOL,
        
        MENUCMD_RESIZETOOL,
        
        MENUCMD_SPEEDYENTRYTOOL,
        
        MENUCMD_TEMPOTOOL,
        
        MENUCMD_TEXTTOOL,
        
        MENUCMD_TUPLETTOOL,
        
        MENUCMD_ZOOMTOOL
    };


    FCUI(EWND parent) : __FCBase() 
    {
        _parentwindow = parent;
        _starttimerfound = false;
        _endtimerfound = false;
                _performancefrequencyfound = false;
        WINCODE(_useFinaleFontExistAPI = false;)  /* OFF because of huge performance issues when font name isn't found. */
                MACCODE(_useFinaleFontExistAPI = true;) /* API is fast on the Mac */
    }

    const char* ClassName() { return "FCUI"; }

    void AlertErrorCString(const char* pszMessage, const char* pszTitle = NULL);
    
    void AlertErrorUTF8(const char* pszMessage, const char* pszTitle = NULL);

    void AlertError(FCString* pMessage, FCString* pTitle = NULL);

#ifndef PDK_FRAMEWORK_LUAFRIENDLY
    ALERT_RETURNS
#else
    int
#endif
    AlertYesNoCString(const char* pszMessage, const char* pszTitle = NULL);

#ifndef PDK_FRAMEWORK_LUAFRIENDLY
    ALERT_RETURNS
#else
    int
#endif
    AlertYesNoUTF8(const char* pszMessage, const char* pszTitle = NULL);
    
    ALERT_RETURNS AlertYesNo(FCString* pMessage, FCString* pTitle = NULL);

#ifndef PDK_FRAMEWORK_LUAFRIENDLY
    FCUI::ALERT_RETURNS
#else
    int
#endif
    AlertYesNoCancelUTF8(const char* pszMessage, const char* pszTitle);
    
        ALERT_RETURNS AlertYesNoCancel(FCString* pMessage, FCString* pTitle = NULL);

#ifndef PDK_FRAMEWORK_LUAFRIENDLY
    ALERT_RETURNS
#else
    int
#endif
    AlertOkCancelCString(const char* pszMessage, const char* pszTitle = NULL);
    
#ifndef PDK_FRAMEWORK_LUAFRIENDLY
    ALERT_RETURNS
#else
    int
#endif
    AlertOkCancelUTF8(const char* pszMessage, const char* pszTitle = NULL);

    ALERT_RETURNS AlertOkCancel(FCString* pMessage, FCString* pTitle = NULL);

    void AlertNeutralCString(const char* pszMessage, const char* pszTitle = NULL);
    
    void AlertNeutralUTF8(const char* pszMessage, const char* pszTitle = NULL);

    void AlertNeutral(FCString* pMessage, FCString* pTitle = NULL);

    void AlertInfoCString(const char* pszMessage, const char* pszTitle = NULL);
    
    void AlertInfoUTF8(const char* pszMessage, const char* pszTitle = NULL);

    void AlertInfo(FCString* pMessage, FCString* pTitle = NULL);

    bool MenuCommand(
#ifndef PDK_FRAMEWORK_LUAFRIENDLY
MENU_COMMANDS menucmd
#else
int menucmd
#endif    
    );
    
    bool MenuPositionCommand(int mainmenuidx, int dropdownidx, int submenuidx);

    void RedrawDocument();

    bool IsPageView();

    bool IsPartView() { return (FX_GetCurrentPartID() != 0); }
    
    void GetDecimalSeparator(FCString* pString);
    
    void SetUseIsFontAvailableAPI(bool state) { _useFinaleFontExistAPI = state; }
    
    bool GetUseIsFontAvailableAPI() const { return _useFinaleFontExistAPI; }

    bool IsOnWindows()
    {
        WINCODE(return true;)
        MACCODE(return false;)
    }

    bool IsOnMac()
    {
        WINCODE(return false;)
        MACCODE(return true;)
    }

    bool TextToClipboard(const char* pszText);

    bool TextToClipboardUTF8(const char* pszText);

    twobyte GetCurrentPage() const;

    twobyte GetCurrentMeasure() const;

    twobyte GetZoomLevel() const;
    
    int GetMaxLayers() const;
    
    EWND GetDocumentWindow();
    
    bool ActivateDocumentWindow();
    
    EWND GetActiveWindow();
    
    bool ActivateWindow(EWND hwnd);

    EWND GetParentWindow() { return _parentwindow; }

    void MoveToMeasure(int measure, int staffno = 0);

    void Beep();

    int GetScreenWidth() const;

    int GetScreenHeight() const;

    CMPER DisplayTextExpressionDialog(CMPER cmperinit = 0);

    CMPER DisplayArticulationDialog(CMPER cmperinit = 0);

    CMPER DisplayShapeDialog(CMPER cmperinit = 0);

    eUniChar32 DisplaySymbolDialog(FCFontInfo* pFontInfo, eUniChar32 symbolinit = 0);
    
    bool IsFontAvailable(FCString* pFontName);

    bool DisplayWebURL(FCString* pURLString);
    
    bool DisplayShellFolder(FCString* pFolderString);

    void StartPerformanceTimer();

    void StopPerformanceTimer();

    double ReturnPerformanceTiming();

    static double GetHiResTimer();

#ifdef PDK_FRAMEWORK_DEBUG
    virtual void DebugDump()
    {
        __FCBase::DebugDump();
                DebugOutPtr("Parent Window: ", GetParentWindow());
                DebugOutPtr("Document Window: ", GetDocumentWindow());
    }
#endif
};

#endif  /* FF_UI_H */