hdicoreIllustrator.h

Go to the documentation of this file.

 
#ifndef __HDI_CORE_ILLUSTRATOR__
#define __HDI_CORE_ILLUSTRATOR__
 
#if defined(HDI_CORE_AIP_MODE)
 
#include <map>
#include <vector>
 
#include "hdicoreColor.h"
#include "hdicoreTypes.h"
 
#define HDI_CORE_ILLUSTRATOR    hdi::core::Illustrator::instance()
 
namespace hdi
{
    namespace core
    {
        namespace ai
        {
            class Preferences;
        }
 
        class CurrentDocument;
        class Document;
        class FileFormat;
        class Font;
        class LiveEffect;
        class MenuGroup;
        class ThirdPartyPlugin;
        class Typeface;
        
        struct SuiteInfo;
 
        class Illustrator
        {
            public:
                typedef std::vector< std::shared_ptr<Font> > FontVector;
                typedef std::map<std::string, SuiteInfo> SuiteInfoMap;
                typedef std::map< std::string, ThirdPartyPlugin* > ThirdPartyPluginMap;
            
                enum ThemeWindowType
                {
                    PanelOrControlBarType       = 10,
                    ModalOrFloatingDialogType   = 20
                };
 
                enum BuiltinToolbox
                {
                    UnknownBuiltinToolbox   = 0,
                    BasicBuiltinToolbox     = 1 << 0,
                    AdvancedBuiltinToolbox  = 1 << 1
                };
                
                enum FolderType
                {
                    UnknownFolderType                                       = 0,
                    ApplicationFolderType                                   = 10,
                    PluginsFolderType                                       = 20,
                    PrimaryScratchFolderType                                = 30,
                    SecondaryScratchFolderType                              = 40,
                    PreferencesFolderType                                   = 50,
                    UserSupportFolderType                                   = 60,
                    UserSupportAIFolderType                                 = 70,
                    UserSupportAIPluginsFolderType                          = 80,
                    ApplicationSupportCommonFolderType                      = 90,
                    ApplicationSupportCommonColorFolderType                 = 100,
                    ApplicationSupportCommonTypeSupportFolderType           = 110,
                    ApplicationSupportCommonFontsFolderType                 = 120,
                    ApplicationSupportCommonFontsRequiredFolderType         = 130,
                    ApplicationSupportCommonFontsRequiredCMapsFolderType    = 140,
                    RequiredFontsFolderType                                 = 150,
                    FontsFolderType                                         = 160,
                    MyDocumentsFolderType                                   = 170,
                    ApplicationSupportCommonWorkflowFolderType              = 180,
                    PrinterDescriptionsFolderType                           = 190,
                    RequiredPluginsFolderType                               = 200,
                    SettingsFolderType                                      = 210,
                    ColorTableSettingsFolderType                            = 220,
                    OptimizeSettingsFolderType                              = 230,
                    HelpFolderType                                          = 240,
                    RootFolderType                                          = 250,
                    PresetsFolderType                                       = 260,
                    PresetActionsFolderType                                 = 270,
                    PresetBrushesFolderType                                 = 280,
                    PresetGradientsFolderType                               = 290,
                    PresetKeyboardShortcutsFolderType                       = 300,
                    PresetPatternsFolderType                                = 310,
                    PresetScriptsFolderType                                 = 320,
                    PresetStylesFolderType                                  = 330,
                    PresetSwatchesFolderType                                = 340,
                    DictionariesFolderType                                  = 350,
                    LegalFolderType                                         = 360,
                    SampleFilesFolderType                                   = 370,
                    UtilitiesFolderType                                     = 380,
                    PackageFolderType                                       = 390,
                    ApplicationSupportCommonFontsRequiredBaseFolderType     = 400,
                    HelpersFolderType                                       = 410,
                    PreviewInFolderType                                     = 420,
                    RidersFileFolderType                                    = 430,
                    HyphenationDictFolderType                               = 440,
                    ApplicationSupportCommonPDFLFolderType                  = 450,
                    ApplicationSupportCommonPDFL5FolderType                 = 460,
                    ApplicationSupportCommonPDFL5CMapsFolderType            = 470,
                    ApplicationSupportCommonPDFL5FontsFolderType            = 480,
                    ApplicationSupportCommonPrintSupportFolderType          = 490,
                    ApplicationSupportCommonColorProfilesFolderType         = 500,
                    ApplicationSupportCommonColorSettingsFolderType         = 510,
                    ContentsFolderType                                      = 520,
                    HelpImagesFolderType                                    = 530,
                    FontsCMapsFolderType                                    = 540,
                    PresetSymbolsFolderType                                 = 550,
                    TsumeFolderType                                         = 560,
                    SpellingDictFolderType                                  = 570,
                    PresetTemplatesFolderType                               = 580,
                    FontsCFFolderType                                       = 590,
                    ApplicationSupportCommonKinsokuSetFolderType            = 600,
                    ApplicationSupportCommonMojikumeSetFolderType           = 610,
                    PresetBlankDocumentsFolderType                          = 620,
                    UserSupportCommonFontsFolderType                        = 630,
                    FontsCFTempFolderType                                   = 640,
                    LogsFolderType                                          = 650,
                    SampleArtFolderType                                     = 660,
                    SampleSVGFolderType                                     = 670,
                    SampleGraphDesignsFolderType                            = 680,
                    SampleDataDrivenGraphicsFolderType                      = 690,
                    WorkspacesFolderType                                    = 700,
                    PresetColorBooksFolderType                              = 710,
                    PresetLegacyColorBooksFolderType                        = 720,
                    PresetSwatchExchangeFolderType                          = 730,
                    ApplicationSupportCommonLinguisticsFolderType           = 740,
                    ApplicationSupportCommonLinguisticsProvidersFolderType  = 750,
                    DemonstratorFolderType                                  = 760,
                    ResourcesFolderType                                     = 770,
                    CoolExtrasFolderType                                    = 780,
                    OutputSettingsFolderType                                = 790,
                    StartupScriptsFolderType                                = 800,
                    DesktopFolderType                                       = 810,
                    IllustratorFormatsFolderType                            = 820,
                    AdditionalAIPluginsFolderType                           = 830,
                    UserWritableStartupFileFolderType                       = 840,
                    UserWritablePresetBrushesFolderType                     = 850,
                    UserWritablePresetStylesFolderType                      = 860,
                    UserWritablePresetSwatchesFolderType                    = 870,
                    UserWritablePresetSwatchExchangeFolderType              = 880,
                    UserWritablePresetSymbolsFolderType                     = 890,
                    PresetFlashPanelsFolderType                             = 900,
                    UserWritablePresetSettingsFolderType                    = 910,
                    UserWritablePresetOptimizeSettingsFolderType            = 920,
                    UserWritablePresetOutputSettingsFolderType              = 930,
                    UserWritablePresetColorTableSettingsFolderType          = 940,
                    RequiredStartupProfilesFolderType                       = 950,
                    PresetWorkspacesFolderType                              = 960,
                    PresetWelcomeScreenFolderType                           = 970,
                    RequiredFolderType                                      = 980,
                    RequiredResourcesFolderType                             = 990,
                    RequiredLocalizedResourcesFolderType                    = 1000,
                    WSMgrCfgFolderType                                      = 1010,
                    ModifiedWorkspacesFolderType                            = 1020,
                    ToolsFolderType                                         = 1030,
                    PreferencesRootFolderType                               = 1040,
                    RequiredLinguisticsFolderType                           = 1050,
                    TemporaryFolder                                         = 1060
                };
                            
                static Illustrator* instance();
 
                ~Illustrator();
 
                PlatformAppPtr platformApp() const;
                
                #if defined(WIN_ENV)
                    PlatformAppWindowPtr platformAppWindow() const;
                #endif
                
                void* alloc(const int32_t size_) const;
                
                void* realloc(void* const block_, const int32_t newSize_) const;
                
                void free(void* const block_) const;
 
                std::string userName() const;
 
                std::string userOrganization() const;
 
                std::string serialNumber() const;
 
                int32_t majorVersion() const;
 
                int32_t minorVersion() const;
 
                int32_t revisionVersion() const;
                
                int16_t bitness() const;
            
                std::string versionString(const bool useRevision_ = false) const;
                
                std::string versionDescription() const;
 
                SuiteInfoMap allSuites() const;
                
                ThirdPartyPluginMap allPlugins() const;
                
                std::unique_ptr<ThirdPartyPlugin> pluginWithName(const std::string& name_) const;
 
                ai::Preferences* const preferences() const;
 
                CurrentDocument* const currentDocument();
 
                uint32_t documentCount() const;
 
                std::unique_ptr<Document> documentAtIndex(const uint32_t index_) const;
 
                std::unique_ptr<Document> openDocument(
                    const std::string& path_,
                    const DocumentColorModel colorModel_,
                    const bool showDialog_,
                    const bool forceCopy_ = false
                ) const;
 
                bool openURL(const std::string& url_) const;
 
                void cacheFonts();
                
                void clearFontCache();
 
                uint32_t fontCount() const;
 
                std::unique_ptr<Font> fontAtIndex(const uint32_t index_) const;
 
                std::unique_ptr<Font> fontWithName(const std::string& faceName_) const;
 
                FontVector allFonts() const;
                
                uint32_t typefaceCount() const;
                
                std::unique_ptr<Typeface> typefaceAtIndex(const uint32_t index_) const;
 
                Locale locale() const;
                
                std::string localeString() const;
 
                uint32_t fileFormatCount() const;
 
                std::unique_ptr<FileFormat> fileFormatAtIndex(const uint32_t index_) const;
                
                bool registerFileFormat(FileFormat& ff_);
 
                uint32_t liveEffectCount() const;
 
                std::unique_ptr<LiveEffect> liveEffectAtIndex(const uint32_t index_) const;
 
                uint32_t menuGroupCount() const;
                
                std::unique_ptr<MenuGroup> menuGroupAtIndex(const uint32_t index_) const;
 
                void suspendExistingContext();
 
                void resumeSuspendedContext();
 
                void pushContext();
 
                void popContext();
 
                bool hasContext() const;
 
                std::string folderPath(const FolderType folder_) const;
 
                bool checkFolderForFile(const FolderType folder_, const std::string& fileName_) const;
 
                bool existsInPluginsFolder(const std::string& fileName_) const;
 
                bool existsInToolsFolder(const std::string& fileName_) const;
                
                bool fileSavePrompt(const std::string& title_, const std::string& fileName_, std::string& path__) const;
                
                bool fileOpenPrompt(const std::string& title_, std::string& path__) const;
                
                bool folderPrompt(const std::string& title_, std::string& path__) const;
 
                BuiltinToolbox visibleBuiltinToolboxes() const;
 
                bool uiThemeDark() const;
 
                Color uiThemeColor(const ThemeWindowType dialog_, const ThemeComponentType component_) const;
            
                bool uiShouldScale() const;
 
                double uiScalingFactor() const;
 
 
            private:
                static Illustrator* __instance;
 
                void* __data;
 
                Illustrator();
                
                Illustrator(const Illustrator&);
                
                Illustrator& operator=(const Illustrator&);
        };
    }
}
 
#endif
// HDI_CORE_AIP_MODE
 
#endif
// __HDI_CORE_ILLUSTRATOR__