Source/WindowSystem/Cocoa/OSGCocoaWindow.h

   1 /*---------------------------------------------------------------------------*\
   2  *                                OpenSG                                     *
   3  *                                                                           *
   4  *                                                                           *
   5  *               Copyright (C) 2000-2006 by the OpenSG Forum                 *
   6  *                                                                           *
   7  *                            www.opensg.org                                 *
   8  *                                                                           *
   9  *   contact: dirk@opensg.org, gerrit.voss@vossg.org, jbehr@zgdv.de          *
  10  *                                                                           *
  11 \*---------------------------------------------------------------------------*/
  12 /*---------------------------------------------------------------------------*\
  13  *                                License                                    *
  14  *                                                                           *
  15  * This library is free software; you can redistribute it and/or modify it   *
  16  * under the terms of the GNU Library General Public License as published    *
  17  * by the Free Software Foundation, version 2.                               *
  18  *                                                                           *
  19  * This library is distributed in the hope that it will be useful, but       *
  20  * WITHOUT ANY WARRANTY; without even the implied warranty of                *
  21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU         *
  22  * Library General Public License for more details.                          *
  23  *                                                                           *
  24  * You should have received a copy of the GNU Library General Public         *
  25  * License along with this library; if not, write to the Free Software       *
  26  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.                 *
  27  *                                                                           *
  28 \*---------------------------------------------------------------------------*/
  29 /*---------------------------------------------------------------------------*\
  30  *                                Changes                                    *
  31  *                                                                           *
  32  *                                                                           *
  33  *                                                                           *
  34  *                                                                           *
  35  *                                                                           *
  36  *                                                                           *
  37 \*---------------------------------------------------------------------------*/
  38
  39 #ifndef _OSGCOCOAWINDOW_H_
  40 #define _OSGCOCOAWINDOW_H_
  41 #ifdef __sgi
  42 #pragma once
  43 #endif
  44
  45 #if defined(__APPLE__) || defined(OSG_DO_DOC)
  46
  47 #include "OSGCocoaWindowBase.h"
  48
  49 OSG_BEGIN_NAMESPACE
  50
  51 /*! \brief CocoaWindow class. See \ref
  52            PageWindowCocoa for a description.
  53     \ingroup GrpWindowCocoaObj
  54     \ingroup GrpLibOSGWindowCocoa
  55     \includebasedoc
  56  */
  57
  58 class OSG_WINDOWCOCOA_DLLMAPPING CocoaWindow : public CocoaWindowBase
  59 {
  60   protected:
  61
  62     /*==========================  PUBLIC  =================================*/
  63
  64   public:
  65
  66     typedef CocoaWindowBase Inherited;
  67     typedef CocoaWindow     Self;
  68
  69     /*---------------------------------------------------------------------*/
  70     /*! \name                      Sync                                    */
  71     /*! \{                                                                 */
  72
  73     virtual void changed(ConstFieldMaskArg whichField,
  74                          UInt32            origin,
  75                          BitVector         details    );
  76
  77     /*! \}                                                                 */
  78     /*---------------------------------------------------------------------*/
  79     /*! \name                     Output                                   */
  80     /*! \{                                                                 */
  81
  82     virtual void dump(      UInt32     uiIndent = 0,
  83                       const BitVector  bvFlags  = 0) const;
  84
  85     /*! \}                                                                 */
  86     /*---------------------------------------------------------------------*/
  87     /*! \name                Window functions                              */
  88     /*! \{                                                                 */
  89
  90     virtual void init     (GLInitFunctor oFunc = GLInitFunctor());
  91     virtual void terminate(void                                 );
  92
  93     /*! \}                                                                 */
  94     /*=========================  PROTECTED  ===============================*/
  95
  96   protected:
  97
  98     // Variables should all be in CocoaWindowBase.
  99
 100     /*---------------------------------------------------------------------*/
 101     /*! \name                  Constructors                                */
 102     /*! \{                                                                 */
 103
 104     CocoaWindow(void);
 105     CocoaWindow(const CocoaWindow &source);
 106
 107     /*! \}                                                                 */
 108     /*---------------------------------------------------------------------*/
 109     /*! \name                   Destructors                                */
 110     /*! \{                                                                 */
 111
 112     virtual ~CocoaWindow(void);
 113
 114     /*! \}                                                                 */
 115     /*---------------------------------------------------------------------*/
 116     /*! \name                      Init                                    */
 117     /*! \{                                                                 */
 118
 119     static void initMethod(InitPhase ePhase);
 120
 121     /*! \}                                                                 */
 122     /*---------------------------------------------------------------------*/
 123     /*! \name      Window system implementation functions                  */
 124     /*! \{                                                                 */
 125
 126     virtual void doActivate  (void);
 127     virtual void doDeactivate(void);
 128     virtual bool doSwap      (void);
 129     virtual bool hasContext  (void);
 130
 131     /*! \}                                                                 */
 132     /*==========================  PRIVATE  ================================*/
 133
 134   private:
 135
 136     friend class FieldContainer;
 137     friend class CocoaWindowBase;
 138
 139     // prohibit default functions (move to 'public' if you need one)
 140     void operator =(const CocoaWindow &source);
 141 };
 142
 143 typedef CocoaWindow *CocoaWindowP;
 144
 145 OSG_END_NAMESPACE
 146
 147 #include "OSGCocoaWindowBase.inl"
 148 #include "OSGCocoaWindow.inl"
 149
 150 #endif /* __APPLE__ */
 151
 152 #endif /* _OSGCOCOAWINDOW_H_ */