Description
Defines global functions specific to AcTc classes.
Functions
| Function | Description |
|---|---|
 AcTcDownloadItem | This function downloads a catalog item file (specified by the URL) to a local directory, creates the appropriate catalog item object, and then loads the downloaded file into the item. For example, if the URL points to a palette file, an AcTcPalette object is created and populated with the file contents.pszUrl can point to any catalog file. Memory for the string returned in pNewItem is allocated on the heap with new. It is the caller's responsibility to delete this pointer. If pszDownloadPath is null, the URL is downloaded to the temp directory. Returns a non-zero value if the... more |
| AcTcDownloadItem | This function is used to download multiple URLs in a single call. It creates a catalog item object for each downloaded URL and stores the objects in the pItems array.pUrls is an input array of size nNumUrls. pItems is an output array of size nNumUrls. The pointers in pItems are allocated on the heap using new. It is the caller's responsibility to delete these pointers after using them. The elements of the pItems array correspond to the elements of pUrls. If a URL cannot be downloaded, the corresponding index in the pItems array is NULL... more |
| AcTcGetManager | Returns the singleton AcTcManager object, or null if the AcTc library is not initialized. |
| AcTcInitialize | Initializes the AcTc library. This function should be called before using any of the functions of the AcTc library.Returns nonzero if the library was initialized successfully. Returns zero if the library initialization failed. |
| AcTcRefreshItem | This function refreshes each item in the pItems array to match the item's source. For an item to be refreshed, it must have source information, and refresh must not be currently disabled. If either of these conditions is not met, refresh fails.To refresh items, this function connects to each item's source and downloads it. The source refers to a catalog item file in either the intranet or Internet. The source file can contain the item to be refreshed directly in the root or in another item. For example, if the item to be refreshed is a tool, the source... more |
| AcTcSetHostInfo | Sets the host revision information. |
| AcTcSort | Sorts an array of catalog items and stores the sorted items in the same array.If the function succeeds, the return value is nonzero. If the function fails, the return value is zero. |
| AcTcUiCopyItems | Copies the items in the array to the data source object in the format CF_ACTC_CATALOG_ITEM. It copies the item, all its children recursively, the images used by the items, and the stock tools referred by the tools if the items are tools. Use AcTcUiPasteItems() to load the items from a data object.Returns true if the items were copied successfully; otherwise, returns false. |
| AcTcUiFilterShapesDialog | Displays a dialog to filter shapes. The caller uses the pActiveShapes input/output array parameter to pass in the shapes that are currently visible. After the dialog is dismissed, pActiveShapes outputs an array containing only the filtered active shapes.Returns true if the shapes were filtered successfully using the dialog. Returns false if the dialog was canceled or if the function failed. |
| AcTcUiGetDragInfo | Extracts the drag header information from the data object if the data object contains catalog items in a known format. See AcTcUiPasteItems for the list of formats.Returns true if the drag information is extracted from the data object successfully. Returns false if the data object does not contain the catalog items or if the function fails. |
| AcTcUiGetManager | Returns the singleton AcTcUiManager object. |
| AcTcUiGetToolPaletteWindow | Returns a pointer to the tool palette window, or null if the function fails. |
| AcTcUiPasteItems | Copies the catalog items from the data object if the data object contains items in a known format. The items in the data object can be in custom, i-drop, or file drop format. If the data object includes i-drop format, then the items are automatically downloaded from the Internet. This function can be used to paste items from the Clipboard or from a drag-and-drop object.The supported Clipboard formats are: |
| AcTcUninitialize | Uninitializes the AcTc library. This function should be called at the end of using the AcTc library.Returns nonzero if the library was uninitialized successfully. Returns zero if the library initialization failed. |