oiltool.cpp

Go to the documentation of this file.
00001 // $Id: oiltool.cpp 751 2006-03-31 15:43: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 
00099 /*
00100 */
00101 
00102 #include "camtypes.h"
00103 #include "oiltool.h"
00104 #include "oilmods.h"
00105 
00106 DECLARE_SOURCE("$Revision: 751 $");
00107 
00108 /********************************************************************************************
00109 
00110 >   OILTool::OILTool(UINT32 ModuleID)
00111 
00112     Author:     Tim_Browse (Xara Group Ltd) <camelotdev@xara.com>
00113     Created:    6/7/93
00114     Inputs:     ModuleID - the ID of the module that owns this Tool.
00115     Outputs:    -
00116     Returns:    -
00117     Purpose:    Create an OILTool object that can be linked to a Tool object (via a
00118                 ToolListItem object).  This object (the OILTool) knows the instance handle
00119                 of the DLL that contains the tool.
00120     Errors:     -
00121     SeeAlso:    Tool; ToolListItem; Module; ModuleListItem
00122 
00123 ********************************************************************************************/
00124 
00125 
00126 OILTool::OILTool(UINT32 ModuleID)
00127 {
00128     // Obtain and remember the Instance handle of the DLL that holds the resources
00129     // of the parent module of this tool (and hence holds the resources of the tool).
00130     hInstance = OILModule::GetInstance(ModuleID);
00131 }
00132 
00133 /********************************************************************************************
00134 
00135 >   HCURSOR OILTool::LoadCursor(UINT32 ID)
00136 
00137     Author:     Tim_Browse (Xara Group Ltd) <camelotdev@xara.com>
00138     Created:    6/7/93
00139     Inputs:     ID - The resource ID of the cursor to load.
00140     Outputs:    -
00141     Returns:    The handle to the loaded cursor, or NULL if unsuccessful
00142     Purpose:    Find a cursor resource, which may be in the kernel's resources, or it
00143                 may be from the tool's own resources.
00144     Errors:     -
00145     SeeAlso:    -
00146 
00147 ********************************************************************************************/
00148     
00149 HCURSOR OILTool::LoadCursor(UINT32 ID)
00150 {
00151     HINSTANCE Inst;
00152     
00153     if ((DLLs[0] == (HINSTANCE)HINSTANCE_ERROR || DLLs[0] == 0) || ((ID >= KID_FIRST) && (ID <= KID_LAST)))
00154         Inst = AfxGetResourceHandle();  // Kernel resource - get the HINSTANCE of our dll, or .EXE
00155     else
00156         Inst = hInstance;               // otherwise use the HINSTANCE of the Tool's DLL
00157 
00158     // If the HINSTANCE we have is valid, attempt to load the resource, otherwise
00159     // return a NULL value.
00160         
00161     if (Inst > (HINSTANCE)HINSTANCE_ERROR)
00162         return ::LoadCursor(Inst, MAKEINTRESOURCE(ID));
00163     else
00164         return NULL;
00165 }
00166 
00167 /********************************************************************************************
00168 
00169 >   HBITMAP OILTool::LoadBitmap(UINT32 ID)
00170 
00171     Author:     Tim_Browse (Xara Group Ltd) <camelotdev@xara.com>
00172     Created:    6/7/93
00173     Inputs:     ID - The resource ID of the bitmap to load.
00174     Outputs:    -
00175     Returns:    The handle to the loaded bitmap, or NULL if unsuccessful
00176     Purpose:    Find a bitmap resource, which may be in the kernel's resources, or it
00177                 may be from the tool's own resources.
00178     Errors:     -
00179     SeeAlso:    -
00180 
00181 ********************************************************************************************/
00182     
00183 HBITMAP OILTool::LoadBitmap(UINT32 ID)
00184 {
00185     HINSTANCE Inst;
00186     
00187     if ((DLLs[0] == (HINSTANCE)HINSTANCE_ERROR || DLLs[0] == 0) || ((ID >= KID_FIRST) && (ID <= KID_LAST)))
00188         Inst = AfxGetResourceHandle();  // Kernel resource - get the HINSTANCE of our .EXE
00189     else
00190         Inst = hInstance;               // otherwise use the HINSTANCE of the Tool's DLL
00191         
00192     // If the HINSTANCE we have is valid, attempt to load the resource, otherwise
00193     // return a NULL value.
00194         
00195     if (Inst > (HINSTANCE)HINSTANCE_ERROR)
00196         return ::LoadBitmap(Inst, MAKEINTRESOURCE(ID));
00197     else
00198         return NULL;
00199 }
00200 
00201 /********************************************************************************************
00202 
00203 >   HICON OILTool::LoadIcon(UINT32 ID)
00204 
00205     Author:     Tim_Browse (Xara Group Ltd) <camelotdev@xara.com>
00206     Created:    6/7/93
00207     Inputs:     ID - The resource ID of the icon to load.
00208     Outputs:    -
00209     Returns:    The handle to the loaded icon, or NULL if unsuccessful
00210     Purpose:    Find an icon resource, which may be in the kernel's resources, or it
00211                 may be from the tool's own resources.
00212     Errors:     -
00213     SeeAlso:    -
00214 
00215 ********************************************************************************************/
00216     
00217 HICON OILTool::LoadIcon(UINT32 ID)
00218 {
00219     HINSTANCE Inst;
00220     
00221     if ((DLLs[0] == (HINSTANCE)HINSTANCE_ERROR || DLLs[0] == 0) || ((ID >= KID_FIRST) && (ID <= KID_LAST)))
00222         Inst = AfxGetResourceHandle();  // Kernel resource - get the HINSTANCE of our .EXE
00223     else
00224         Inst = hInstance;               // otherwise use the HINSTANCE of the Tool's DLL
00225         
00226     // If the HINSTANCE we have is valid, attempt to load the resource, otherwise
00227     // return a NULL value.
00228         
00229     if (Inst > (HINSTANCE)HINSTANCE_ERROR)
00230         return ::LoadIcon(Inst, MAKEINTRESOURCE(ID));
00231     else
00232         return NULL;
00233 }
00234     
00235 /********************************************************************************************
00236 
00237 >   BOOL OILTool::LoadString(UINT32 ID, String*)
00238 
00239     Author:     Mario_Shamtani (Xara Group Ltd) <camelotdev@xara.com>
00240     Created:    9/8/93
00241     Inputs:     ID - The resource ID of the string to load.
00242     Outputs:    The String that was loaded
00243     Returns:    TRUE if String is loaded successfully, or FALSE Otherwise
00244     Purpose:    Find a string resource, which may be in the kernel's resources, or it
00245                 may be from the tool's own resources.
00246     Errors:     -
00247     SeeAlso:    -
00248 
00249 ********************************************************************************************/
00250     
00251 BOOL OILTool::LoadString(UINT32 ID, char* Description)
00252 {
00253     // Maximum allowable size of a windows string resource
00254     const INT32 MaxStringSize = 256;
00255 
00256     HINSTANCE Inst;
00257     
00258     if ((DLLs[0] == (HINSTANCE)HINSTANCE_ERROR || DLLs[0] == 0) || ((ID >= KID_FIRST) && (ID <= KID_LAST)))
00259         Inst = AfxGetResourceHandle();  // Kernel resource - get the HINSTANCE of our .EXE
00260     else
00261         Inst = hInstance;               // otherwise use the HINSTANCE of the Tool's DLL
00262         
00263     // If the HINSTANCE we have is valid, attempt to load the resource, otherwise
00264     // return FALSE.
00265         
00266     if (Inst > (HINSTANCE)HINSTANCE_ERROR)
00267         return ::LoadString(Inst, ID, Description, MaxStringSize);
00268     else
00269         return FALSE;
00270 }
00271     

Generated on Sat Nov 10 03:48:43 2007 for Camelot by  doxygen 1.4.4