/Users/airy/Sources/augui/AUGUIFramework/AU View/AUCarbonViewNib.h

Go to the documentation of this file.

/*
 *  CAUCarbonViewNib.h
 *  CAUCarbonViewNib
 
 *
 *  Created by Airy AndrŽ on Sun Oct 06 2002.
 *  Copyright (c) 2002 Airy AndrŽ. All rights reserved.
 *
 */

#ifndef __AUCARBONVIEWNIB_H__
#define __AUCARBONVIEWNIB_H__

#include <map>
#include <set>

// Plugin views are based on this class
#include "AUCarbonViewBase.h"
#include "CACFDictionary.h"

#include "AUOid.h"

#define kAUNibControlSignature 'AUid'

#define kAUPanelControlSignature 'AUpn'

#define kAUNibUserPaneControlID 9999

#define kDefaultWindowNibName CFSTR("window")
#define kDefaultCompositingWindowNibName CFSTR("windowCompositing")
#define kDefaultNoCompositingWindowNibName kDefaultWindowNibName
#define kDefaultBackgroundImageFileName CFSTR("AUBackground.png")
#define kDefaultAboutImageFileName CFSTR("about.png")

#define kProperty_MIDILearn 100000

class CAUCarbonViewEditor;

class CAUCarbonViewNib: public AUCarbonViewBase
{
public:
    // Construction ------------------------------
    CAUCarbonViewNib(AudioUnitCarbonView inInstance);
    virtual ~CAUCarbonViewNib();
    
    // Configuration Methods -----------------------
    virtual CFStringRef GetBundleID() = 0;
    virtual CFStringRef GetWindowNibName() { return kDefaultWindowNibName; }
    virtual CFStringRef GetWindowCompositingName() { return kDefaultCompositingWindowNibName; }
    virtual CFStringRef GetWindowNoCompositingName() { return kDefaultNoCompositingWindowNibName; }
    
    virtual bool HasBackgroundPict() { return true; }
    virtual CFStringRef GetBackgroundFilename() { return kDefaultBackgroundImageFileName; }
    virtual CFStringRef GetAboutFilename() { return kDefaultAboutImageFileName; }
    virtual CFStringRef GetTextBackgroundFilename() { return 0; }
    virtual CFStringRef GetFontname() { return 0; }
    virtual int GetFontsize() { return 12; }
    virtual int GetTextJustification() { return teJustLeft; }
        virtual void GetTextColor(RGBColor *foreColor);

    virtual bool PatchEraseRect() { return true; }
    
    virtual bool HasTimer() { return true;};
    virtual float TimerResolution() { return 50.;};
    virtual void Idle() {};
    
    virtual bool SupportEditMode() const { return false; }

    // Baseclass overrides -----------------------
    OSStatus CreateUI(Float32,          // x position within parent window
                      Float32);         // y position within parent window
    
    virtual void InitWindow(CFBundleRef sBundle); // Register custom controls...
    virtual void FinishWindow(CFBundleRef sBundle); // Called after window creation
    virtual bool HandleCommand(EventRef inEvent, HICommandExtended &cmd) { return false;};
    
        virtual bool HandleGestureEventForView(EventRef event, HIViewRef view);

    virtual bool HandleEventForView(EventRef event, HIViewRef view);

    virtual bool HandleEventForContextualMenu(EventRef event, HIViewRef view) { return false; }

    virtual bool HandleEvent(EventRef event);
    
    // Used by QD patch for controls to have the window background (for non compositing windows)
    virtual CGImageRef GetBackgroundImage() { return mBackgroundImage; }
    virtual void GetPaneBounds(Rect *rect);
    virtual HIViewRef GetRootPane() const { return mRootUserPane; }
    
    virtual void PropertyHasChanged(AudioUnitPropertyID inPropertyID, AudioUnitScope inScope,  
                                    AudioUnitElement inElement);
    
    CFBundleRef GetBundleRef() { return mBundleRef; }
    
        void InitXML();
        void SaveXML();

        void updateXMLForControl(HIViewRef control);
        void updateControlFromXML(HIViewRef control);

protected:
        virtual HIViewRef BuildViewFromOid(AUGUI::oid_t oid);
        virtual bool BuildFromXML();
    virtual int SwitchPane(int paneID, int paneNumber);
    virtual void BindPane(HIViewRef thePane, AUGUI::oid_t oid);
    virtual void BuildMultiPane(HIViewRef control, AUGUI::oid_t parent);
    virtual void BuildDynamicViews(HIViewRef control, AUGUI::oid_t parent);
    virtual void BindView(HIViewRef control, AUGUI::oid_t oid);
    
    virtual void RegisterPropertyChanges(AudioUnitPropertyID inPropertyID);
    virtual void UnRegisterPropertyChanges(AudioUnitPropertyID inPropertyID);
    virtual void UnRegisterAllPropertiesChanges();

    virtual bool HandleEventPlayMode(EventRef event);
    
        virtual void DisplayOverlay(CFStringRef pictName);
    
    static void PropertyChangedProc(void* inUserData, AudioUnit inComponentInstance,  
                                    AudioUnitPropertyID inPropertyID, AudioUnitScope inScope,  
                                    AudioUnitElement inElement);
    
    void SetEditMode(bool mode);
    bool EditMode() const { return mEditMode; };
    
        bool GetDictionaryForOid(CACFDictionary &element, AUGUI::oid_t);
        bool AddDictionaryForOid(CACFDictionary &element, AUGUI::oid_t oid);
        
        void AddUnknownControls(HIViewRef view, AUGUI::oid_t fromOid);
        
        void AddControlEventHandler(HIViewRef from);

        // Baseclass overrides -----------------------
//    virtual void RespondToEventTimer (EventLoopTimerRef inTimer) { Idle(); }

    CQDProcs mProcs;
    CQDProcs* mCurrentProcsPtr;
    CGImageRef mBackgroundImage;
    CFStringRef mBundleID;
    CFBundleRef mBundleRef;
    HIViewRef mRootUserPane;
    
    int mPaneID;

    bool mEditMode;
    CAUCarbonViewEditor *mEditor;

        CACFDictionary mXml;
        
    EventLoopTimerRef mTimer;
        
    std::set<AudioUnitPropertyID> mPropertiesRegistered;
        std::map<HIViewRef, AUGUI::oid_t> mOids;
        std::map<AUGUI::oid_t, HIViewRef> mViews;
};
#endif
// -----------------------------------------------------------------------------
// End of file.
// -----------------------------------------------------------------------------

---

---