PageRenderTime 40ms CodeModel.GetById 18ms RepoModel.GetById 0ms app.codeStats 0ms

/gecko_api/include/nsITooltipTextProvider.h

http://firefox-mac-pdf.googlecode.com/
C Header | 124 lines | 49 code | 27 blank | 48 comment | 0 complexity | ea7771fb216cbd56e9258e3e4757f831 MD5 | raw file
  1. /*
  2. * DO NOT EDIT. THIS FILE IS GENERATED FROM /builds/tinderbox/XR-Trunk/Darwin_8.8.4_Depend/mozilla/embedding/browser/webBrowser/nsITooltipTextProvider.idl
  3. */
  4. #ifndef __gen_nsITooltipTextProvider_h__
  5. #define __gen_nsITooltipTextProvider_h__
  6. #ifndef __gen_nsISupports_h__
  7. #include "nsISupports.h"
  8. #endif
  9. /* For IDL files that don't want to include root IDL files. */
  10. #ifndef NS_NO_VTABLE
  11. #define NS_NO_VTABLE
  12. #endif
  13. class nsIDOMNode; /* forward declaration */
  14. /* starting interface: nsITooltipTextProvider */
  15. #define NS_ITOOLTIPTEXTPROVIDER_IID_STR "b128a1e6-44f3-4331-8fbe-5af360ff21ee"
  16. #define NS_ITOOLTIPTEXTPROVIDER_IID \
  17. {0xb128a1e6, 0x44f3, 0x4331, \
  18. { 0x8f, 0xbe, 0x5a, 0xf3, 0x60, 0xff, 0x21, 0xee }}
  19. /**
  20. * An interface implemented by a tooltip text provider service. This
  21. * service is called to discover what tooltip text is associated
  22. * with the node that the pointer is positioned over.
  23. *
  24. * Embedders may implement and register their own tooltip text provider
  25. * service if they wish to provide different tooltip text.
  26. *
  27. * The default service returns the text stored in the TITLE
  28. * attribute of the node or a containing parent.
  29. *
  30. * @note
  31. * The tooltip text provider service is registered with the contract
  32. * defined in NS_TOOLTIPTEXTPROVIDER_CONTRACTID.
  33. *
  34. * @see nsITooltipListener
  35. * @see nsIComponentManager
  36. * @see nsIDOMNode
  37. *
  38. * @status FROZEN
  39. */
  40. class NS_NO_VTABLE NS_SCRIPTABLE nsITooltipTextProvider : public nsISupports {
  41. public:
  42. NS_DECLARE_STATIC_IID_ACCESSOR(NS_ITOOLTIPTEXTPROVIDER_IID)
  43. /**
  44. * Called to obtain the tooltip text for a node.
  45. *
  46. * @arg aNode The node to obtain the text from.
  47. * @arg aText The tooltip text.
  48. *
  49. * @return <CODE>PR_TRUE</CODE> if tooltip text is associated
  50. * with the node and was returned in the aText argument;
  51. * <CODE>PR_FALSE</CODE> otherwise.
  52. */
  53. /* boolean getNodeText (in nsIDOMNode aNode, out wstring aText); */
  54. NS_SCRIPTABLE NS_IMETHOD GetNodeText(nsIDOMNode *aNode, PRUnichar **aText, PRBool *_retval) = 0;
  55. };
  56. NS_DEFINE_STATIC_IID_ACCESSOR(nsITooltipTextProvider, NS_ITOOLTIPTEXTPROVIDER_IID)
  57. /* Use this macro when declaring classes that implement this interface. */
  58. #define NS_DECL_NSITOOLTIPTEXTPROVIDER \
  59. NS_SCRIPTABLE NS_IMETHOD GetNodeText(nsIDOMNode *aNode, PRUnichar **aText, PRBool *_retval);
  60. /* Use this macro to declare functions that forward the behavior of this interface to another object. */
  61. #define NS_FORWARD_NSITOOLTIPTEXTPROVIDER(_to) \
  62. NS_SCRIPTABLE NS_IMETHOD GetNodeText(nsIDOMNode *aNode, PRUnichar **aText, PRBool *_retval) { return _to GetNodeText(aNode, aText, _retval); }
  63. /* Use this macro to declare functions that forward the behavior of this interface to another object in a safe way. */
  64. #define NS_FORWARD_SAFE_NSITOOLTIPTEXTPROVIDER(_to) \
  65. NS_SCRIPTABLE NS_IMETHOD GetNodeText(nsIDOMNode *aNode, PRUnichar **aText, PRBool *_retval) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetNodeText(aNode, aText, _retval); }
  66. #if 0
  67. /* Use the code below as a template for the implementation class for this interface. */
  68. /* Header file */
  69. class nsTooltipTextProvider : public nsITooltipTextProvider
  70. {
  71. public:
  72. NS_DECL_ISUPPORTS
  73. NS_DECL_NSITOOLTIPTEXTPROVIDER
  74. nsTooltipTextProvider();
  75. private:
  76. ~nsTooltipTextProvider();
  77. protected:
  78. /* additional members */
  79. };
  80. /* Implementation file */
  81. NS_IMPL_ISUPPORTS1(nsTooltipTextProvider, nsITooltipTextProvider)
  82. nsTooltipTextProvider::nsTooltipTextProvider()
  83. {
  84. /* member initializers and constructor code */
  85. }
  86. nsTooltipTextProvider::~nsTooltipTextProvider()
  87. {
  88. /* destructor code */
  89. }
  90. /* boolean getNodeText (in nsIDOMNode aNode, out wstring aText); */
  91. NS_IMETHODIMP nsTooltipTextProvider::GetNodeText(nsIDOMNode *aNode, PRUnichar **aText, PRBool *_retval)
  92. {
  93. return NS_ERROR_NOT_IMPLEMENTED;
  94. }
  95. /* End of implementation class template. */
  96. #endif
  97. #endif /* __gen_nsITooltipTextProvider_h__ */