Test commit:

delphi headers structure as c headers structure

git-svn-id: http://svn.miranda-ng.org/main/trunk@1829 1316c22d-e87f-b044-9b9b-93d7a3e3ba9c

1 files changed, 266 insertions, 0 deletions

diff --git a/plugins/ExternalAPI/delphi/m_notify.inc b/plugins/ExternalAPI/delphi/m_notify.inc
new file mode 100644
index 0000000000..572adc029e
--- /dev/null
+++ b/plugins/ExternalAPI/delphi/m_notify.inc
@@ -0,0 +1,266 @@
+{$IFNDEF M_NOTIFY}

+{$DEFINE M_NOTIFY}

+

+{** Miranda Notify Dispatcher ************************************************

+Notify Dispatcher provides common interface to different notification plugins

+like osd, popup, ticker etc.

+******************************************************************************}

+

+const

+{ Options UI event and service. The same as for miranda options }

+  ME_NOTIFY_OPT_INITIALISE = 'Notify/Opt/Initialise';

+  MS_NOTIFY_OPT_ADDPAGE    = 'Notify/Opt/AddPage';

+

+type

+  tagMNOTIFYACTIONINFO = record

+    icon   :HICON;

+    name   :array [0..MAXMODULELABELLENGTH-1] of AnsiChar;

+    service:array [0..MAXMODULELABELLENGTH-1] of AnsiChar;

+    cookie :DWORD;

+  end;

+  MNOTIFYACTIONINFO = tagMNOTIFYACTIONINFO;

+

+// Just like miranda pluginLink... This should work faster then services,

+// we need some reactivity in notifications.

+type

+  tagMNNOTIFYLINK = record

+    // Create a new notification type

+    function Register(name:PAnsiChar;icon:HICON):THANDLE;cdecl;

+

+    // Create a new notification object

+    function Create(atype:THANDLE):THANDLE;cdecl;

+

+    // Check is handle is a valid notification object

+    function IsValid(notify:THANDLE):integer;cdecl;

+

+    // Set/get information about object, or type defaults

+    function Set(notifyORtype:THANDLE;name:PAnsiChar;val:TDBVARIANT):integer;cdecl;

+    function Get(notifyORtype:THANDLE;name:PAnsiChar;val:PDBVARIANT):integer;cdecl;

+

+    // Set/get actions

+    function AddAction (notifyORtype:THANDLE;icon:HICON;name:PAnsiChar;service:PAnsiChar;cookie:DWORD):integer;cdecl;

+    function GetActions(notifyORtype:THANDLE;actions:PMNOTIFYACTIONINFO):integer;cdecl;

+

+    // Increment/decrement refer count of notification object. Unreferred objects are destroyed

+    function AddRef (notify:THANDLE):integer;cdecl;

+    function Release(notify:THANDLE):integer;cdecl;

+

+    // Notify user

+    procedure Show  (notify:THANDLE);cdecl;

+    procedure Update(notify:THANDLE);cdecl;

+    procedure Remove(notify:THANDLE);cdecl;

+  end;

+  PMNOTIFYLINK = ^TMNOTIFYLINK;

+  TMNOTIFYLINK = tagMNOTIFYLINK;

+

+const

+// Get the MNOTIFYLINK struct

+// result = (LRESULT)(MNOTIFYLINK* )notifyLink

+  MS_NOTIFY_GETLINK = 'Notify/GetLink';

+

+// Hook this to process corresponding actions

+  ME_NOTIFY_SHOW   = 'Notify/Show';

+  ME_NOTIFY_UPDATE = 'Notify/Update';

+  ME_NOTIFY_REMOVE = 'Notify/Remove';

+

+var

+  notifyLink:PMNOTIFYLINK;

+(*

+function MNotifyRegister(name:PAnsiChar;icon:HICON):THANDLE;

+begin

+  if notifyLink<>nil then

+    result:=notifyLink^.Register(name,icon)

+  else

+    result:=0;

+end;

+function MNotifyCreate(atype:THANDLE):THANDLE;

+begin

+  if notifyLink<>nil then

+    result:=notifyLink^.Create(atype)

+  else

+    result:=0;

+end;

+function MNotifyIsValid(notify:THANDLE):int;

+begin

+  if notifyLink<>nil then

+    result:=notifyLink^.IsValid(notify)

+  else

+    result:=0;

+end;

+function MNotifySet(notifyORtype:THANDLE,name:PAnsiChar;val:TDBVARIANT):int;

+begin

+  if notifyLink<>nil then

+    result:=notifyLink^.Set(notifyORtype,name,val)

+  else

+    result:=0;

+end;

+function MNotifyGet(notifyORtype:THANDLE,name:PAnsiChar;val:PDBVARIANT):int;

+begin

+  if notifyLink<>nil then

+    result:=notifyLink^.Get(notifyORtype,name,val)

+  else

+    result:=0;

+end;

+function MNotifyAddAction(notifyORtype:THANDLE;icon:HICON;name:PAnsiChar;service:PAnsiChar=nil;cookie:DWORD=0):int;

+begin

+  if notifyLink<>nil then

+    result:=notifyLink^.AddAction(notifyORtype,icon,name)

+  else

+    result:=0;

+end;

+function MNotifyGetActions(notifyORtype:THANDLE;actions:PMNOTIFYACTIONINFO):int;

+begin

+  if notifyLink<>nil then

+    result:=notifyLink^.GetActions(notifyORtype,actions)

+  else

+    result:=0;

+end;

+function MNotifyAddRef(notify:THANDLE):int;

+begin

+  if notifyLink<>nil then

+    result:=notifyLink^.AddRef(notify)

+  else

+    result:=0;

+end;

+function MNotifyRelease(notify:THANDLE):int;

+begin

+  if notifyLink<>nil then

+    result:=notifyLink^.Release(notify)

+  else

+    result:=0;

+end;

+procedure MNotifyShow(notify:THANDLE);

+begin

+  if notifyLink<>nil then

+    notifyLink^.Show(notify)

+end;

+procedure MNotifyUpdate(notify:THANDLE);

+begin

+  if notifyLink<>nil then

+    notifyLink^.Update(notify)

+end;

+procedure MNotifyRemove(notify:THANDLE);

+begin

+  if notifyLink<>nil then

+    notifyLink^.Remove(notify)

+end;

+

+procedure MNotifyGetLink;

+begin

+  if PluginLink^.ServiceExists(MS_NOTIFY_GETLINK)<>0 then

+    notifyLink:=PMNOTIFYLINK(CallService(MS_NOTIFY_GETLINK,0,0))

+  else

+    notifyLink:=nil;

+end;

+

+// get helpers

+function MNotifyGetByte(notifyORtype:THANDLE;name:PAnsiChar;defValue:byte):byte;

+var

+  dbv:TDBVARIANT;

+begin

+  MNotifyGet(notifyORtype,name,dbv);

+  if dbv._type<>DBVT_BYTE then

+    result:=defValue

+  else

+    result:=dbv.bVal;

+end;

+function MNotifyGetWord(notifyORtype:THANDLE;name:PAnsiChar;defValue:word):word;

+var

+  dbv:TDBVARIANT;

+begin

+  MNotifyGet(notifyORtype,name,dbv);

+  if dbv._type<>DBVT_WORD then

+    result:=defValue

+  else

+   result:=dbv.wVal;

+end;

+function MNotifyGetDWord(notifyORtype:THANDLE;name:PAnsiChar;defValue:dword):dword;

+var

+  dbv:TDBVARIANT;

+begin

+  MNotifyGet(notifyORtype,name,dbv);

+  if dbv._type<>DBVT_DWORD then

+    result:=defValue

+  else

+    result:=dbv.dVal;

+end;

+function MNotifyGetString(notifyORtype:THANDLE;name:PAnsiChar;defValue:PAnsiChar):PAnsiChar;

+var

+  dbv:TDBVARIANT;

+begin

+  MNotifyGet(notifyORtype,name,dbv);

+  if dbv._type<>DBVT_ASCIIZ then

+    result:=defValue

+  else

+    result:=dbv.szVal.a;

+end;

+function MNotifyGetWString(notifyORtype:THANDLE;name:PAnsiChar;defValue:PWideChar):PWideChar;

+var

+  dbv:TDBVARIANT;

+begin

+  MNotifyGet(notifyORtype,name,dbv);

+  if dbv._type<>DBVT_WCHAR then

+    result:=defValue

+  else

+    result:=dbv.szVal.w;

+end;

+

+// set helpers

+procedure MNotifySetByte(notifyORtype:THANDLE;name:PAnsiChar;value:byte);

+var

+  dbv:TDBVARIANT;

+begin

+  dbv._type:=DBVT_BYTE;

+  dbv.bVal :=value;

+  MNotifySet(notifyORtype,name,dbv);

+end;

+procedure MNotifySetWord(notifyORtype:THANDLE;name:PAnsiChar;value:word);

+var

+  dbv:TDBVARIANT;

+begin

+  dbv._type:=DBVT_WORD;

+  dbv.wVal :=value;

+  MNotifySet(notifyORtype,name,dbv);

+end;

+procedure MNotifySetDWord(notifyORtype:THANDLE;name:PAnsiChar;value:dword);

+var

+  dbv:TDBVARIANT;

+begin

+  dbv._type:=DBVT_DWORD;

+  dbv.dVal :=value;

+  MNotifySet(notifyORtype,name,dbv);

+end;

+procedure MNotifySetString(notifyORtype:THANDLE;name:PAnsiChar;value:PAnsiChar);

+var

+  dbv:TDBVARIANT;

+begin

+  dbv._type  :=DBVT_ASCIIZ;

+  dbv.szVal.a:=value;

+  MNotifySet(notifyORtype,name,dbv);

+end;

+procedure MNotifySetWString(notifyORtype:THANDLE;name:PAnsiChar;value:PWideChar);

+var

+  dbv:TDBVARIANT;

+begin

+  dbv._type  :=DBVT_WCHAR;

+  dbv.szVal.w:=value;

+  MNotifySet(notifyORtype,name,dbv);

+end;

+*)

+

+const

+// Common options for Get/Set actions

+  NFOPT_TYPENAME  = 'General/TypeName';

+  NFOPT_ICON      = 'General/Icon';

+  NFOPT_CONTACT   = 'General/Contact';

+  NFOPT_EVENT     = 'General/Event';

+  NFOPT_TEXT      = 'General/Text';

+  NFOPT_TEXTW     = 'General/TextW';

+  NFOPT_TITLE     = 'General/Title';

+  NFOPT_TITLEW    = 'General/TitleW';

+  NFOPT_BACKCOLOR = 'General/BackColor';

+  NFOPT_TEXTCOLOR = 'General/TextColor';

+  NFOPT_TIMEOUT   = 'General/Timeout';

+//  NFOPT_ONDESTROY = 'General/OnDestroy';

+

+{$ENDIF}