include/MiKTeX208-packagemanager.idl

/* mpm.idl:                                                     -*- IDL -*-

   Copyright (C) 2006-2008 Christian Schenk

   This file is part of MiKTeX Package Manager.

   MiKTeX Package Manager is free software; you can redistribute it
   and/or modify it under the terms of the GNU General Public License
   as published by the Free Software Foundation; either version 2, or
   (at your option) any later version.
   
   MiKTeX Package Manager is distributed in the hope that it will be
   useful, but WITHOUT ANY WARRANTY; without even the implied warranty
   of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.
   
   You should have received a copy of the GNU General Public License
   along with MiKTeX Package Manager; if not, write to the Free
   Software Foundation, 59 Temple Place - Suite 330, Boston, MA
   02111-1307, USA. */

import "oaidl.idl";
import "ocidl.idl";

import "miktexidl.idl";

/* _________________________________________________________________________
   
   MD5
   _________________________________________________________________________ */

typedef [uuid(F92D6E8F-22CC-4585-8309-58440C5A0DFB)] struct MD5
{
  BYTE bits[16];
} MD5;


/* _________________________________________________________________________
   
   PackageInfo
   _________________________________________________________________________ */

typedef [uuid(22A5E6E6-04B3-4540-A122-6A612210F52E)] struct PackageInfo
{
  BSTR deploymentName;
  BSTR displayName;
  BSTR title;
  BSTR version;
  BSTR description;
  BSTR creator;
  DOUBLE sizeRunFiles;
  DOUBLE sizeDocFiles;
  DOUBLE sizeSourceFiles;
  LONG numRunFiles;
  LONG numDocFiles;
  LONG numSourceFiles;
  DATE timePackaged;
  DATE timeInstalled;
  LONG archiveFileSize;
  MD5 digest;
  VARIANT_BOOL isInstalled;
} PackageInfo;

/* _________________________________________________________________________
   
   IPackageInstallerCallback
   _________________________________________________________________________ */

[
  object,
  uuid(4B081787-2C08-4AFD-80E1-B4B3E23324B4),
  nonextensible,
  helpstring("IPackageInstallerCallback Interface"),
  pointer_default(unique)
]
interface IPackageInstallerCallback : IUnknown
{
  [
    helpstring("method ReportLine")
  ]
  HRESULT ReportLine ([in] BSTR line);

  [
    helpstring("method OnRetryableError")
  ]
  HRESULT
  OnRetryableError ([in] BSTR                   message,
                    [out,retval] VARIANT_BOOL * doContinue);

  [
    helpstring("method OnProgress")
  ]
  HRESULT
  OnProgress ([in] LONG nf, [out,retval] VARIANT_BOOL * doContinue);
};

/* _________________________________________________________________________
   
   IPackageInstaller
   _________________________________________________________________________ */

[
  object,
  uuid(74C7EE83-4851-4766-B471-9CF29E7C2DA3),
  dual,
  nonextensible,
  helpstring("IPackageInstaller Interface"),
  pointer_default(unique)
]
interface IPackageInstaller : IDispatch
{
  [
    id(1),
    helpstring("method Add")
  ]
  HRESULT
  Add ([in] BSTR packageName, [in] VARIANT_BOOL toBeInstalled);

  [
    id(2),
    helpstring("method SetCallback")
  ]
  HRESULT
  SetCallback ([in] IUnknown * callback);

  [
    id(3),
    helpstring("method InstallRemove")
  ]
  HRESULT
  InstallRemove ();

  [
    id(4),
    helpstring("method GetLastError")
  ]
  HRESULT
  GetErrorInfo ([out,retval] ErrorInfo * errorInfo);

  [
    id(5),
    helpstring("method UpdateDb")
  ]
  HRESULT
  UpdateDb ();

  [
    id(6),
    helpstring("method SetRepository")
  ]
  HRESULT
  SetRepository ([in] BSTR repository);
};

/* _________________________________________________________________________
   
   IPackageManager
   _________________________________________________________________________ */

[
  object,
  uuid(C6A0E0A9-532D-46DF-8969-0E0A17539FC9),
  dual,
  nonextensible,
  helpstring("IPackageManager Interface"),
  pointer_default(unique)
]
interface IPackageManager : IDispatch
{
  [
    id(1),
    helpstring("method CreateInstaller")
  ]
  HRESULT
  CreateInstaller ([out,retval] IPackageInstaller ** installer);

  [
    id(2),
    helpstring("method GetPackageInfo")
  ]
  HRESULT
  GetPackageInfo ([in] BSTR                     packageName,
                  [out,retval] PackageInfo *    packageInfo);
};

/* _________________________________________________________________________
   
   IPackageIterator
   _________________________________________________________________________ */

[
  object,
  uuid(D02EF17D-1CEF-450B-9C58-ABBB3AE286CC),
  helpstring("IPackageIterator Interface"),
  pointer_default(unique)
]
interface IPackageIterator : IUnknown
{
  [
    helpstring("method GetNextPackageInfo")
  ]
  HRESULT
  GetNextPackageInfo ([out] PackageInfo * packageInfo,
                      [out,retval] VARIANT_BOOL * done);
};

/* _________________________________________________________________________
   
   IPackageManager2
   _________________________________________________________________________ */

[
  object,
  uuid(847D93E9-E086-4F09-B8C5-91CDCCF12CF3),
  dual,
  nonextensible,
  helpstring("IPackageManager2 Interface"),
  pointer_default(unique)
]
interface IPackageManager2 : IPackageManager
{
  [
    id(3),
    helpstring("method CreatePackageIterator")
  ]
  HRESULT
  CreatePackageIterator ([out,retval] IPackageIterator ** iter);
};

/* _________________________________________________________________________
   
   MiKTeXPackageManager2_8
   _________________________________________________________________________ */

[
  uuid(FF61470A-DC24-4526-9E7C-8B69AE558C7E),
  version(1.0),
  helpstring("MiKTeX 2.8 Package Manager")
]
library MiKTeXPackageManager2_8
{
  importlib("stdole2.tlb");

  [
    uuid(80405147-9003-4E8C-88DE-4DCE92E1134A),
    helpstring("MiKTeX 2.8 Package Manager")
  ]
  coclass PackageManager2_8
  {
    interface IPackageManager;
    [default] interface IPackageManager2;
  };

  struct MD5;
  struct PackageInfo;
  interface IPackageInstaller;
  interface IPackageInstallerCallback;
  interface IPackageIterator;
};

---