/gecko_api/include/nsITooltipTextProvider.h
C Header | 124 lines | 49 code | 27 blank | 48 comment | 0 complexity | ea7771fb216cbd56e9258e3e4757f831 MD5 | raw file
- /*
- * DO NOT EDIT. THIS FILE IS GENERATED FROM /builds/tinderbox/XR-Trunk/Darwin_8.8.4_Depend/mozilla/embedding/browser/webBrowser/nsITooltipTextProvider.idl
- */
- #ifndef __gen_nsITooltipTextProvider_h__
- #define __gen_nsITooltipTextProvider_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 nsIDOMNode; /* forward declaration */
- /* starting interface: nsITooltipTextProvider */
- #define NS_ITOOLTIPTEXTPROVIDER_IID_STR "b128a1e6-44f3-4331-8fbe-5af360ff21ee"
- #define NS_ITOOLTIPTEXTPROVIDER_IID \
- {0xb128a1e6, 0x44f3, 0x4331, \
- { 0x8f, 0xbe, 0x5a, 0xf3, 0x60, 0xff, 0x21, 0xee }}
- /**
- * An interface implemented by a tooltip text provider service. This
- * service is called to discover what tooltip text is associated
- * with the node that the pointer is positioned over.
- *
- * Embedders may implement and register their own tooltip text provider
- * service if they wish to provide different tooltip text.
- *
- * The default service returns the text stored in the TITLE
- * attribute of the node or a containing parent.
- *
- * @note
- * The tooltip text provider service is registered with the contract
- * defined in NS_TOOLTIPTEXTPROVIDER_CONTRACTID.
- *
- * @see nsITooltipListener
- * @see nsIComponentManager
- * @see nsIDOMNode
- *
- * @status FROZEN
- */
- class NS_NO_VTABLE NS_SCRIPTABLE nsITooltipTextProvider : public nsISupports {
- public:
- NS_DECLARE_STATIC_IID_ACCESSOR(NS_ITOOLTIPTEXTPROVIDER_IID)
- /**
- * Called to obtain the tooltip text for a node.
- *
- * @arg aNode The node to obtain the text from.
- * @arg aText The tooltip text.
- *
- * @return <CODE>PR_TRUE</CODE> if tooltip text is associated
- * with the node and was returned in the aText argument;
- * <CODE>PR_FALSE</CODE> otherwise.
- */
- /* boolean getNodeText (in nsIDOMNode aNode, out wstring aText); */
- NS_SCRIPTABLE NS_IMETHOD GetNodeText(nsIDOMNode *aNode, PRUnichar **aText, PRBool *_retval) = 0;
- };
- NS_DEFINE_STATIC_IID_ACCESSOR(nsITooltipTextProvider, NS_ITOOLTIPTEXTPROVIDER_IID)
- /* Use this macro when declaring classes that implement this interface. */
- #define NS_DECL_NSITOOLTIPTEXTPROVIDER \
- NS_SCRIPTABLE NS_IMETHOD GetNodeText(nsIDOMNode *aNode, PRUnichar **aText, PRBool *_retval);
- /* Use this macro to declare functions that forward the behavior of this interface to another object. */
- #define NS_FORWARD_NSITOOLTIPTEXTPROVIDER(_to) \
- NS_SCRIPTABLE NS_IMETHOD GetNodeText(nsIDOMNode *aNode, PRUnichar **aText, PRBool *_retval) { return _to GetNodeText(aNode, aText, _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_NSITOOLTIPTEXTPROVIDER(_to) \
- NS_SCRIPTABLE NS_IMETHOD GetNodeText(nsIDOMNode *aNode, PRUnichar **aText, PRBool *_retval) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetNodeText(aNode, aText, _retval); }
- #if 0
- /* Use the code below as a template for the implementation class for this interface. */
- /* Header file */
- class nsTooltipTextProvider : public nsITooltipTextProvider
- {
- public:
- NS_DECL_ISUPPORTS
- NS_DECL_NSITOOLTIPTEXTPROVIDER
- nsTooltipTextProvider();
- private:
- ~nsTooltipTextProvider();
- protected:
- /* additional members */
- };
- /* Implementation file */
- NS_IMPL_ISUPPORTS1(nsTooltipTextProvider, nsITooltipTextProvider)
- nsTooltipTextProvider::nsTooltipTextProvider()
- {
- /* member initializers and constructor code */
- }
- nsTooltipTextProvider::~nsTooltipTextProvider()
- {
- /* destructor code */
- }
- /* boolean getNodeText (in nsIDOMNode aNode, out wstring aText); */
- NS_IMETHODIMP nsTooltipTextProvider::GetNodeText(nsIDOMNode *aNode, PRUnichar **aText, PRBool *_retval)
- {
- return NS_ERROR_NOT_IMPLEMENTED;
- }
- /* End of implementation class template. */
- #endif
- #endif /* __gen_nsITooltipTextProvider_h__ */