diff options
Diffstat (limited to 'plugins/ExternalAPI/delphi/m_metacontacts.inc')
| -rw-r--r-- | plugins/ExternalAPI/delphi/m_metacontacts.inc | 168 | 
1 files changed, 168 insertions, 0 deletions
diff --git a/plugins/ExternalAPI/delphi/m_metacontacts.inc b/plugins/ExternalAPI/delphi/m_metacontacts.inc new file mode 100644 index 0000000000..5ff5cf9855 --- /dev/null +++ b/plugins/ExternalAPI/delphi/m_metacontacts.inc @@ -0,0 +1,168 @@ +{
 +  Miranda IM: the free IM client for Microsoft  Windows 
 +  
 +  Copyright © 2004 Universite Louis PASTEUR, STRASBOURG.
 +  Copyright © 2004 Scott Ellis (www.scottellis.com.au mail@scottellis.com.au)
 +  
 +  This program 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
 +  of the License, or (at your option) any later version.
 +  
 +  This program 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 this program; if not, write to the Free Software
 +  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 +}
 +{$IFNDEF M_METACONTACTS}
 +{$DEFINE M_METACONTACTS}
 +
 +const
 +  { get the handle for a contact's parent metacontact
 +    wParam=(HANDLE)hSubContact
 +    lParam=0
 +    returns a handle to the parent metacontact, or null if this contact is not
 +    a subcontact
 +  }
 +  MS_MC_GETMETACONTACT = 'MetaContacts/GetMeta';
 +
 +  { gets the handle for the default contact
 +    wParam=(HANDLE)hMetaContact
 +    lParam=0
 +    returns a handle to the default contact, or null on failure }
 +  MS_MC_GETDEFAULTCONTACT = 'MetaContacts/GetDefault';
 +
 +  { gets the contact number for the default contact
 +    wParam=(HANDLE)hMetaContact
 +    lParam=0
 +    returns a DWORD contact number, or -1 on failure }
 +  MS_MC_GETDEFAULTCONTACTNUM = 'MetaContacts/GetDefaultNum';
 +
 +  { gets the handle for the 'most online' contact
 +    wParam=(HANDLE)hMetaContact
 +    lParam=0
 +    returns a handle to the 'most online' contact }
 +  MS_MC_GETMOSTONLINECONTACT = 'MetaContacts/GetMostOnline';
 +
 +  { gets the number of subcontacts for a metacontact
 +    wParam=(HANDLE)hMetaContact
 +    lParam=0
 +    returns a DWORD representing the number of subcontacts for the given metacontact }
 +  MS_MC_GETNUMCONTACTS = 'MetaContacts/GetNumContacts';
 +
 +  { gets the handle of a subcontact, using the subcontact's number
 +    wParam=(HANDLE)hMetaContact
 +    lParam=(DWORD)contact number
 +    returns a handle to the specified subcontact }
 +  MS_MC_GETSUBCONTACT = 'MetaContacts/GetSubContact';
 +
 +  { sets the default contact, using the subcontact's contact number
 +    wParam=(HANDLE)hMetaContact
 +    lParam=(DWORD)contact number
 +    returns 0 on success }
 +  MS_MC_SETDEFAULTCONTACTNUM = 'MetaContacts/SetDefault';
 +
 +  { sets the default contact, using the subcontact's handle
 +    wParam=(HANDLE)hMetaContact
 +    lParam=(HANDLE)hSubcontact
 +    returns 0 on success }
 +  MS_MC_SETDEFAULTCONTACT = 'MetaContacts/SetDefaultByHandle';
 +
 +  { forces the metacontact to send using a specific subcontact, using the subcontact's contact number
 +    wParam=(HANDLE)hMetaContact
 +    lParam=(DWORD)contact number
 +    returns 0 on success }
 +  MS_MC_FORCESENDCONTACTNUM = 'MetaContacts/ForceSendContact';
 +
 +  { forces the metacontact to send using a specific subcontact, using the subcontact's handle
 +    wParam=(HANDLE)hMetaContact
 +    lParam=(HANDLE)hSubcontact
 +    returns 0 on success (will fail if 'force default' is in effect) }
 +  MS_MC_FORCESENDCONTACT = 'MetaContacts/ForceSendContactByHandle';
 +
 +  { 'unforces' the metacontact to send using a specific subcontact
 +    wParam=(HANDLE)hMetaContact
 +    lParam=0
 +    returns 0 on success (will fail if 'force default' is in effect) }
 +  MS_MC_UNFORCESENDCONTACT = 'MetaContacts/UnforceSendContact';
 +
 +  { 'forces' or 'unforces' (i.e. toggles) the metacontact to send using it's default contact
 +    overrides (and clears) 'force send' above, and will even force use of offline contacts
 +    will send ME_MC_FORCESEND or ME_MC_UNFORCESEND event
 +    wParam=(HANDLE)hMetaContact
 +    lParam=0
 +    returns 1(true) or 0(false) representing new state of 'force default' }
 +  MS_MC_FORCEDEFAULT = 'MetaContacts/ForceSendDefault';
 +
 +  { method to get state of 'force' for a metacontact
 +    wParam=(HANDLE)hMetaContact
 +    lParam= (DWORD)&contact_number or NULL
 +    if lparam supplied, the contact_number of the contatct 'in force' will be copied to the address it points to,
 +    or if none is in force, the value (DWORD)-1 will be copied
 +    (v0.8.0.8+ returns 1 if 'force default' is true with *lParam == default contact number, else returns 0 with *lParam as above) }
 +  MS_MC_GETFORCESTATE = 'MetaContacts/GetForceState';
 +
 +  { fired when a metacontact's default contact changes (fired upon creation of metacontact also, when default is initially set)
 +    wParam=(HANDLE)hMetaContact
 +    lParam=(HANDLE)hDefaultContact }
 +  ME_MC_DEFAULTTCHANGED = 'MetaContacts/DefaultChanged';
 +
 +  { fired when a metacontact's subcontacts change (fired upon creation of
 +    metacontact, when contacts are added or removed, and when contacts are
 +    reordered) - a signal to re-read metacontact data
 +    wParam=(HANDLE)hMetaContact
 +    lParam=0 }
 +  ME_MC_SUBCONTACTSCHANGED = 'MetaContacts/SubcontactsChanged';
 +
 +  { fired when a metacontact is forced to send using a specific subcontact
 +    wParam=(HANDLE)hMetaContact
 +    lParam=(HANDLE)hForceContact  }
 +  ME_MC_FORCESEND = 'MetaContacts/ForceSend';
 +
 +  { fired when a metacontact is 'unforced' to send using a specific subcontact
 +    wParam=(HANDLE)hMetaContact
 +    lParam=0  }
 +  ME_MC_UNFORCESEND = 'MetaContacts/UnforceSend';
 +
 +  { method to get protocol name - used to be sure you're dealing with a "real" metacontacts plugin :)
 +    wParam=lParam=0 }
 +  MS_MC_GETPROTOCOLNAME = 'MetaContacts/GetProtoName';
 +
 +  { added 0.9.5.0 (22/3/05)
 +    wParam=(HANDLE)hContact
 +    lParam=0
 +    convert a given contact into a metacontact
 +  }
 +  MS_MC_CONVERTTOMETA = 'MetaContacts/ConvertToMetacontact';
 +
 +  { added 0.9.5.0 (22/3/05)
 +    wParam=(HANDLE)hContact
 +    lParam=(HANDLE)hMeta
 +    add an existing contact to a metacontact
 +  }
 +  MS_MC_ADDTOMETA = 'MetaContacts/AddToMetacontact';
 +
 +  { added 0.9.5.0 (22/3/05)
 +    wParam=0
 +    lParam=(HANDLE)hContact
 +    remove a contact from a metacontact
 +  }
 +  MS_MC_REMOVEFROMMETA = 'MetaContacts/RemoveFromMetacontact';
 +
 +
 +  { added 0.9.13.2 (6/10/05)
 +    wParam=(BOOL)disable
 +    lParam=0
 +    enable/disable the 'hidden group hack' - for clists that support subcontact
 +    hiding using 'IsSubcontact' setting. Should be called once in the clist
 +    'onmodulesloaded' event handler (which, since it's loaded after the db, will
 +    be called before the metacontact onmodulesloaded handler where the subcontact
 +    hiding is usually done)
 +  }
 +  MS_MC_DISABLEHIDDENGROUP = 'MetaContacts/DisableHiddenGroup';
 +
 +{$ENDIF}
  | 
