AcTcCatalogItem.h

Go to the documentation of this file.

#pragma once
 
//
// (C) Copyright 2005-2024 by Graebert GmbH.
//
// Permission to use, copy, modify, and distribute this software in
// object code form for any purpose and without fee is hereby granted,
// provided that the above copyright notice appears in all copies and
// that both that copyright notice and the limited warranty and
// restricted rights notice below appear in all supporting
// documentation.
//
// GRAEBERT PROVIDES THIS PROGRAM "AS IS" AND WITH ALL FAULTS.
// GRAEBERT SPECIFICALLY DISCLAIMS ANY IMPLIED WARRANTY OF
// MERCHANTABILITY OR FITNESS FOR A PARTICULAR USE.  GRAEBERT GMBH
// DOES NOT WARRANT THAT THE OPERATION OF THE PROGRAM WILL BE
// UNINTERRUPTED OR ERROR FREE.
 
#include "Global Enums.h"
 
using namespace AcTc;
class AcTcImage;
class AcTcImageList;
class AcTcScheme;
class AcTcCatalogItemReactor;
class AcTcSystemInternals;
 
class ARX_API AcTcCatalogItem
{
public:
        AcTcCatalogItem() {}
        __int64 AddTargetProduct(struct ACTC_TARGET_PRODUCT_INFO const *);
        __int64 GetImageFilePath(__int64,wchar_t *,unsigned __int64)const;
        __int64 GetOverlayImageFilePath(wchar_t *,unsigned __int64,int)const;
        __int64 GetTargetProductCount(void)const;
        AcTcCatalogItem * FindInChildren(wchar_t const *);
        AcTcCatalogItem * FindInChildren(wchar_t const *,int);
        AcTcCatalogItem * GetParent(void)const;
        AcTcCatalogItem * GetRoot(void)const;
        AcTcImage * GetImage(struct tagSIZE const *,int);
        AcTcImage * GetOverlayImage(int)const;
        AcTcImageList * GetImageList(void)const;
        AcTcScheme * GetScheme(void)const;
        enum AcTc::AccessRight GetAccessRight(void)const;
        enum AcTc::ItemOption GetOption(void)const;
        int AddReactor( AcTcCatalogItemReactor *);
        int CanRefresh(void)const;
        int DeleteImageFile(int);
        int DeleteLinkFile(int);
        int DeleteOverlayImageFile(int);
        int DeleteTargetProduct(int);
        int GetAutoRefresh(void)const;
        int GetCustomData(struct IUnknown * *);
        int GetDescription(wchar_t *,int)const;
        int GetFileRevision(long &,long &)const;
        int GetHelpInfo(wchar_t *,wchar_t *,wchar_t *)const;
        int GetID(struct _GUID *)const;
        int GetKeywords(wchar_t *,int)const;
        int GetLinkFilePath(wchar_t *,int)const;
        int GetLinkUrl(wchar_t *,int)const;
        int GetOverlayImageInfo(struct ACTC_IMAGE_INFO *,int)const;
        int GetParentDocumentDescription(wchar_t *,int)const;
        int GetParentDocumentName(wchar_t *,int)const;
        int GetParentDocumentUrl(wchar_t *,int)const;
        int GetPublisherCountry(wchar_t *,int)const;
        int GetPublisherDescription(wchar_t *,int)const;
        int GetPublisherEmail(wchar_t *,int)const;
        int GetPublisherName(wchar_t *,int)const;
        int GetPublisherUrl(wchar_t *,int)const;
        int GetReferencePath(wchar_t *,int,int)const;
        int GetRefresh(void)const;
        int GetRevision(long &,long &,long &)const;
        int GetSourceID(struct _GUID *)const;
        int GetSourceUrl(wchar_t *,int)const;
        int GetTargetProduct(__int64,struct ACTC_TARGET_PRODUCT_INFO *)const;
        int GetTime(__int64 *,__int64 *,__int64 *)const;
        int GetToolTipText(wchar_t *,int)const;
        int GetUrl(wchar_t *,int)const;
        int IsLink(void)const;
        int IsLinkLoaded(void)const;
        int IsReadOnly(void)const;
        int IsRoot(void)const;
        int IsUserModified(void)const;
        int IsValidForProduct(wchar_t const *,int,int,unsigned long);
        int Load(wchar_t const *,unsigned long);
        int LoadLink(void);
        int RemoveReactor( AcTcCatalogItemReactor *);
        int Save(wchar_t const *,unsigned long);
        int SetAccessRight(enum AcTc::AccessRight);
        int SetAutoRefresh(int);
        int SetDescription(wchar_t const *);
        int SetHelpInfo(wchar_t const *,wchar_t const *,wchar_t const *);
        int SetID(struct _GUID const *);
        int SetItemOrder( AcTcCatalogItem * *,__int64);
        int SetKeywords(wchar_t const *);
        int SetLinkUrl(wchar_t const *);
        int SetName(wchar_t const *);
        int SetNewID(int);
        int SetOption(enum AcTc::ItemOption);
        int SetOverlayImage( AcTcImage const *,int);
        int SetOverlayImageInfo(struct ACTC_IMAGE_INFO const *);
        int SetParent( AcTcCatalogItem *);
        int SetParentDocumentDescription(wchar_t const *);
        int SetParentDocumentName(wchar_t const *);
        int SetParentDocumentUrl(wchar_t const *);
        int SetPublisherCountry(wchar_t const *);
        int SetPublisherDescription(wchar_t const *);
        int SetPublisherEmail(wchar_t const *);
        int SetPublisherName(wchar_t const *);
        int SetPublisherUrl(wchar_t const *);
        int SetReferencePath(wchar_t const *,int);
        int SetRefresh(int);
        int SetSourceID(struct _GUID const *);
        int SetSourceUrl(wchar_t const *);
        int SetTime(__int64 const *,__int64 const *,__int64 const *);
        int SetToolTipText(wchar_t const *);
        int Sort(int,int);
        static  AcTcCatalogItem * FromFile(wchar_t const *,int,unsigned long);
        static enum AcTc::CatalogItemType GetType(wchar_t const *);
        virtual  AcTcCatalogItem & operator=( AcTcCatalogItem const &);
        virtual int Clone(int, AcTcCatalogItem * &,int)const;
        virtual int CopyFrom( AcTcCatalogItem const *,int);
        virtual int Download(wchar_t const *,unsigned long,wchar_t const *);
        virtual int GetTagName(wchar_t *,int)const;
        virtual int GetTypeString(wchar_t *,int,int,int)const;
        virtual int IsValidChild(enum AcTc::CatalogItemType)const;
        virtual int Load(struct IStream *,unsigned long);
        virtual int Load(struct IUnknown *,unsigned long);
        virtual int Refresh(unsigned long);
        virtual int Reset(void);
        virtual int Save(struct IStream *,unsigned long);
        virtual int Save(struct IUnknown *,unsigned long);
    virtual ~AcTcCatalogItem( void );
    int GetName( wchar_t *, int ) const;
    int GetLocalFile( wchar_t *, int )const;
    INT_PTR GetChildCount( void ) const;
    INT_PTR GetChildCount( AcTc::CatalogItemType ) const;
    AcTcCatalogItem* GetChild( INT_PTR ) const;
    INT_PTR AddChild(AcTcCatalogItem*);
    INT_PTR InsertChild(INT_PTR, AcTcCatalogItem*);
    int DeleteChild(AcTcCatalogItem*);
    int DetachChild(AcTcCatalogItem*);
    AcTcCatalogItem * GetNextChild(int, CatalogItemType) const;
    int DeleteAllChildren(void);
    int HasChildren(void) const;
    AcTcCatalogItem* FindInChildren(GUID const &, int = TRUE);
 
    virtual AcTc::CatalogItemType GetType( void ) const;
    static AcTc::CatalogItemType GetType( wchar_t* );
    int GetXml( wchar_t *, int, DWORD = kSaveLinksAsLinks );
protected:
        AcTcCatalogItem( AcTcSystemInternals *);
        virtual  AcTcCatalogItem * CreateObject(void)const;
};
 
class ARX_API AcTcCatalog : public AcTcCatalogItem
{
public:
        AcTcCatalog& operator=(AcTcCatalog const&);
        AcTcCatalog(void);
        AcTcCatalog(const AcTcCatalog&);
        virtual ~AcTcCatalog(void);
};
        
class ARX_API AcTcPackage : public AcTcCatalogItem
{
public:
        AcTcPackage & operator=( AcTcPackage const &);
    AcTcPackage();
    AcTcPackage(AcTcPackage const & );
    virtual ~AcTcPackage();
};
 
class ARX_API AcTcPalette : public AcTcPackage
{
public:
        AcTcPalette & operator=( AcTcPalette const &);
    AcTcPalette();
    AcTcPalette(AcTcPalette const &);
    virtual ~AcTcPalette();
};
 
class AcTcStockTool;
 
class ARX_API AcTcTool : public AcTcCatalogItem
{
public:
        AcTcStockTool * GetStockTool(void)const;
        AcTcTool & operator=( AcTcTool const &);
        int GetStockToolFileUrl(wchar_t *,int)const;
        int GetStockToolID(struct _GUID *)const;
        int SetStockToolFileUrl(wchar_t const *);
        int SetStockToolID(struct _GUID const *);
    AcTcTool();
    AcTcTool(const AcTcTool&);
    virtual ~AcTcTool();
 
    virtual int Execute(int, HWND, POINT, DWORD);
    int GetToolData(IUnknown**);
    int CreateAcadTool(IUnknown**,int=1);
    AcTcCatalogItem* GetShapePackage(void) const;
    int SetShapePackage(AcTcCatalogItem*);
    int IsFlyoutEnabled(void) const;
    int EnableFlyout(int);
    AcTcTool* GetCurrentShape(void) const;
    int SetCurrentShape(AcTcTool*);
    int SetCurrentShape(const GUID&);
    int  GetActiveShapes(AcTcCatalogItem**, INT_PTR &);
    int SetActiveShapes(AcTcCatalogItem**,int);
 
    ToolType GetToolType(void) const;
    int SetToolType(ToolType);
};