imagemap.cpp

Go to the documentation of this file.
00001 // $Id: imagemap.cpp 1282 2006-06-09 09:46:49Z 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 // Imagemap class
00099 
00100 #include "camtypes.h"
00101 #include "imagemap.h"
00102 
00103 #include "clicarea.h"   //For ImagemapClickableArea and derived classes
00104 #include "filtimop.h"   //For ImagemapFilterOptions::GetOriginOfExportArea
00105 //#include "paths.h"        //For Path::Scale - in camtypes.h [AUTOMATICALLY REMOVED]
00106 //#include "doccoord.h" //For DocCoord::Scale - in camtypes.h [AUTOMATICALLY REMOVED]
00107 
00108 CC_IMPLEMENT_DYNAMIC(Imagemap, List)
00109 
00110 /*************************************************
00111 
00112   Constructors
00113 
00114   ***********************************************/
00115 
00116 /********************************************************************************************
00117 
00118 >   Imagemap::Imagemap() : List()
00119 
00120     Author:     Graham_Walmsley (Xara Group Ltd) <camelotdev@xara.com>
00121     Created:    15/4/97
00122     Purpose:    Default constructor
00123     
00124 ********************************************************************************************/
00125 
00126 Imagemap::Imagemap() : OverrideList()
00127 {
00128     //Does nothing
00129 }
00130 
00131 /*************************************************
00132 
00133   Destructor
00134 
00135   ***********************************************/
00136 
00137   /********************************************************************************************
00138 
00139 >   Imagemap::~Imagemap()
00140 
00141     Author:     Graham_Walmsley (Xara Group Ltd) <camelotdev@xara.com>
00142     Created:    15/4/97
00143     Purpose:    Destructor
00144     
00145 ********************************************************************************************/
00146 
00147 Imagemap::~Imagemap()
00148 {
00149     //Delete all our list items
00150     DeleteAll();
00151 }
00152 
00153 /*************************************************
00154 
00155   Adding to the imagemap
00156 
00157   ***********************************************/
00158 
00159   /********************************************************************************************
00160 
00161   > Imagemap::AddRectangle(DocRect rectToAdd, TCHAR* pcURL=NULL, TCHAR* pcFrame=NULL);
00162 
00163 
00164     Author:     Graham_Walmsley (Xara Group Ltd) <camelotdev@xara.com>
00165     Created:    15/4/97
00166     Inputs:     rectToAdd   The rectangle to add to the imagemap
00167     Purpose:    Adds a rectangular clickable region to the imagemap
00168     
00169 ********************************************************************************************/
00170 
00171 void Imagemap::AddRectangle(DocRect rectToAdd, TCHAR* pcURL, TCHAR* pcFrame)
00172 {
00173     //Create a new ImagemapClickableRectangle with the rectangle we've been given
00174     ImagemapClickableRectangle* pRectangle=new ImagemapClickableRectangle(rectToAdd, pcURL, pcFrame);
00175 
00176     //And add it to the imagemap
00177     //Note that we add it to the head of the list. That's because, in imagemaps,
00178     //the first clickable area found in the file is the one nearest the front.
00179     AddHead(pRectangle);
00180 }
00181 
00182 /********************************************************************************************
00183 
00184   > Imagemap::AddCircle(Path* pthToAdd, TCHAR* pcURL=NULL, TCHAR* pcFrame=NULL);
00185 
00186 
00187     Author:     Graham_Walmsley (Xara Group Ltd) <camelotdev@xara.com>
00188     Created:    15/4/97
00189     Inputs:     pthToAdd    The circular path to add to the imagemap
00190     Purpose:    Adds a circular clickable region to the imagemap
00191     
00192 ********************************************************************************************/
00193 
00194 void Imagemap::AddCircle(Path* pthToAdd, TCHAR* pcURL, TCHAR* pcFrame)
00195 {
00196     //Create a new ImagemapClickableCircle with our scaled path
00197     ImagemapClickableCircle* pCircle=new ImagemapClickableCircle(pthToAdd, pcURL, pcFrame);
00198 
00199     //And add it to the imagemap
00200     //Note that we add it to the head of the list. That's because, in imagemaps,
00201     //the first clickable area found in the file is the one nearest the front.
00202     AddHead(pCircle);
00203 }
00204 
00205 /********************************************************************************************
00206 
00207   > Imagemap::AddPolygon(Path* pthToAdd, TCHAR* pcURL=NULL, TCHAR* pcFrame=NULL);
00208 
00209 
00210     Author:     Graham_Walmsley (Xara Group Ltd) <camelotdev@xara.com>
00211     Created:    15/4/97
00212     Inputs:     pthToAdd    The path to add to the imagemap
00213                 
00214     Purpose:    Adds a straight-sided polygon to the imagemap
00215     
00216 ********************************************************************************************/
00217 
00218 void Imagemap::AddPolygon(Path* pthToAdd, TCHAR* pcURL, TCHAR* pcFrame)
00219 {
00220     //Create a new ImagemapClickableCircle with the path we've been given
00221     ImagemapClickablePolygon* pPolygon=new ImagemapClickablePolygon(pthToAdd, pcURL, pcFrame);
00222         
00223     //And add it to the imagemap
00224     //Note that we add it to the head of the list. That's because, in imagemaps,
00225     //the first clickable area found in the file is the one nearest the front.
00226     AddHead(pPolygon);
00227 }
00228 
00229 /*************************************************
00230 
00231   Writing out the imagemap
00232 
00233   ***********************************************/
00234 
00235 
00236 /********************************************************************************************
00237 
00238  >  INT32 Imagemap::WriteHelper(CCLexFile* pfileToWrite=NULL, TCHAR* pcBuffer=NULL)
00239                                            
00240     Author:     Graham_Walmsley (Xara Group Ltd) <camelotdev@xara.com>
00241     Created:    16/4/97
00242     Inputs:     pfileToWrite - The file to write to
00243                 pcBuffer     - Pointer to a text buffer to write to
00244 
00245                 Either of the above may be NULL.
00246 
00247   Returns:      The number of TCHARs written.
00248 
00249   Purpose:      Writes out the imagemap.
00250 
00251                 This function simply iterates through the list and calls on
00252                 the members to write themselves out.
00253     
00254 SeeAlso:        ImagemapRenderRegion::Write()
00255     
00256 ********************************************************************************************/
00257 
00258 INT32 Imagemap::Write(CCLexFile* pfileToWrite, TCHAR* pcBuffer)
00259 {
00260     //Set up a variable to remember how many bytes we have written
00261     INT32 lBytesWritten=0;
00262     
00263     //Now, get the first clickable area in the imagemap
00264     ImagemapClickableArea* pAreaToWrite=(ImagemapClickableArea*) GetHead();
00265 
00266     //And while we're still looking at a valid clickable area
00267     while (pAreaToWrite!=NULL)
00268     {
00269         //Tell that area to write itself out to the imagemap.
00270         //This function will return the number of TCHARs it writes
00271         lBytesWritten+=pAreaToWrite->Write(pfileToWrite, pcBuffer);
00272 
00273         //And move on to the next clickable area
00274         pAreaToWrite=(ImagemapClickableArea*) GetNext(pAreaToWrite);
00275     }
00276 
00277     //And return the number of TCHARs we have written
00278     return lBytesWritten;
00279     
00280 }
00281 
00282 
00283 

Generated on Sat Nov 10 03:45:31 2007 for Camelot by  doxygen 1.4.4