PageRenderTime 294ms CodeModel.GetById 111ms app.highlight 3ms RepoModel.GetById 138ms app.codeStats 1ms

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