InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
LibraryAssetID.h
1 //========================================================================================
2 //
3 // $File$
4 //
5 // Owner: Tim Gogolin
6 //
7 // $Author$
8 //
9 // $DateTime$
10 //
11 // $Revision$
12 //
13 // $Change$
14 //
15 // Copyright 1997-2010 Adobe Systems Incorporated. All rights reserved.
16 //
17 // NOTICE: Adobe permits you to use, modify, and distribute this file in accordance
18 // with the terms of the Adobe license agreement accompanying it. If you have received
19 // this file from a source other than Adobe, then your use, modification, or
20 // distribution of it requires the prior written permission of Adobe.
21 //
22 //
23 // Reviewed: 9/28/98
24 //
25 // Purpose:
26 // This class is used to represent an "ID" of a Library Asset.
27 //
28 // NOTE: The LibraryAssetID is NOT similar to UID's or other shuksan ID's and
29 // is used only with the Library.
30 //
31 //========================================================================================
32 
33 #ifndef __LibraryAssetID__
34 #define __LibraryAssetID__
35 
36 
37 #include "K2Vector.h"
38 #include "K2Vector.tpp"
39 
40 
42 {
43 public:
44  typedef base_type data_type;
45  // Creates a an invalid Asset ID.
46  LibraryAssetID();
47 
48  // Create an Asset ID given a numerical equivalent value
49  static LibraryAssetID CreateLibraryAssetID(int32 i);
50 
51  // Return a numerical equivalent value for an Asset ID
52  int32 GetAssetIDNumericValue() const;
53 
54  bool16 IsValid() const;
55  bool16 operator==(const LibraryAssetID& id) const;
56 
57 private:
58  LibraryAssetID(int32 i);
59  int32 fID;
60 };
61 
62 
64 
65 
66 
67 #endif