Hot Door CORE  0.7.0
Adobe® Illustrator® Plug-in Library
Classes | Enumerations | Functions
hdicoreRuntime.h File Reference

Header file for general runtime-related functions. More...

Classes

class  hdi::core::ClipboardData
 Used to contain data when writing/reading to/from the clipboard. More...
 

Enumerations

enum  LibVersion {
  LibVersion_Unknown = 0, LibVersion_0_5_0 = 500, LibVersion_0_5_1 = 501, LibVersion_0_5_2 = 502,
  LibVersion_0_5_3 = 503, LibVersion_0_5_4 = 504, LibVersion_0_5_5 = 505, LibVersion_0_5_6 = 506,
  LibVersion_0_5_7 = 507, LibVersion_0_5_8 = 508, LibVersion_0_5_9 = 509, LibVersion_0_6_0 = 600,
  LibVersion_0_6_1 = 601, LibVersion_0_6_2 = 602, LibVersion_0_6_3 = 603, LibVersion_0_7_0 = 700
}
 Indicates a specific version of the hdi_core library.
 
enum  SystemVersion {
  UnknownSystemVersion = 0, MacOSX_10_3 = 100300, MacOSX_10_3_OrEarlier = MacOSX_10_3, MacOSX_10_4 = 100400,
  MacOSX_10_5 = 100500, MacOSX_10_6 = 100600, MacOSX_10_7 = 100700, MacOSX_10_8 = 100800,
  MacOSX_10_9 = 100900, MacOSX_10_10 = 101000, MacOSX_10_11 = 101100, MacOSX_10_12 = 101200,
  MacOSX_10_12_OrLater, Windows_XP_OrEarlier = Windows_XP, Windows_XP_SP1 = 50101, Windows_XP_SP2 = 50102,
  Windows_XP_SP3 = 50103, Windows_Vista = 60000, Windows_Vista_SP1 = 60001, Windows_Vista_SP2 = 60002,
  Windows_7 = 60100, Windows_7_SP1 = 60101, Windows_8 = 60200, Windows_8_1 = 60300,
  Windows_10 = 100000, Windows_10_OrLater
}
 Describes the OS version that the plug-in is running within.
 
enum  KeyboardLanguage {
  UnknownKeyLang = 0, AfghanPashtoKeyLang = 10, ArabicKeyLang = 20, ArmenianKeyLang = 30,
  AzeriKeyLang = 40, BanglaKeyLang = 50, BelgianKeyLang = 60, BulgarianKeyLang = 70,
  BelarusianKeyLang = 80, CherokeeKeyLang = 90, ChineseSimplifiedKeyLang = 100, ChineseTraditionalKeyLang = 110,
  CroatianKeyLang = 120, CzechKeyLang = 130, DanishKeyLang = 140, DevanagariKeyLang = 150,
  DutchKeyLang = 160, EnglishAmericanKeyLang = 170, EnglishAustralianKeyLang = 180, EnglishBritishKeyLang = 190,
  EnglishCanadianKeyLang = 200, EnglishOtherKeyLang = 210, EstonianKeyLang = 220, FaroeseKeyLang = 230,
  FinnishKeyLang = 240, FrenchKeyLang = 250, FrenchCanadianKeyLang = 260, FrenchSwissKeyLang = 270,
  GeorgianKeyLang = 280, GermanKeyLang = 290, GermanAustrianKeyLang = 300, GermanSwissKeyLang = 310,
  GreekKeyLang = 320, GujaratiKeyLang = 330, GurmukhiKeyLang = 340, HawaiianKeyLang = 350,
  HebrewKeyLang = 360, HungarianKeyLang = 370, InuktitutKeyLang = 380, IrishKeyLang = 390,
  ItalianKeyLang = 400, JapaneseKeyLang = 410, KannadaKeyLang = 420, KazakhKeyLang = 430,
  KhmerKeyLang = 440, KoreanKeyLang = 450, KurdishSoraniKeyLang = 460, LatvianKeyLang = 470,
  LithuanianKeyLang = 480, MacedonianKeyLang = 490, MalayalamKeyLang = 500, MalteseKeyLang = 510,
  MaoriKeyLang = 520, NepaliKeyLang = 530, NorwegianKeyLang = 540, OriyaKeyLang = 550,
  PersianKeyLang = 560, PersianDariKeyLang = 570, PolishKeyLang = 580, PortugueseKeyLang = 590,
  PortugueseBrazilianKeyLang = 600, RomanianKeyLang = 610, RussianKeyLang = 620, SamiKeyLang = 630,
  SerbianKeyLang = 640, SinhalaKeyLang = 650, SlovakKeyLang = 660, SlovenianKeyLang = 670,
  SpanishKeyLang = 680, SwedishKeyLang = 690, TamilKeyLang = 700, TeluguKeyLang = 710,
  ThaiKeyLang = 720, TibetanKeyLang = 730, TurkishKeyLang = 740, UkrainianKeyLang = 750,
  UrduKeyLang = 760, UyghurKeyLang = 770, VietnameseKeyLang = 780, WelshKeyLang = 790
}
 Describes the language for which the current (keyboard) input source is designed.
 
enum  KeyboardLayout {
  KeyLayout_Unknown = 0, KeyLayout_Korean_2Set = 100, KeyLayout_Korean_3Set = 200, KeyLayout_Korean_390Sebulshik = 300,
  KeyLayout_Korean_GongjinCheongRomaja = 400, KeyLayout_Japanese_Ainu = 500, KeyLayout_Japanese_Hiragana = 600, KeyLayout_Japanese_Katakana = 700,
  KeyLayout_Japanese_KatakanaHalfWidth = 800, KeyLayout_Japanese_Romaji = 900, KeyLayout_Japanese_RomajiFullWidth = 1000, KeyLayout_Chinese_Simplified_Pinyin = 1100,
  KeyLayout_Chinese_Simplified_WubiHua = 1200, KeyLayout_Chinese_Simplified_WubiXing = 1300, KeyLayout_Tamil_Anjal = 1400, KeyLayout_Tamil_Tamil99 = 1500,
  KeyLayout_Chinese_Traditional_Cangjie = 1600, KeyLayout_Chinese_Traditional_Sucheng = 1700, KeyLayout_Chinese_Traditional_Pinyin = 1800, KeyLayout_Chinese_Traditional_Zhuyin = 1900,
  KeyLayout_Chinese_Traditional_ZhuyinEten = 2000, KeyLayout_Vietnamese_Telex = 2100, KeyLayout_Vietnamese_TelexSimple = 2200, KeyLayout_Vietnamese_VIQR = 2300,
  KeyLayout_Vietnamese_VNI = 2400, KeyLayout_Afghan_Dari = 2500, KeyLayout_Afghan_Pashto = 2600, KeyLayout_Afghan_Uzbek = 2700,
  KeyLayout_Arabic = 2800, KeyLayout_Arabic_QWERTY = 2900, KeyLayout_Arabic_PC = 3000, KeyLayout_Armenian_HM_QWERTY = 3100,
  KeyLayout_Armenian_WesternQWERTY = 3200, KeyLayout_Australian = 3300, KeyLayout_Austrian = 3400, KeyLayout_Azeri = 3500,
  KeyLayout_Bangla = 3600, KeyLayout_Bangla_QWERTY = 3700, KeyLayout_Belgian = 3800, KeyLayout_Brazilian = 3900,
  KeyLayout_British = 4000, KeyLayout_British_PC = 4100, KeyLayout_Bulgarian = 4200, KeyLayout_Bulgarian_Phonetic = 4300,
  KeyLayout_Belarusian = 4400, KeyLayout_CanadianEnglish = 4500, KeyLayout_CanadianFrench_CSA = 4600, KeyLayout_Cherokee_Nation = 4700,
  KeyLayout_Cherokee_QWERTY = 4800, KeyLayout_Colemak = 4900, KeyLayout_Croatian = 5000, KeyLayout_Croatian_PC = 5100,
  KeyLayout_Czech = 5200, KeyLayout_Czech_QWERTY = 5300, KeyLayout_Danish = 5400, KeyLayout_Devanagari = 5500,
  KeyLayout_Devanagari_QWERTY = 5600, KeyLayout_Dutch = 5700, KeyLayout_Dvorak = 5800, KeyLayout_Dvorak_Left = 5900,
  KeyLayout_Dvorak_QWERTY = 6000, KeyLayout_Dvorak_Right = 6100, KeyLayout_Estonian = 6200, KeyLayout_Faroese = 6300,
  KeyLayout_Finnish = 6400, KeyLayout_Finnish_Extended = 6500, KeyLayout_Finnish_SamiPC = 6600, KeyLayout_French = 6700,
  KeyLayout_French_Numerical = 6800, KeyLayout_Georgian_QWERTY = 6900, KeyLayout_German = 7000, KeyLayout_Greek = 7100,
  KeyLayout_Greek_Polytonic = 7200, KeyLayout_Gujarati = 7300, KeyLayout_Gujarati_QWERTY = 7400, KeyLayout_Gurmukhi = 7500,
  KeyLayout_Gurmukhi_QWERTY = 7600, KeyLayout_Hawaiian = 7700, KeyLayout_Hebrew = 7800, KeyLayout_Hebrew_PC = 7900,
  KeyLayout_Hebrew_QWERTY = 8000, KeyLayout_Hungarian = 8100, KeyLayout_Inuktitut_Nunavik = 8200, KeyLayout_Inuktitut_Nunavut = 8300,
  KeyLayout_Inuktitut_Nutaaq = 8400, KeyLayout_Inuktitut_QWERTY = 8500, KeyLayout_Irish = 8600, KeyLayout_Irish_Extended = 8700,
  KeyLayout_Italian_Typewriter = 8800, KeyLayout_Italian = 8900, KeyLayout_Jawi_QWERTY = 9000, KeyLayout_Kannada = 9100,
  KeyLayout_Kannada_QWERTY = 9200, KeyLayout_Kazakh = 9300, KeyLayout_Khmer = 9400, KeyLayout_Kurdish_Sorani = 9500,
  KeyLayout_Latvian = 9600, KeyLayout_Lithuanian = 9700, KeyLayout_Macedonian = 9800, KeyLayout_Malayalam = 9900,
  KeyLayout_Malayalam_QWERTY = 10000, KeyLayout_Maltese = 10100, KeyLayout_Maori = 10200, KeyLayout_Myanmar_QWERTY = 10300,
  KeyLayout_Nepali = 10400, KeyLayout_NorthernSami = 10500, KeyLayout_Norwegian = 10600, KeyLayout_Norwegian_Extended = 10700,
  KeyLayout_Norwegian_SamiPC = 10800, KeyLayout_Oriya = 10900, KeyLayout_Oriya_QWERTY = 11000, KeyLayout_Persian = 11100,
  KeyLayout_Persian_ISIRI = 11200, KeyLayout_Persian_QWERTY = 11300, KeyLayout_Polish = 11400, KeyLayout_Polish_Pro = 11500,
  KeyLayout_Portuguese = 11600, KeyLayout_Romanian = 11700, KeyLayout_Romanian_Standard = 11800, KeyLayout_Russian = 11900,
  KeyLayout_Russian_Phonetic = 12000, KeyLayout_Russian_PC = 12100, KeyLayout_Sami_PC = 12200, KeyLayout_Serbian = 12300,
  KeyLayout_Serbian_Latin = 12400, KeyLayout_Sinhala = 12500, KeyLayout_Sinhala_QWERTY = 12600, KeyLayout_Slovak = 12700,
  KeyLayout_Slovak_QWERTY = 12800, KeyLayout_Slovenian = 12900, KeyLayout_Spanish = 13000, KeyLayout_Spanish_ISO = 13100,
  KeyLayout_Swedish = 13200, KeyLayout_Swedish_Pro = 13300, KeyLayout_Swedish_SamiPC = 13400, KeyLayout_SwissFrench = 13500,
  KeyLayout_SwissGerman = 13600, KeyLayout_Telugu = 13700, KeyLayout_Telugu_QWERTY = 13800, KeyLayout_Thai = 13900,
  KeyLayout_Thai_PattaChote = 14000, KeyLayout_Tibetan_Otani = 14100, KeyLayout_Tibetan_QWERTY = 14200, KeyLayout_Tibetan_Wylie = 14300,
  KeyLayout_Turkish = 14400, KeyLayout_Turkish_QWERTY = 14500, KeyLayout_Turkish_QWERTY_PC = 14600, KeyLayout_Ukrainian = 14700,
  KeyLayout_Urdu = 14800, KeyLayout_US = 14900, KeyLayout_US_Extended = 15000, KeyLayout_US_InternationalPC = 15100,
  KeyLayout_Uyghur = 15200, KeyLayout_Vietnamese = 15300, KeyLayout_Welsh, KeyLayout_Albanian = 250,
  KeyLayout_Alsatian = 350, KeyLayout_Amharic = 450, KeyLayout_Arabic_Algeria = 550, KeyLayout_Arabic_Bahrain = 650,
  KeyLayout_Arabic_Egypt = 750, KeyLayout_Arabic_Iraq = 850, KeyLayout_Arabic_Jordan = 950, KeyLayout_Arabic_Kuwait = 1050,
  KeyLayout_Arabic_Lebanon = 1150, KeyLayout_Arabic_Libya = 1250, KeyLayout_Arabic_Morocco = 1350, KeyLayout_Arabic_Oman = 1450,
  KeyLayout_Arabic_Qatar = 1550, KeyLayout_Arabic_SaudiArabia = 1650, KeyLayout_Arabic_Syria = 1750, KeyLayout_Arabic_Tunisia = 1850,
  KeyLayout_Arabic_Uae = 1950, KeyLayout_Arabic_Yemen = 2050, KeyLayout_Armenian = 2150, KeyLayout_Assamese = 2250,
  KeyLayout_Azeri_Cyrillic = 2350, KeyLayout_Azeri_Latin = 2450, KeyLayout_Bangla = 3600, KeyLayout_Bangla_India = 2650,
  KeyLayout_Bashkir = 2750, KeyLayout_Basque = 2850, KeyLayout_Belarusian = 4400, KeyLayout_Bosnian = 3050,
  KeyLayout_Bosnian_Cyrillic = 3150, KeyLayout_Bosnian_Latin = 3250, KeyLayout_Breton = 3350, KeyLayout_Bulgarian = 4200,
  KeyLayout_Catalan = 3550, KeyLayout_Chinese_Hongkong = 3850, KeyLayout_Chinese_Macau = 3950, KeyLayout_Chinese_Singapore = 4050,
  KeyLayout_Chinese_Simplified = 4150, KeyLayout_Chinese_Traditional = 4250, KeyLayout_Corsican = 4350, KeyLayout_Croatian = 5000,
  KeyLayout_Croatian_BosniaHerzegovina = 4650, KeyLayout_Czech = 5200, KeyLayout_Danish = 5400, KeyLayout_Dari = 4950,
  KeyLayout_Divehi = 5050, KeyLayout_Dutch = 5700, KeyLayout_Dutch_Belgian = 5250, KeyLayout_English_Australia = 5350,
  KeyLayout_English_Belize = 5450, KeyLayout_English_Canada = 5550, KeyLayout_English_Caribbean = 5650, KeyLayout_English_India = 5750,
  KeyLayout_English_Ireland = 5950, KeyLayout_English_Jamaica = 6050, KeyLayout_English_Malaysia = 6150, KeyLayout_English_NewZealand = 6250,
  KeyLayout_English_Philippines = 6350, KeyLayout_English_Singapore = 6450, KeyLayout_English_SouthAfrica = 6550, KeyLayout_English_Trinidad = 6650,
  KeyLayout_English_UK = 6750, KeyLayout_English_US = 6850, KeyLayout_English_Zimbabwe = 6950, KeyLayout_Estonian = 6200,
  KeyLayout_Faeroese = 7150, KeyLayout_Filipino = 7250, KeyLayout_Finnish = 6400, KeyLayout_French = 6700,
  KeyLayout_French_Belgian = 7550, KeyLayout_French_Canadian = 7650, KeyLayout_French_Luxembourg = 7750, KeyLayout_French_Monaco = 7850,
  KeyLayout_French_Swiss = 7950, KeyLayout_Frisian = 8050, KeyLayout_Galician = 8150, KeyLayout_Georgian = 8250,
  KeyLayout_German = 7000, KeyLayout_German_Austrian = 8450, KeyLayout_German_Liechtenstein = 8550, KeyLayout_German_Luxembourg = 8650,
  KeyLayout_German_Swiss = 8750, KeyLayout_Greek = 7100, KeyLayout_Greenlandic = 8950, KeyLayout_Gujarati = 7300,
  KeyLayout_Hausa = 9150, KeyLayout_Hebrew = 7800, KeyLayout_Hindi = 9450, KeyLayout_Hungarian = 8100,
  KeyLayout_Icelandic = 9650, KeyLayout_Igbo = 9750, KeyLayout_Indonesian = 9850, KeyLayout_Inuktitut_Canada = 9950,
  KeyLayout_Inuktitut_CanadaLatin = 10050, KeyLayout_Irish = 8600, KeyLayout_Italian = 8900, KeyLayout_Italian_Swiss = 10350,
  KeyLayout_Japanese = 10450, KeyLayout_Kannada = 9100, KeyLayout_Kazakh = 9300, KeyLayout_Khmer = 9400,
  KeyLayout_Kiche = 10850, KeyLayout_Kinyarwanda = 10950, KeyLayout_Konkani = 11050, KeyLayout_Korean = 11150,
  KeyLayout_Kyrgyz = 11250, KeyLayout_Lao = 11350, KeyLayout_Latvian = 9600, KeyLayout_Lithuanian = 9700,
  KeyLayout_Sorbian = 11650, KeyLayout_Luxembourgish = 11750, KeyLayout_Macedonian = 9800, KeyLayout_Malay = 11950,
  KeyLayout_Malay_BruneiDarussalam = 12050, KeyLayout_Malayalam = 9900, KeyLayout_Maltese = 10100, KeyLayout_Maori = 10200,
  KeyLayout_Mapudungun = 12450, KeyLayout_Marathi = 12550, KeyLayout_Mohawk = 12650, KeyLayout_Mongolian_Cyrillic = 12750,
  KeyLayout_Mongolian_PRC = 12850, KeyLayout_Nepali = 10400, KeyLayout_Nepali_India = 13050, KeyLayout_Norwegian_Bokmal = 13150,
  KeyLayout_Norwegian_Nynorsk = 13250, KeyLayout_Occitan = 13350, KeyLayout_Oriya = 10900, KeyLayout_Pashto = 13550,
  KeyLayout_Persian = 11100, KeyLayout_Polish = 11400, KeyLayout_Portuguese = 11600, KeyLayout_Portuguese_Brazilian = 13950,
  KeyLayout_Punjabi = 14150, KeyLayout_Quechua_Bolivia = 14350, KeyLayout_Quechua_Ecuador = 14450, KeyLayout_Quechua_Peru = 14550,
  KeyLayout_Romanian = 11700, KeyLayout_Romansh = 14750, KeyLayout_Russian = 11900, KeyLayout_Sami_Inari_Finland = 15050,
  KeyLayout_Sami_Lule_Norway = 15150, KeyLayout_Sami_Lule_Sweden = 15250, KeyLayout_Sami_Northern_Finland = 15350, KeyLayout_Sami_Northern_Norway = 15450,
  KeyLayout_Sami_Northern_Sweden = 15550, KeyLayout_Sami_Skolt_Finland = 15650, KeyLayout_Sami_Southern_Norway = 15750, KeyLayout_Sami_Southern_Sweden = 15850,
  KeyLayout_Sanskrit = 15950, KeyLayout_Serbian = 12300, KeyLayout_Serbian_Cyrillic = 16150, KeyLayout_Serbian_Latin = 12400,
  KeyLayout_Serbian_BosniaHerzegovina_Cyrillic = 16350, KeyLayout_Serbian_BosniaHerzegovina_Latin = 16450, KeyLayout_Sindhi = 16650, KeyLayout_Sinhalese = 16750,
  KeyLayout_Slovak = 12700, KeyLayout_Slovenian = 12900, KeyLayout_Sotho = 17050, KeyLayout_Spanish = 13000,
  KeyLayout_Spanish_Argentina = 17250, KeyLayout_Spanish_Bolivia = 17350, KeyLayout_Spanish_Chile = 17450, KeyLayout_Spanish_Colombia = 17550,
  KeyLayout_Spanish_CostaRica = 17650, KeyLayout_Spanish_DominicanRepublic = 17750, KeyLayout_Spanish_Ecuador = 17850, KeyLayout_Spanish_ElSalvador = 17950,
  KeyLayout_Spanish_Guatemala = 18050, KeyLayout_Spanish_Honduras = 18150, KeyLayout_Spanish_Mexican = 18250, KeyLayout_Spanish_Nicaragua = 18350,
  KeyLayout_Spanish_Panama = 18450, KeyLayout_Spanish_Paraguay = 18550, KeyLayout_Spanish_Peru = 18650, KeyLayout_Spanish_PuertoRico = 18750,
  KeyLayout_Spanish_Modern = 18850, KeyLayout_Spanish_US = 18950, KeyLayout_Spanish_Uruguay = 19050, KeyLayout_Spanish_Venezuela = 19150,
  KeyLayout_Swahili = 19250, KeyLayout_Swedish = 13200, KeyLayout_Swedish_Finland = 19450, KeyLayout_Syriac = 19650,
  KeyLayout_Tajik = 19750, KeyLayout_Tamazight = 19850, KeyLayout_Tamil_India = 19950, KeyLayout_Tatar = 20150,
  KeyLayout_Telugu = 13700, KeyLayout_Thai = 13900, KeyLayout_Tibetan = 20450, KeyLayout_Tigrinya_Eritrea = 20550,
  KeyLayout_Tswana_SouthAfrica = 20850, KeyLayout_Turkish = 14400, KeyLayout_Turkmen = 21050, KeyLayout_Uighur = 21150,
  KeyLayout_Ukrainian = 14700, KeyLayout_Urdu_India = 21450, KeyLayout_Urdu_Pakistan = 21550, KeyLayout_Uzbek_Cyrillic = 21650,
  KeyLayout_Uzbek_Latin = 21750, KeyLayout_Vietnamese = 15300, KeyLayout_Welsh, KeyLayout_Wolof = 22150,
  KeyLayout_Xhosa = 22250, KeyLayout_Yakut = 22350, KeyLayout_Yi = 22450, KeyLayout_Yoruba = 22550,
  KeyLayout_Zulu
}
 Describes the layout of the current (keyboard) input source. More...
 

Functions

LibVersion hdi::core::version ()
 Gets the version of the hdi_core library against which the plugin was built. More...
 
std::string hdi::core::versionString ()
 Gets the version of the hdi_core library as a string. More...
 
SystemVersion hdi::core::systemVersion ()
 Gets the version of the OS in which the plug-in is being run. More...
 
std::string hdi::core::machineUUID ()
 Gets the UUID for the machine on which the plug-in is being run. More...
 
Size hdi::core::screenDimensions ()
 Gets the dimensions of the user's primary screen. More...
 
bool hdi::core::browserAvailable ()
 Gets whether the OS has a browser available. More...
 
bool hdi::core::clipboardData (ClipboardData &data__)
 Gets the data currently on the clipboard. More...
 
bool hdi::core::setClipboardData (const ClipboardData &data_)
 Sets the data currently on the clipboard. More...
 
MouseButton hdi::core::mouseButtonsPressed ()
 Gets which mouse buttons are currently pressed (can be called anytime) More...
 
ModifierKey hdi::core::modifierKeysPressed ()
 Gets which modifier keys are currently pressed (can be called anytime) More...
 
KeyboardLanguage hdi::core::keyboardLanguage ()
 Gets the best-fit keyboard language for the current input source (keyboard layout) More...
 
KeyboardLayout hdi::core::keyboardLayout ()
 Gets the current keyboard layout. More...
 

Detailed Description

Header file for general runtime-related functions.