Source/System/Window/Foreground/OSGFileGrabForeground.h

   1 /*---------------------------------------------------------------------------*\
   2  *                                OpenSG                                     *
   3  *                                                                           *
   4  *                                                                           *
   5  *             Copyright (C) 2000-2002 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 _OSGFILEGRABFOREGROUND_H_
  40 #define _OSGFILEGRABFOREGROUND_H_
  41 #ifdef __sgi
  42 #pragma once
  43 #endif
  44
  45 #include "OSGFileGrabForegroundBase.h"
  46
  47 OSG_BEGIN_NAMESPACE
  48
  49 /*! \brief Foreground class for grabbing the image to a file. See \ref
  50            PageSystemWindowForegroundGrabFile for a description.
  51     \ingroup GrpWindowForegroundObj
  52     \ingroup GrpLibOSGWindow
  53     \includebasedoc
  54  */
  55
  56 class OSG_WINDOW_DLLMAPPING FileGrabForeground : public FileGrabForegroundBase
  57 {
  58   private:
  59
  60     /*==========================  PUBLIC  =================================*/
  61
  62   public:
  63
  64     typedef FileGrabForegroundBase Inherited;
  65
  66     /*---------------------------------------------------------------------*/
  67     /*! \name                      Sync                                    */
  68     /*! \{                                                                 */
  69
  70     virtual void changed(ConstFieldMaskArg whichField,
  71                          UInt32            origin,
  72                          BitVector         detail);
  73
  74     /*! \}                                                                 */
  75     /*---------------------------------------------------------------------*/
  76     /*! \name                     Output                                   */
  77     /*! \{                                                                 */
  78
  79     virtual void dump(      UInt32     uiIndent = 0,
  80                       const BitVector  bvFlags  = 0) const;
  81
  82     /*! \}                                                                 */
  83     /*=========================  PROTECTED  ===============================*/
  84
  85   protected:
  86
  87     // Variables should all be in FileGrabForegroundBase.
  88
  89     /*---------------------------------------------------------------------*/
  90     /*! \name                  Constructors                                */
  91     /*! \{                                                                 */
  92
  93     FileGrabForeground(void);
  94     FileGrabForeground(const FileGrabForeground &source);
  95
  96     /*! \}                                                                 */
  97     /*---------------------------------------------------------------------*/
  98     /*! \name                   Destructors                                */
  99     /*! \{                                                                 */
 100
 101     virtual ~FileGrabForeground(void);
 102
 103     /*! \}                                                                 */
 104     /*---------------------------------------------------------------------*/
 105     /*! \name                   draw                                       */
 106     /*! \{                                                                 */
 107
 108     virtual void draw(DrawEnv *pEnv);
 109
 110     /*! \}                                                                 */
 111     /*---------------------------------------------------------------------*/
 112     /*! \name                       Init                                   */
 113     /*! \{                                                                 */
 114
 115     static void initMethod(InitPhase ePhase);
 116
 117     /*! \}                                                                 */
 118     /*==========================  PRIVATE  ================================*/
 119
 120   private:
 121
 122     friend class FieldContainer;
 123     friend class FileGrabForegroundBase;
 124
 125     // prohibit default functions (move to 'public' if you need one)
 126     void operator =(const FileGrabForeground &source);
 127 };
 128
 129 typedef FileGrabForeground *FileGrabForegroundP;
 130
 131 OSG_END_NAMESPACE
 132
 133 #include "OSGFileGrabForegroundBase.inl"
 134 #include "OSGFileGrabForeground.inl"
 135
 136 #endif /* _OSGFILEGRABFOREGROUND_H_ */