sgscanf.h

Go to the documentation of this file.
00001 // $Id: sgscanf.h 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 // Super Gallery Library File class
00099 
00100 #ifndef INC_SGSCANF
00101 #define INC_SGSCANF
00102 
00103 //#include "thumb.h" - in camtypes.h [AUTOMATICALLY REMOVED]
00104 
00105 class PathName;
00106 class SuperGallery;
00107 class LibraryGallery;
00108 class Library;
00109 
00110 
00111 /***********************************************************************************************
00112 
00113 >   class LibraryFile : public ListItem
00114 
00115     Author:     Richard_Millican (Xara Group Ltd) <camelotdev@xara.com>
00116     Created:    18/2/95
00117     Purpose:    This is the main super gallery library creation class...
00118                 Creating one of these will give your gallery a set of new sub-lib groups
00119                 containing DisplayItems for the entries in the sub-group.
00120     SeeAlso:    Library; LibraryFileGroup;
00121 
00122 ***********************************************************************************************/
00123 
00124 class LibraryFile : public ListItem
00125 {
00126     CC_DECLARE_DYNCREATE(LibraryFile)
00127 
00128 public:     // Construction/destruction
00129     LibraryFile();
00130     ~LibraryFile();
00131 
00132 
00133 public:     // public interface
00134 
00135     // Ask a newly created LibraryFile to scan and create Gallery groups
00136     // Returns number of groups created, or 0 in case of error
00137     // If the main or default subindex files don't exits we give the option
00138     // of generating a default sublib index to the user.
00139     INT32 Init(SuperGallery *ParentGal, PathName *Path, SGLibType Type, BOOL Updated = FALSE, BOOL DoScroll = TRUE);
00140 
00141     // Add a specific index to a newly created LibraryFile (This can be called instead
00142     // of the above Init call, which is really designed to hunt out it's own index files) 
00143     BOOL AddSpecificIndex(SuperGallery *ParentGal, PathName *Path, SGLibType Type, StringBase *Description = NULL, UINT32 bModified = 0, 
00144         BOOL bIsWebLib = FALSE);
00145 
00146     // Find the list of Libraries found by Init
00147     inline List *GetLibraryList(void);
00148 
00149     // Kill leading spaces from a string
00150     static BOOL KillLeadingSpaces(StringBase *Str);
00151 
00152     // Returns the pathname of this library, as passed in to the Init method
00153     PathName *GetLibraryPathName(void);
00154 
00155     // Returns the type of this library, as passed into the Init method
00156     SGLibType GetLibraryType(void);
00157 
00158     // Generate a default index for a given directory
00159     static BOOL GenerateDefaultIndex(PathName *IndexFile, PathName *LibDirPath,
00160                                 String_64 *Author, SGLibType Type, BOOL Thumbnails);
00161 
00162     // Check directory for subindex files. If we find any, add them to the gal.
00163     // If we don't, give the option to generate a subindex if the type can cope with it.
00164     BOOL CheckForSubIndexes(SuperGallery *ParentGal, PathName *Path, SGLibType Type, BOOL Updated = FALSE);
00165 
00166     // Get pathname of default sublib index and find out whether we can generate indexes, etc
00167     static BOOL GetSubIndexDetails(LibraryGallery *LG, String_256 *DefaultIndex, String_256 *IndexDesc, BOOL *CanGenerate);
00168 
00169     // Remove XaraInfo's and trailing backslashes from a string
00170     static BOOL TidyUpSubPath(String_256 *Str);
00171 
00172     // Count number of valid lines in a file
00173     static INT32 CountLines(PathName *IndexFilePath);
00174 
00175     // Actually do the scroll / redraw...
00176     void DoScrollRedraw(void);
00177 
00178 protected:
00179 
00180     // Init the scroll/redraw system
00181     void InitScrollRedrawSystem(void);
00182 
00183     // Add a new folder to the scroll/redraw system
00184     void AddNewFolderToScrollRedrawSystem(Library *NewFolder);
00185     
00186 protected:
00187     PathName MyPath;                        // The pathname of this library file
00188     SGLibType MyType;                       // The type of library we represent
00189 
00190 public:
00191     List Libraries;                         // A list of all contained Libraries
00192     SuperGallery *ParentGallery;            // A pointer to the gallery who owns us
00193     LibraryGallery *ParentLibraryGallery;   // A pointer to the library gallery who owns us (if either
00194                                             // of these are NULL, we're in deep water...)
00195     static Library *FirstLibraryAdded;      // Two statics for redraw/scroll purposes...
00196     static Library *LastLibraryAdded;
00197 };
00198 
00199 
00200 
00201 /***********************************************************************************************
00202 
00203 >   inline List *LibraryFile::GetLibraryList(void)
00204 
00205     Author:     Jason_Williams (Xara Group Ltd) <camelotdev@xara.com>
00206     Created:    22/2/95
00207     Purpose:    Returns a pointer to the LibraryFile's list of available libraries.
00208                 You should treat this list as READ ONLY.
00209 
00210 ***********************************************************************************************/
00211 
00212 List *LibraryFile::GetLibraryList(void)
00213 {
00214     return(&Libraries);
00215 }
00216 
00217 
00218 #endif

Generated on Sat Nov 10 03:46:58 2007 for Camelot by  doxygen 1.4.4