InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
ILibraryAssetMetaData.h
1 //========================================================================================
2 //
3 // $File$
4 //
5 // Owner: Mark VerMurlen
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/25/98
24 //
25 // Purpose:
26 // This interface is a secondary interface to the LibraryAsset Boss. This interface
27 // controls reading and writing of the "Meta" data of the asset.
28 //
29 //========================================================================================
30 
31 #ifndef __ILibraryAssetMetaData__
32 #define __ILibraryAssetMetaData__
33 
34 #include "IPMUnknown.h"
35 #include "LibraryProviderID.h"
36 #include "GlobalTime.h"
37 #include "PMPoint.h"
38 
39 static const GlobalTime kNULLTIME = GlobalTime(uint64(0));
40 
46 {
47 public:
48 
49  // The popup menus that let the user change the "type" of an asset
50  // rely on this ordering. If you add enums or change the ordering,
51  // you must change the popup menu resource to match (or else use a
52  // more complicated association between menu items and enum vals) (tjg)
57  typedef enum {
82  } UserType;
83 
87  virtual void SetName(const PMString &name) = 0;
88 
92  virtual PMString GetName() const = 0;
93 
97  virtual void SetUserType(const UserType userType) = 0;
98 
103  virtual UserType GetUserType() const = 0;
104 
108  virtual void SetDescription(const PMString &description) = 0;
109 
113  virtual PMString GetDescription() const = 0;
114 
118  virtual GlobalTime GetCreationTime() const = 0;
119 
120  // Sets the creation time (and date) of the asset.Added for Converter support
121  // Clients are requested to make doubly sure if they want to use this method
122  // as creation date is set only once
128  virtual void SetCreationTime(GlobalTime t) = 0;
129 
133  virtual PMPoint GetPosition() const = 0;
134 
138  virtual void SetPosition(PMPoint& pt) = 0;
139 
144  virtual void SetGenericProperty(PMString& propName,UIDRef& propValue) = 0;
145 
150  virtual UIDRef GetGenericProperty(PMString& propName) = 0;
151 
152 
153  //-------------- For Internal Use Only -------------------------
154 
157  virtual void InitializeCreationTime() = 0;
158 
159 };
160 
161 
162 #endif