home *** CD-ROM | disk | FTP | other *** search
/ PC go! 2008 April / PCgo 2008-04 (DVD).iso / interface / contents / demoversionen_3846 / 13664 / files / Data1.cab / gxties.idl < prev    next >
Encoding:
Text File  |  2001-09-01  |  15.1 KB  |  670 lines
  1. // GXTIES70.idl : IDL source for GXTIES80.dll
  2. //
  3.  
  4. // This file will be processed by the MIDL tool to
  5. // produce the type library (GXTIES80.tlb) and marshalling code.
  6.  
  7. import "oaidl.idl";
  8. import "ocidl.idl";
  9. import "imsigx.idl";
  10.  
  11. typedef enum
  12. {
  13.      imsiTieTreatment    =    1 << 1
  14.     ,imsiTieDirty        =    1 << 2
  15.     ,imsiTieWasted        =    1 << 3
  16. //    ,imsiTiePriority    =    1 << 4
  17.     ,imsiTieAll            =    imsiTieTreatment | imsiTieDirty | imsiTieWasted
  18. } imsiTieFlag;
  19.  
  20.  
  21.     /**
  22.      * An object that describe custom Tie betwween Graphics objects.
  23.      */
  24.     [
  25.          object
  26.         ,uuid(6A481147-E531-11CF-A115-00A024158DAF)
  27.         ,dual
  28.         ,helpcontext(0x11000000)
  29.         ,helpstring("An object that maintains Smart Tie betwween Graphics objects.")
  30.     ]
  31.     interface Tie : IDispatch
  32.     {
  33.         /*//////////////////////////// Properties \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\*/
  34.  
  35.         /**
  36.          * Returns an Application object that represents the owner of the specified object.
  37.          */
  38.         [
  39.              propget
  40.             ,helpcontext(0x11000001)
  41.             ,helpstring("Returns an Application object that represents the creator of the specified object.")
  42.         ]
  43.         HRESULT  Application(
  44.             [out, retval] IApplication** prop // The Application object.
  45.             );
  46.  
  47.         /**
  48.          * Returns an Drawing object that represents the owner of the specified object.
  49.          */
  50.         [
  51.             propget
  52.             ,helpcontext(0x11000002)
  53.             ,helpstring("Returns an Application object that represents the creator of the specified object.")
  54.         ]
  55.         HRESULT  Drawing(
  56.             [out, retval] IDrawing** prop // The Drawing object.
  57.             );
  58.  
  59.         /**
  60.          * Returns an TieSet object that represents the owner of the specified object.
  61.          */
  62.         [
  63.             propget
  64.             ,helpcontext(0x11000003)
  65.             ,helpstring("Returns the Parent object that owns the object.")
  66.         ]
  67.         HRESULT  Parent(
  68.             [out, retval] IDispatch** prop // The TieSet object.
  69.             );
  70.  
  71.         [
  72.             propget
  73.             ,helpcontext(0x11000004)
  74.             ,helpstring("Returns ID of the TieMethod for ITie object.")
  75.         ]
  76.         HRESULT Name(
  77.             [out, retval] BSTR* prop
  78.             );
  79.  
  80.         [
  81.             propget
  82.             ,helpcontext(0x11000005)
  83.             ,helpstring("Returns priority of a ITie object.")
  84.         ]
  85.         HRESULT Priority(
  86.             [out, retval] double* pdblVal
  87.             );
  88.  
  89.         [
  90.             propput
  91.             ,helpcontext(0x11000005)
  92.             ,helpstring("Set priority of a ITie object.")
  93.         ]
  94.         HRESULT Priority(
  95.             [in] double dblVal
  96.             );
  97.  
  98.         [
  99.             propget
  100.             ,helpcontext(0x11000006)
  101.             ,helpstring("Gets the TieMethod specific data of a ITie object.")
  102.         ]
  103.         HRESULT Data(
  104.             [out, retval] VARIANT* pvarData
  105.             );
  106.  
  107.         [
  108.             propput
  109.             ,helpcontext(0x11000006)
  110.             ,helpstring("Sets the TieMethod specific data of a ITie object.")
  111.         ]
  112.         HRESULT Data(
  113.             [in] VARIANT* varData
  114.             );
  115.  
  116.     };
  117.  
  118.     [
  119.         object
  120.         ,uuid(6A481148-E531-11CF-A115-00A024158DAF)
  121.         ,dual
  122.         ,helpcontext(0x11010000)
  123.         ,helpstring("An object that maintains TieSets collection.")
  124.     ]
  125.     interface TieSet : IDispatch
  126.     {
  127.         /**
  128.          * Returns an Application object that represents the owner of the specified object.
  129.          */
  130.         [
  131.             propget
  132.             ,helpcontext(0x11010001),
  133.             ,helpstring("Returns an Application object that represents the creator of the specified object.")
  134.         ]
  135.         HRESULT  Application(
  136.             [out, retval] IApplication** prop // The Application object.
  137.             );
  138.  
  139.         /**
  140.          * Returns an Drawing object that represents the owner of the specified object.
  141.          */
  142.         [
  143.             propget
  144.             ,helpcontext(0x11010002)
  145.             ,helpstring("Returns the Drawing object that owns the object.")
  146.         ]
  147.         HRESULT  Drawing(
  148.             [out, retval] IDrawing** prop // The Drawing object.
  149.             );
  150.  
  151.         /**
  152.          * Returns an TieSets object that represents the owner of the specified object.
  153.          */
  154.         [
  155.             propget
  156.             ,helpcontext(0x11010003)
  157.             ,helpstring("Returns the Parent object that owns the object.")
  158.         ]
  159.         HRESULT  Parent(
  160.             [out, retval] IDispatch** prop // The Drawing object.
  161.             );
  162.  
  163.         [
  164.             propget
  165.             ,helpcontext(0x11010004),
  166.             ,helpstring("Returns the Subject Graphic object of the set.")
  167.         ]
  168.         HRESULT  Subject(
  169.             [out, retval] IDispatch** ppIDispGr
  170.             );
  171.  
  172.         [
  173.             propget
  174.             ,helpcontext(0x11010005),
  175.             ,helpstring("Returns the Subject Graphic object of the set.")
  176.         ]
  177.         HRESULT  Subordinate(
  178.             [out, retval] IDispatch** pIDispGr
  179.             );
  180.  
  181.         [
  182.             propget
  183.             ,helpcontext(0x11010006)
  184.             ,helpstring("Returns the Flags of the set.")
  185.         ]
  186.         HRESULT  Flag(
  187.             [in] imsiTieFlag    FlagMask,
  188.             [out, retval] BOOL *pbFlag
  189.             );
  190.  
  191.         [
  192.             propput
  193.             ,helpcontext(0x11010006)
  194.             ,helpstring("Sets the Flags of the set.")
  195.         ]
  196.         HRESULT  Flag(
  197.             [in] imsiTieFlag    FlagMask,
  198.             [in] BOOL bFlag
  199.             );
  200.         [
  201.             propget
  202.             ,helpcontext(0x11010007)
  203.             ,helpstring("Returns the Flags of the set.")
  204.         ]
  205.  
  206.         HRESULT  Flags(
  207.             [out, retval] imsiTieFlag    *pFlags
  208.             );
  209.         [
  210.             propput
  211.             ,helpcontext(0x11010007)
  212.             ,helpstring("Sets the Flags of the set.")
  213.         ]
  214.         HRESULT  Flags(
  215.             [in] imsiTieFlag    Flags
  216.             );
  217.  
  218.         [
  219.             propget
  220.             ,helpcontext(0x11010008)
  221.             ,helpstring("Returns the count of ties in the set.")
  222.         ]
  223.  
  224.         HRESULT  Count(
  225.             [out, retval] long    *plCount
  226.             );
  227.         
  228.         /**
  229.          * Returns part of a set.
  230.          */
  231.         [
  232.             propget
  233.             ,id(DISPID_VALUE)
  234.             ,helpcontext(0x11010009)
  235.             ,helpstring("Returns part of a set.")
  236.         ]
  237.         HRESULT  Item(
  238.             [in] long Index, // Zero-based Index of item to return.
  239.             [out, retval] Tie** prop // The item.
  240.             );
  241.  
  242.         /**
  243.         * Add Tie to TieSet
  244.         */
  245.         [
  246.             helpcontext(0x1101000A)
  247.             ,helpstring("Add Tie to the TieSet")
  248.         ]
  249.         HRESULT  AddTie(
  250.             [in] VARIANT* pvarTM,
  251.             [in] double dblPriority,
  252.             [in] VARIANT* pvarData,
  253.             [out, retval] Tie** pTie
  254.             );
  255.  
  256.         /**
  257.         * Delete TieSet
  258.         */
  259.         [
  260.               helpcontext(0x1101000B)
  261.             ,helpstring("Delete TieSet")
  262.         ]
  263.         HRESULT  Delete(
  264.         );
  265.     };
  266.  
  267.     [
  268.         object
  269.         ,uuid(6A481149-E531-11CF-A115-00A024158DAF)
  270.         ,dual
  271.         ,helpcontext(0x11020000)
  272.         ,helpstring("An object that maintains TieSets collection.")
  273.     ]
  274.     interface TieSets : IDispatch
  275.     {
  276.         /*//////////////////////////// Properties \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\*/
  277.  
  278.         /**
  279.          * Returns an Application object that represents the owner of the specified object.
  280.          */
  281.         [
  282.              propget
  283.             ,helpcontext(0x11020001)
  284.             ,helpstring("Returns an Application object that represents the creator of the specified object.")
  285.         ]
  286.         HRESULT  Application(
  287.             [out, retval] IApplication** prop // The Application object.
  288.             );
  289.  
  290.         /**
  291.          * Returns the number of items in the collection.
  292.          */
  293.         [
  294.             propget
  295.             ,helpcontext(0x11020002)
  296.             ,helpstring("Returns the number of items in the collection.")
  297.         ]
  298.         HRESULT  Count(
  299.             [out, retval] long* prop // The number of items.
  300.             );
  301.  
  302.         /**
  303.          * Returns part of a collection.
  304.          */
  305.         [
  306.             propget
  307.             ,helpcontext(0x11020003)
  308.             ,helpstring("Returns part of a collection.")
  309.         ]
  310.         HRESULT  TieSet(
  311.             [in] VARIANT* varSbj, // ID / Dispatch of Subject Graphic.
  312.             [in] VARIANT* varSbd, // ID / Dispatch of Subordinate Graphic
  313.             [out, retval] TieSet** prop // The TieSet item.
  314.             );
  315.  
  316.         /**
  317.          * Returns part of a collection.
  318.          */
  319.         [
  320.             propget
  321.             ,id(DISPID_VALUE)
  322.             ,helpcontext(0x11020004)
  323.             ,helpstring("Returns part of a collection.")
  324.         ]
  325.         HRESULT  Item(
  326.             [in] VARIANT* varInd, // zero-index of the item to return
  327.             [out, retval] TieSet** prop // The TieSet item.
  328.             );
  329.  
  330.         /**
  331.          * Returns the parent object for the specified object.
  332.          */
  333.         [
  334.             propget
  335.             ,helpcontext(0x11020005),
  336.             ,helpstring("Returns the parent object for the specified object.")
  337.         ]
  338.         HRESULT  Parent(
  339.             [out, retval] IDispatch** prop // The parent object.
  340.             );
  341.  
  342.         /**
  343.          * Returns the parent object for the specified object.
  344.          */
  345.         [
  346.             propget
  347.             ,helpcontext(0x11020006),
  348.             ,helpstring("Returns the parent object for the specified object.")
  349.         ]
  350.         HRESULT  Drawing(
  351.             [out, retval] IDrawing** prop // The parent object.
  352.             );
  353.  
  354.         /**
  355.          * Creates an enumeration object.
  356.          */
  357.         [
  358.             propget
  359.             ,restricted
  360.             ,id(DISPID_NEWENUM)
  361.             ,helpcontext(0x11020007)
  362.             ,helpstring("Private.  Creates an enumeration object.")
  363.         ]
  364.         HRESULT  _NewEnum(
  365.             [out, retval] IUnknown** prop // The enumeration object.
  366.             );
  367.  
  368.         /*////////////////////////////// Methods \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\*/
  369.  
  370.         /**
  371.          * Adds one TieSet objects to the collection.
  372.          */
  373.         [
  374.             helpcontext(0x11020008)
  375.             ,helpstring("Adds one or more RegenMethod objects to the collection.")
  376.         ]
  377.         HRESULT  Add(
  378.             [in]    VARIANT*    pvarTieName,    // Id of connection name (tie method name)
  379.  
  380.             [in]    IGraphic*    pIGr1,
  381.             [in]    IGraphic*    pIGr2,
  382.             [in]    long        lFlg,
  383.             [in]    BOOL        bWasted,
  384.             [out, retval] TieSet** TieAdded // Tie object added.
  385.             );
  386.  
  387.     };
  388.  
  389.     /**
  390.      * An object that maintains custom TieMethod for Graphics objects.
  391.      */
  392.     [
  393.         object
  394.         ,uuid(6A48114A-E531-11CF-A115-00A024158DAF)
  395.         ,dual
  396.         ,helpcontext(0x11030000)
  397.         ,helpstring("An object that maintains custom Tie betwween Graphics objects.")
  398.     ]
  399.     interface TieMethod : IDispatch
  400.     {
  401.         /*//////////////////////////// Properties \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\*/
  402.  
  403.         /**
  404.          * Returns an Application object that represents the owner of the specified object.
  405.          */
  406.         [
  407.              propget
  408.             ,helpcontext(0x11030001)
  409.             ,helpstring("Returns an Application object that represents the creator of the specified object.")
  410.         ]
  411.         HRESULT  Application(
  412.             [out, retval] IApplication** prop // The Application object.
  413.             );
  414.  
  415.         /**
  416.          * Returns a description of the specified object, as a string.
  417.          */
  418.         [
  419.              propget
  420.             ,helpcontext(0x11030002)
  421.             ,helpstring("Returns a description of the specified object, as a string.")
  422.         ]
  423.         HRESULT  Description(
  424.             [out, retval] BSTR* prop // A string describing the object.
  425.             );
  426.  
  427.         /**
  428.          * Returns the index of the item in the collection.
  429.          */
  430.         [
  431.              propget
  432.             ,helpcontext(0x11030003)
  433.             ,helpstring("Returns the index of the item in the collection.")
  434.         ]
  435.         HRESULT  Index(
  436.             [out, retval] long* prop // The index.
  437.             );
  438.  
  439.         /**
  440.          * Returns the name of the object, as a string.
  441.          */
  442.         [
  443.              propget
  444.             ,helpcontext(0x11030004)
  445.             ,helpstring("Returns the name of the object, as a string.")
  446.         ]
  447.         HRESULT  Name(
  448.             [out, retval] BSTR* prop // The name of the object.
  449.             );
  450.  
  451.         /**
  452.          * Returns the parent object for the specified object.
  453.          */
  454.         [
  455.              propget
  456.             ,helpcontext(0x11030005)
  457.             ,helpstring("Returns the parent object for the specified object.")
  458.         ]
  459.         HRESULT  Parent(
  460.             [out, retval] IDispatch** prop // The parent object.
  461.             );
  462.  
  463.         /**
  464.          * Returns a Properties collection of the properties supported by the RegenMethod object.
  465.          */
  466.         [
  467.              propget
  468.             ,helpcontext(0x11030006)
  469.             ,helpstring("Returns a array of Kinds of the ties supported by the TieMethod object.")
  470.             ,hidden, restricted
  471.         ]
  472.         HRESULT  Kinds(
  473.             [in, out] VARIANT* kinds // The kinds arry.
  474.             );
  475.  
  476.         /**
  477.          * Returns the type of the RegenMethod object.
  478.          */
  479.         [
  480.             propget
  481.             ,helpcontext(0x11030007)
  482.             ,helpstring("Returns the type of the TieMethod object.")
  483.         ]
  484.         HRESULT  Type(
  485.             [out, retval] ImsiExtSrvType* prop // The type of the TieMethod object.
  486.             );
  487.  
  488.         /**
  489.          * Returns the internal table entry ID.
  490.          * Private.
  491.          */
  492.         [
  493.              propget
  494.             ,restricted
  495.             ,helpcontext(0x11030008)
  496.             ,helpstring("Private.  Returns the internal table entry ID.")
  497.         ]
  498.         HRESULT  _TableEntryID(
  499.             [out, retval] long* prop // The table entry ID.
  500.             );
  501.  
  502.         /*////////////////////////////// Methods \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\*/
  503.  
  504.         /**
  505.          * Deletes the object.
  506.          */
  507.         [
  508.              helpcontext(0x11030009)
  509.             ,helpstring("Deletes the object.")
  510.             ,hidden, restricted
  511.         ]
  512.         HRESULT  Delete(
  513.             );
  514.  
  515.     };
  516.  
  517.     /**
  518.      * A collection of TegenMethod objects.
  519.      */
  520.     [
  521.         object
  522.         ,uuid(6A48114B-E531-11CF-A115-00A024158DAF)
  523.         ,dual
  524.         ,helpcontext(0x11040000)
  525.         ,helpstring("A collection of TieMethod objects.")
  526.     ]
  527.     interface TieMethods : IDispatch
  528.     {
  529.  
  530.         /*//////////////////////////// Properties \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\*/
  531.  
  532.         /**
  533.          * Returns an Application object that represents the owner of the specified object.
  534.          */
  535.         [
  536.         propget
  537.         ,helpcontext(0x11040001)
  538.         ,helpstring("Returns an Application object that represents the creator of the specified object.")
  539.         ]
  540.         HRESULT  Application(
  541.             [out, retval] IApplication** prop // The Application object.
  542.             );
  543.  
  544.         /**
  545.          * Returns the number of items in the collection.
  546.          */
  547.         [
  548.             propget
  549.             ,helpcontext(0x11040002)
  550.             ,helpstring("Returns the number of items in the collection.")
  551.         ]
  552.         HRESULT  Count(
  553.             [out, retval] long* prop // The number of items.
  554.             );
  555.  
  556.         /**
  557.          * Returns part of a collection.
  558.          */
  559.         [
  560.             propget
  561.             ,id(DISPID_VALUE)
  562.             ,helpcontext(0x11040003)
  563.             ,helpstring("Returns part of a collection.")
  564.         ]
  565.         HRESULT  Item(
  566.             [in] VARIANT* Index, // Index of item to return.
  567.             [out, retval] TieMethod** prop // The item.
  568.             );
  569.  
  570.         /**
  571.          * Returns the parent object for the specified object.
  572.          */
  573.         [
  574.             propget
  575.             ,helpcontext(0x11040004)
  576.             ,helpstring("Returns the parent object for the specified object.")
  577.         ]
  578.         HRESULT  Parent(
  579.             [out, retval] IDispatch** prop // The parent object.
  580.             );
  581.  
  582.         /**
  583.          * Creates an enumeration object.
  584.          */
  585.         [
  586.             propget
  587.             ,restricted
  588.             ,id(DISPID_NEWENUM)
  589.             ,helpcontext(0x11040005)
  590.             ,helpstring("Private.  Creates an enumeration object.")
  591.         ]
  592.         HRESULT  _NewEnum(
  593.             [out, retval] IUnknown** prop // The enumeration object.
  594.             );
  595.  
  596.         /*////////////////////////////// Methods \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\*/
  597.  
  598.         /**
  599.          * Adds one or more RegenMethod objects to the collection.
  600.          */
  601.         [
  602.              helpcontext(0x11040006)
  603.             ,helpstring("Adds one or more RegenMethod objects to the collection.")
  604.             ,hidden, restricted
  605.         ]
  606.         HRESULT  Add(
  607.             [in] BSTR FileName, // The file containing the TieMethod objects.
  608.             [in, out, optional] VARIANT* TieMethodsAdded // An array of TieMethod objects added.
  609.             );
  610.  
  611.         /**
  612.          * Returns the index within the table collection of the specified table entry.
  613.          * Private.
  614.          */
  615.         [
  616.              restricted
  617.             ,helpcontext(0x11040007)
  618.             ,helpstring("Private.  Returns the index within the table collection of the specified table entry.")
  619.         ]
  620.         HRESULT  _FindIndex(
  621.             [in] long TableEntryID, // The internal table ID.
  622.             [out, retval] long* prop // The zero based index.
  623.             );
  624.  
  625.         /**
  626.          * Returns an object from the table collection for the specified table entry.
  627.          * Private.
  628.          */
  629.         [
  630.              restricted
  631.             ,helpcontext(0x11040008)
  632.             ,helpstring("Private.  Returns an object from the table collection for the specified table entry.")
  633.         ]
  634.         HRESULT  _ObjectFromID(
  635.             [in] long TableEntryID, // The internal table ID.
  636.             [out, retval] TieMethod** prop // The object.
  637.             );
  638.     };
  639. [
  640.      uuid(6A481404-E531-11CF-A115-00A024158DAF)
  641.     ,version(8.0)
  642.     ,helpfile("tcsdk.chm")
  643.     ,helpstring("GXTIES 8.0 Type Library")
  644. ]
  645. library GXTIESLib
  646. {
  647.     importlib("stdole32.tlb");
  648.     importlib("stdole2.tlb");
  649.     importlib("..\include\imsigx.tlb");
  650.  
  651.     [uuid(6A48180A-E531-11CF-A115-00A024158DAF),
  652.     hidden,
  653.     helpcontext(0x11050000),
  654.     helpstring("The TurboCAD TieMethods collection.")]
  655.     coclass XTieMethods
  656.     {
  657.         [default] interface TieMethods;
  658.     }
  659.  
  660.     [uuid(6A48180B-E531-11CF-A115-00A024158DAF),
  661.     hidden,
  662.     helpcontext(0x11060000),
  663.     helpstring("The TurboCAD TieSets collection.")]
  664.     coclass XTieSets
  665.     {
  666.         [default] interface TieSets;
  667.     }
  668.  
  669. };
  670.