animparams.h

Go to the documentation of this file.
00001 // $Id: animparams.h 820 2006-04-16 18:18:19Z alex $
00002 /* @@tag:xara-cn@@ DO NOT MODIFY THIS LINE
00003 ================================XARAHEADERSTART===========================
00004  
00005                Xara LX, a vector drawing and manipulation program.
00006                     Copyright (C) 1993-2006 Xara Group Ltd.
00007        Copyright on certain contributions may be held in joint with their
00008               respective authors. See AUTHORS file for details.
00009 
00010 LICENSE TO USE AND MODIFY SOFTWARE
00011 ----------------------------------
00012 
00013 This file is part of Xara LX.
00014 
00015 Xara LX is free software; you can redistribute it and/or modify it
00016 under the terms of the GNU General Public License version 2 as published
00017 by the Free Software Foundation.
00018 
00019 Xara LX and its component source files are distributed in the hope
00020 that it will be useful, but WITHOUT ANY WARRANTY; without even the
00021 implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
00022 See the GNU General Public License for more details.
00023 
00024 You should have received a copy of the GNU General Public License along
00025 with Xara LX (see the file GPL in the root directory of the
00026 distribution); if not, write to the Free Software Foundation, Inc., 51
00027 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
00028 
00029 
00030 ADDITIONAL RIGHTS
00031 -----------------
00032 
00033 Conditional upon your continuing compliance with the GNU General Public
00034 License described above, Xara Group Ltd grants to you certain additional
00035 rights. 
00036 
00037 The additional rights are to use, modify, and distribute the software
00038 together with the wxWidgets library, the wxXtra library, and the "CDraw"
00039 library and any other such library that any version of Xara LX relased
00040 by Xara Group Ltd requires in order to compile and execute, including
00041 the static linking of that library to XaraLX. In the case of the
00042 "CDraw" library, you may satisfy obligation under the GNU General Public
00043 License to provide source code by providing a binary copy of the library
00044 concerned and a copy of the license accompanying it.
00045 
00046 Nothing in this section restricts any of the rights you have under
00047 the GNU General Public License.
00048 
00049 
00050 SCOPE OF LICENSE
00051 ----------------
00052 
00053 This license applies to this program (XaraLX) and its constituent source
00054 files only, and does not necessarily apply to other Xara products which may
00055 in part share the same code base, and are subject to their own licensing
00056 terms.
00057 
00058 This license does not apply to files in the wxXtra directory, which
00059 are built into a separate library, and are subject to the wxWindows
00060 license contained within that directory in the file "WXXTRA-LICENSE".
00061 
00062 This license does not apply to the binary libraries (if any) within
00063 the "libs" directory, which are subject to a separate license contained
00064 within that directory in the file "LIBS-LICENSE".
00065 
00066 
00067 ARRANGEMENTS FOR CONTRIBUTION OF MODIFICATIONS
00068 ----------------------------------------------
00069 
00070 Subject to the terms of the GNU Public License (see above), you are
00071 free to do whatever you like with your modifications. However, you may
00072 (at your option) wish contribute them to Xara's source tree. You can
00073 find details of how to do this at:
00074   http://www.xaraxtreme.org/developers/
00075 
00076 Prior to contributing your modifications, you will need to complete our
00077 contributor agreement. This can be found at:
00078   http://www.xaraxtreme.org/developers/contribute/
00079 
00080 Please note that Xara will not accept modifications which modify any of
00081 the text between the start and end of this header (marked
00082 XARAHEADERSTART and XARAHEADEREND).
00083 
00084 
00085 MARKS
00086 -----
00087 
00088 Xara, Xara LX, Xara X, Xara X/Xtreme, Xara Xtreme, the Xtreme and Xara
00089 designs are registered or unregistered trademarks, design-marks, and/or
00090 service marks of Xara Group Ltd. All rights in these marks are reserved.
00091 
00092 
00093       Xara Group Ltd, Gaddesden Place, Hemel Hempstead, HP2 6EX, UK.
00094                         http://www.xara.com/
00095 
00096 =================================XARAHEADEREND============================
00097  */
00098 
00099 #ifndef INC_ANIMPARAMS
00100 #define INC_ANIMPARAMS
00101 
00102 #include "ops.h"
00103 #include "paldefs.h"
00104 
00105 /*******************************************************************************************************
00106 
00107   class FramePropertiesParam : publc OpParam
00108 
00109   Author:   Ranbir_Rana (Xara Group Ltd) <camelotdev@xara.com>
00110   Created:  30/04/97
00111   Purpose:  Allows the transfer of data from our Frame Gallery to our current layer object.
00112                 
00113 ********************************************************************************************************/
00114 
00115 class FramePropertiesParam: public OpParam
00116 {
00117 
00118 //  CC_DECLARE_DYNAMIC(FramePropertiesParam)
00119 
00120 public:
00121     FramePropertiesParam();
00122 
00123     String_256& GetFrameName()                              { return m_FrameName;   };
00124     void        SetFrameName(const String_256& Name)        { m_FrameName = Name;   };
00125     UINT32      GetAnimDelay () const                       { return m_FrameDelay;  };
00126     void        SetAnimDelay(const UINT32& Delay)           { m_FrameDelay = Delay; };
00127     BOOL        GetOverlay()                                { return m_Overlay;     };
00128     void        SetOverlay (const BOOL& Val)                { m_Overlay = Val;      };
00129     BOOL        GetSolid()                                  { return m_Solid;       };
00130     void        SetSolid (const BOOL& Val)                  { m_Solid = Val;        };
00131 
00132 protected:
00133     String_256 m_FrameName;             // Name of the selected bitmap.
00134     UINT32     m_FrameDelay;            // Delay between frames for Animations.
00135     BOOL m_Overlay;                     // Set if the previous layer is said to overlay the
00136                                         //  previous one rathar than  obscure it.
00137     BOOL m_Solid;                       // A solid frame/layer is like a background layer in
00138                                         // that it forms the background for frames above it.
00139 };
00140 
00141 
00142 /*******************************************************************************************************
00143 
00144   class AnimPropertiesParam : publc OpParam
00145 
00146   Author:   Ranbir_Rana (Xara Group Ltd) <camelotdev@xara.com>
00147   Created:  30/04/97
00148   Purpose:  Allows the transfer of data from our Frame Gallery to a current spread object.
00149                 
00150 ********************************************************************************************************/
00151 class AnimPropertiesParam: public OpParam
00152 {
00153     CC_DECLARE_DYNAMIC(AnimPropertiesParam)
00154 
00155 public:
00156     AnimPropertiesParam();
00157 
00158     DWORD           GetAnimLoop()const                          { return m_Animloop;            };
00159     void            SetAnimLoop(const DWORD& Loop)              { m_Animloop = Loop;            };
00160     DWORD           GetGlobalAnimDelay() const                  { return m_GlobalAnimDelay;     };
00161     void            SetGlobalanimDelay(const DWORD& Delay)      { m_GlobalAnimDelay = Delay;    };
00162     DITHER          GetDither()const                            { return m_Dither;              };
00163     void            SetDither(const DITHER& dither)             { m_Dither = dither;            };
00164     WEB_PALETTE     GetPalette() const                          { return m_Palette;             };
00165     void            SetPalette(const WEB_PALETTE& Palette)      { m_Palette = Palette;          };
00166     DWORD           GetNumColsInPalette() const                 { return m_NumColsInPalette;    };
00167     void            SetNumColsInPalette(const DWORD& num)       { m_NumColsInPalette = num;     };
00168     PALETTE_COLOURS GetPaletteCols() const                      { return m_PaletteColours;      };
00169     void            SetPaletteCols(const PALETTE_COLOURS& Pal)  { m_PaletteColours = Pal;       };
00170     BOOL            GetUseSystemCols() const                    { return m_UseSystemColours;    };
00171     void            SetUseSystemCols(const BOOL &Val)           { m_UseSystemColours = Val;     };
00172     BOOL            GetIsBackGroundTransp() const               { return m_BackGroundIsTransp;  };
00173     void            SetIsBackGroundTransp(const BOOL &Val)      { m_BackGroundIsTransp = Val;   };
00174 
00175     AnimPropertiesParam& operator=(const AnimPropertiesParam& obj);
00176 
00177 protected:
00178 
00179     DWORD           m_Animloop; 
00180     DWORD           m_GlobalAnimDelay;      
00181     DITHER          m_Dither;               // Dither type
00182     WEB_PALETTE     m_Palette;              // Global\Local
00183     PALETTE_COLOURS m_PaletteColours;       // Browser\Optimised
00184     DWORD           m_NumColsInPalette;
00185     BOOL            m_UseSystemColours;
00186     BOOL            m_BackGroundIsTransp;
00187 
00188 public:
00189     // Stores and gives access to the bounding rectangle of the export
00190     // If this changes then we will need to regenerate all frames
00191     void            SetBoundingRect(const DocRect& BoundingRect)    { m_BoundingRect = BoundingRect; };
00192     DocRect         GetBoundingRect() const                         { return m_BoundingRect;        };
00193     
00194     // Stores and gives access to the capture quality of the export
00195     // If this changes then we will need to regenerate all frames
00196     void            SetAnimationQuality(const Quality& NewQuality)  { m_Quality = NewQuality; };
00197     Quality         GetAnimationQuality() const                     { return m_Quality;     };
00198 
00199 protected:
00200     DocRect         m_BoundingRect;
00201     Quality         m_Quality;
00202 };
00203 
00204 #endif  // INC_ANIMPARAMS
00205 

Generated on Sat Nov 10 03:44:09 2007 for Camelot by  doxygen 1.4.4