RE/RE_OSXWindow.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 *
 * Produced by:
 *      Mike Taylor
 *      Side Effects
 *      123 Front Street West, Suite 1401
 *      Toronto, Ontario
 *      Canada   M5J 2M2
 *      416-504-9876
 *
 * NAME:        RE_OSXWindow.h (C++)
 *
 * COMMENTS:
 *      RE_Window subclass for Mac OS X, representing a Cocoa window
 */
#ifndef __RE_OSXWindow__
#define __RE_OSXWindow__

#include "RE_API.h"
#include "RE_Types.h"
#include "RE_Window.h"
#include <UT/UT_String.h>
#include <UT/UT_MBSDUtil.h>

#include <ApplicationServices/ApplicationServices.h>

class RE_API RE_OSXWindow : public RE_Window
{
public:
    RE_OSXWindow(RE_Server *server,
              RE_WindowType type,
              RE_VisualType visType = RE_NORMAL_VIS,
              RE_WindowVisibility doOffScreen = RE_WINDOW_VISIBLE,
              bool alwaysOnTop = false);

    virtual ~RE_OSXWindow();

    virtual void setName(const char *name);
    virtual void setIconName(const char *name);
    
    virtual void        reparentWindow( RE_Window *newParent );

    virtual void         setParentOfTransient(RE_IDType transient);
    virtual RE_IDType    getParentOfTransient();
        
    virtual RE_IDType    openWindow( int isMain, int show=1 );
    virtual void         showWindow();
    virtual void         closeWindow();

    virtual void         initMaxSize(  short w, short h );
    virtual void         initMinSize(  short w, short h );
    virtual void         initClass(    char *name, char *rclass );

    // The force argument for moveWindow, sizeWindow, and 
    // moveAndSizeWindow is only really used in RE_XWindow 
    // (as called from X11_Window).  See RE_XWindow.h.
    virtual void        moveWindow(   short x, short y, int force = 1 );
    virtual void        sizeWindow(   short w, short h, int force = 1 );
    virtual void        resizeWindow( short w, short h );
    virtual void        moveAndSizeWindow(short x, short y, short w, short h, 
                                          int force = 1 );
    
    /// The NSWindow has moved or changed, update our records
    void                updatePositionAndSize();


    // Maximize the window and/or mark it as maximized so that when openWindow
    // is called, it can open the window maximized.
    virtual void        maximizeWindow();
    virtual void        restoreWindow();

    // Set the window as fullscreen. Depending on the windowing system, this
    // either informs the window manager to set us as fullscreen or simply
    // sets borders up so that higher-level classes can do the fullscreening
    // themselves.
    virtual void        fullscreenWindow(bool full);

    virtual short       getX() const;
    virtual short       getY() const;
    virtual short       getW() const;
    virtual short       getH() const;

    virtual void        lowerWindow();
    virtual void        raiseWindow();
    
    virtual void        findLocation(short *x, short *y, short *w, short *h,
                                     char topMostParent);

    // Sets the window to sit on top of all other windows, or turns off that
    // state, depending on whether newstate is true or false.
    virtual void        setWindowAlwaysOnTop(bool newstate);
    virtual void        setWindowAlwaysOnTopAndHideWhenInactive(bool newstate);
    
    virtual RE_IDType   getBufferID() const;

    virtual OGLDrawable getGraphicsDrawable();
    virtual OGLDrawable getAlternateDrawable();
    
private:
    CGRect              childFrameInScreenSpace();
    void                updateWindowBorders();
    
    CFStringRef         myName;
    UT_ObjCRef          myFullScreenSavedWindow;    // NSWindow *
    CGRect              myContentFrame;
    CGSize              myMinSize;
    CGSize              myMaxSize;
};

#endif

---