thunderbird-dev 1:38.6.0+build1-0ubuntu1 / usr / include / thunderbird / imICommandsService.h

/*
 * DO NOT EDIT.  THIS FILE IS GENERATED FROM ../../../dist/idl/imICommandsService.idl
 */

#ifndef __gen_imICommandsService_h__
#define __gen_imICommandsService_h__


#ifndef __gen_nsISupports_h__
#include "nsISupports.h"
#endif

/* For IDL files that don't want to include root IDL files. */
#ifndef NS_NO_VTABLE
#define NS_NO_VTABLE
#endif
class prplIConversation; /* forward declaration */


/* starting interface:    imICommand */
#define IMICOMMAND_IID_STR "b12b0d89-0e5b-499c-9567-37f2deacc182"

#define IMICOMMAND_IID \
  {0xb12b0d89, 0x0e5b, 0x499c, \
    { 0x95, 0x67, 0x37, 0xf2, 0xde, 0xac, 0xc1, 0x82 }}

class NS_NO_VTABLE imICommand : public nsISupports {
 public: 

  NS_DECLARE_STATIC_IID_ACCESSOR(IMICOMMAND_IID)

  /* readonly attribute AUTF8String name; */
  NS_IMETHOD GetName(nsACString & aName) = 0;

  /* readonly attribute AUTF8String helpString; */
  NS_IMETHOD GetHelpString(nsACString & aHelpString) = 0;

  enum {
    CMD_CONTEXT_IM = 1,
    CMD_CONTEXT_CHAT = 2,
    CMD_CONTEXT_ALL = 3
  };

  /* readonly attribute long usageContext; */
  NS_IMETHOD GetUsageContext(int32_t *aUsageContext) = 0;

  enum {
    CMD_PRIORITY_LOW = -1000,
    CMD_PRIORITY_DEFAULT = 0,
    CMD_PRIORITY_PRPL = 1000,
    CMD_PRIORITY_HIGH = 4000
  };

  /* readonly attribute long priority; */
  NS_IMETHOD GetPriority(int32_t *aPriority) = 0;

  /* boolean run (in AUTF8String aMessage, [optional] in prplIConversation aConversation, [optional] out prplIConversation aReturnedConv); */
  NS_IMETHOD Run(const nsACString & aMessage, prplIConversation *aConversation, prplIConversation * *aReturnedConv, bool *_retval) = 0;

};

  NS_DEFINE_STATIC_IID_ACCESSOR(imICommand, IMICOMMAND_IID)

/* Use this macro when declaring classes that implement this interface. */
#define NS_DECL_IMICOMMAND \
  NS_IMETHOD GetName(nsACString & aName) override; \
  NS_IMETHOD GetHelpString(nsACString & aHelpString) override; \
  NS_IMETHOD GetUsageContext(int32_t *aUsageContext) override; \
  NS_IMETHOD GetPriority(int32_t *aPriority) override; \
  NS_IMETHOD Run(const nsACString & aMessage, prplIConversation *aConversation, prplIConversation * *aReturnedConv, bool *_retval) override; 

/* Use this macro to declare functions that forward the behavior of this interface to another object. */
#define NS_FORWARD_IMICOMMAND(_to) \
  NS_IMETHOD GetName(nsACString & aName) override { return _to GetName(aName); } \
  NS_IMETHOD GetHelpString(nsACString & aHelpString) override { return _to GetHelpString(aHelpString); } \
  NS_IMETHOD GetUsageContext(int32_t *aUsageContext) override { return _to GetUsageContext(aUsageContext); } \
  NS_IMETHOD GetPriority(int32_t *aPriority) override { return _to GetPriority(aPriority); } \
  NS_IMETHOD Run(const nsACString & aMessage, prplIConversation *aConversation, prplIConversation * *aReturnedConv, bool *_retval) override { return _to Run(aMessage, aConversation, aReturnedConv, _retval); } 

/* Use this macro to declare functions that forward the behavior of this interface to another object in a safe way. */
#define NS_FORWARD_SAFE_IMICOMMAND(_to) \
  NS_IMETHOD GetName(nsACString & aName) override { return !_to ? NS_ERROR_NULL_POINTER : _to->GetName(aName); } \
  NS_IMETHOD GetHelpString(nsACString & aHelpString) override { return !_to ? NS_ERROR_NULL_POINTER : _to->GetHelpString(aHelpString); } \
  NS_IMETHOD GetUsageContext(int32_t *aUsageContext) override { return !_to ? NS_ERROR_NULL_POINTER : _to->GetUsageContext(aUsageContext); } \
  NS_IMETHOD GetPriority(int32_t *aPriority) override { return !_to ? NS_ERROR_NULL_POINTER : _to->GetPriority(aPriority); } \
  NS_IMETHOD Run(const nsACString & aMessage, prplIConversation *aConversation, prplIConversation * *aReturnedConv, bool *_retval) override { return !_to ? NS_ERROR_NULL_POINTER : _to->Run(aMessage, aConversation, aReturnedConv, _retval); } 

#if 0
/* Use the code below as a template for the implementation class for this interface. */

/* Header file */
class imCommand : public imICommand
{
public:
  NS_DECL_ISUPPORTS
  NS_DECL_IMICOMMAND

  imCommand();

private:
  ~imCommand();

protected:
  /* additional members */
};

/* Implementation file */
NS_IMPL_ISUPPORTS(imCommand, imICommand)

imCommand::imCommand()
{
  /* member initializers and constructor code */
}

imCommand::~imCommand()
{
  /* destructor code */
}

/* readonly attribute AUTF8String name; */
NS_IMETHODIMP imCommand::GetName(nsACString & aName)
{
    return NS_ERROR_NOT_IMPLEMENTED;
}

/* readonly attribute AUTF8String helpString; */
NS_IMETHODIMP imCommand::GetHelpString(nsACString & aHelpString)
{
    return NS_ERROR_NOT_IMPLEMENTED;
}

/* readonly attribute long usageContext; */
NS_IMETHODIMP imCommand::GetUsageContext(int32_t *aUsageContext)
{
    return NS_ERROR_NOT_IMPLEMENTED;
}

/* readonly attribute long priority; */
NS_IMETHODIMP imCommand::GetPriority(int32_t *aPriority)
{
    return NS_ERROR_NOT_IMPLEMENTED;
}

/* boolean run (in AUTF8String aMessage, [optional] in prplIConversation aConversation, [optional] out prplIConversation aReturnedConv); */
NS_IMETHODIMP imCommand::Run(const nsACString & aMessage, prplIConversation *aConversation, prplIConversation * *aReturnedConv, bool *_retval)
{
    return NS_ERROR_NOT_IMPLEMENTED;
}

/* End of implementation class template. */
#endif


/* starting interface:    imICommandsService */
#define IMICOMMANDSSERVICE_IID_STR "9a1accfd-9bd8-4548-aef7-e8107fc7839f"

#define IMICOMMANDSSERVICE_IID \
  {0x9a1accfd, 0x9bd8, 0x4548, \
    { 0xae, 0xf7, 0xe8, 0x10, 0x7f, 0xc7, 0x83, 0x9f }}

class NS_NO_VTABLE imICommandsService : public nsISupports {
 public: 

  NS_DECLARE_STATIC_IID_ACCESSOR(IMICOMMANDSSERVICE_IID)

  /* void initCommands (); */
  NS_IMETHOD InitCommands(void) = 0;

  /* void unInitCommands (); */
  NS_IMETHOD UnInitCommands(void) = 0;

  /* void registerCommand (in imICommand aCommand, [optional] in AUTF8String aPrplId); */
  NS_IMETHOD RegisterCommand(imICommand *aCommand, const nsACString & aPrplId) = 0;

  /* void unregisterCommand (in AUTF8String aCommandName, [optional] in AUTF8String aPrplId); */
  NS_IMETHOD UnregisterCommand(const nsACString & aCommandName, const nsACString & aPrplId) = 0;

  /* void listCommandsForConversation ([optional] in prplIConversation aConversation, [optional] out unsigned long commandCount, [array, size_is (commandCount), retval] out imICommand commands); */
  NS_IMETHOD ListCommandsForConversation(prplIConversation *aConversation, uint32_t *commandCount, imICommand * **commands) = 0;

  /* void listCommandsForProtocol (in AUTF8String aPrplId, [optional] out unsigned long commandCount, [array, size_is (commandCount), retval] out imICommand commands); */
  NS_IMETHOD ListCommandsForProtocol(const nsACString & aPrplId, uint32_t *commandCount, imICommand * **commands) = 0;

  /* boolean executeCommand (in AUTF8String aMessage, [optional] in prplIConversation aConversation, [optional] out prplIConversation aReturnedConv); */
  NS_IMETHOD ExecuteCommand(const nsACString & aMessage, prplIConversation *aConversation, prplIConversation * *aReturnedConv, bool *_retval) = 0;

};

  NS_DEFINE_STATIC_IID_ACCESSOR(imICommandsService, IMICOMMANDSSERVICE_IID)

/* Use this macro when declaring classes that implement this interface. */
#define NS_DECL_IMICOMMANDSSERVICE \
  NS_IMETHOD InitCommands(void) override; \
  NS_IMETHOD UnInitCommands(void) override; \
  NS_IMETHOD RegisterCommand(imICommand *aCommand, const nsACString & aPrplId) override; \
  NS_IMETHOD UnregisterCommand(const nsACString & aCommandName, const nsACString & aPrplId) override; \
  NS_IMETHOD ListCommandsForConversation(prplIConversation *aConversation, uint32_t *commandCount, imICommand * **commands) override; \
  NS_IMETHOD ListCommandsForProtocol(const nsACString & aPrplId, uint32_t *commandCount, imICommand * **commands) override; \
  NS_IMETHOD ExecuteCommand(const nsACString & aMessage, prplIConversation *aConversation, prplIConversation * *aReturnedConv, bool *_retval) override; 

/* Use this macro to declare functions that forward the behavior of this interface to another object. */
#define NS_FORWARD_IMICOMMANDSSERVICE(_to) \
  NS_IMETHOD InitCommands(void) override { return _to InitCommands(); } \
  NS_IMETHOD UnInitCommands(void) override { return _to UnInitCommands(); } \
  NS_IMETHOD RegisterCommand(imICommand *aCommand, const nsACString & aPrplId) override { return _to RegisterCommand(aCommand, aPrplId); } \
  NS_IMETHOD UnregisterCommand(const nsACString & aCommandName, const nsACString & aPrplId) override { return _to UnregisterCommand(aCommandName, aPrplId); } \
  NS_IMETHOD ListCommandsForConversation(prplIConversation *aConversation, uint32_t *commandCount, imICommand * **commands) override { return _to ListCommandsForConversation(aConversation, commandCount, commands); } \
  NS_IMETHOD ListCommandsForProtocol(const nsACString & aPrplId, uint32_t *commandCount, imICommand * **commands) override { return _to ListCommandsForProtocol(aPrplId, commandCount, commands); } \
  NS_IMETHOD ExecuteCommand(const nsACString & aMessage, prplIConversation *aConversation, prplIConversation * *aReturnedConv, bool *_retval) override { return _to ExecuteCommand(aMessage, aConversation, aReturnedConv, _retval); } 

/* Use this macro to declare functions that forward the behavior of this interface to another object in a safe way. */
#define NS_FORWARD_SAFE_IMICOMMANDSSERVICE(_to) \
  NS_IMETHOD InitCommands(void) override { return !_to ? NS_ERROR_NULL_POINTER : _to->InitCommands(); } \
  NS_IMETHOD UnInitCommands(void) override { return !_to ? NS_ERROR_NULL_POINTER : _to->UnInitCommands(); } \
  NS_IMETHOD RegisterCommand(imICommand *aCommand, const nsACString & aPrplId) override { return !_to ? NS_ERROR_NULL_POINTER : _to->RegisterCommand(aCommand, aPrplId); } \
  NS_IMETHOD UnregisterCommand(const nsACString & aCommandName, const nsACString & aPrplId) override { return !_to ? NS_ERROR_NULL_POINTER : _to->UnregisterCommand(aCommandName, aPrplId); } \
  NS_IMETHOD ListCommandsForConversation(prplIConversation *aConversation, uint32_t *commandCount, imICommand * **commands) override { return !_to ? NS_ERROR_NULL_POINTER : _to->ListCommandsForConversation(aConversation, commandCount, commands); } \
  NS_IMETHOD ListCommandsForProtocol(const nsACString & aPrplId, uint32_t *commandCount, imICommand * **commands) override { return !_to ? NS_ERROR_NULL_POINTER : _to->ListCommandsForProtocol(aPrplId, commandCount, commands); } \
  NS_IMETHOD ExecuteCommand(const nsACString & aMessage, prplIConversation *aConversation, prplIConversation * *aReturnedConv, bool *_retval) override { return !_to ? NS_ERROR_NULL_POINTER : _to->ExecuteCommand(aMessage, aConversation, aReturnedConv, _retval); } 

#if 0
/* Use the code below as a template for the implementation class for this interface. */

/* Header file */
class imCommandsService : public imICommandsService
{
public:
  NS_DECL_ISUPPORTS
  NS_DECL_IMICOMMANDSSERVICE

  imCommandsService();

private:
  ~imCommandsService();

protected:
  /* additional members */
};

/* Implementation file */
NS_IMPL_ISUPPORTS(imCommandsService, imICommandsService)

imCommandsService::imCommandsService()
{
  /* member initializers and constructor code */
}

imCommandsService::~imCommandsService()
{
  /* destructor code */
}

/* void initCommands (); */
NS_IMETHODIMP imCommandsService::InitCommands()
{
    return NS_ERROR_NOT_IMPLEMENTED;
}

/* void unInitCommands (); */
NS_IMETHODIMP imCommandsService::UnInitCommands()
{
    return NS_ERROR_NOT_IMPLEMENTED;
}

/* void registerCommand (in imICommand aCommand, [optional] in AUTF8String aPrplId); */
NS_IMETHODIMP imCommandsService::RegisterCommand(imICommand *aCommand, const nsACString & aPrplId)
{
    return NS_ERROR_NOT_IMPLEMENTED;
}

/* void unregisterCommand (in AUTF8String aCommandName, [optional] in AUTF8String aPrplId); */
NS_IMETHODIMP imCommandsService::UnregisterCommand(const nsACString & aCommandName, const nsACString & aPrplId)
{
    return NS_ERROR_NOT_IMPLEMENTED;
}

/* void listCommandsForConversation ([optional] in prplIConversation aConversation, [optional] out unsigned long commandCount, [array, size_is (commandCount), retval] out imICommand commands); */
NS_IMETHODIMP imCommandsService::ListCommandsForConversation(prplIConversation *aConversation, uint32_t *commandCount, imICommand * **commands)
{
    return NS_ERROR_NOT_IMPLEMENTED;
}

/* void listCommandsForProtocol (in AUTF8String aPrplId, [optional] out unsigned long commandCount, [array, size_is (commandCount), retval] out imICommand commands); */
NS_IMETHODIMP imCommandsService::ListCommandsForProtocol(const nsACString & aPrplId, uint32_t *commandCount, imICommand * **commands)
{
    return NS_ERROR_NOT_IMPLEMENTED;
}

/* boolean executeCommand (in AUTF8String aMessage, [optional] in prplIConversation aConversation, [optional] out prplIConversation aReturnedConv); */
NS_IMETHODIMP imCommandsService::ExecuteCommand(const nsACString & aMessage, prplIConversation *aConversation, prplIConversation * *aReturnedConv, bool *_retval)
{
    return NS_ERROR_NOT_IMPLEMENTED;
}

/* End of implementation class template. */
#endif

#define IM_COMMANDS_SERVICE_CONTRACTID \
  "@mozilla.org/chat/commands-service;1"

#endif /* __gen_imICommandsService_h__ */