nsIHistoryEntry.h 4.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139
  1. /*
  2. * DO NOT EDIT. THIS FILE IS GENERATED FROM c:/mozilla/xpfe/components/shistory/public/nsIHistoryEntry.idl
  3. */
  4. #ifndef __gen_nsIHistoryEntry_h__
  5. #define __gen_nsIHistoryEntry_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 nsIURI; /* forward declaration */
  14. /* starting interface: nsIHistoryEntry */
  15. #define NS_IHISTORYENTRY_IID_STR "a41661d4-1417-11d5-9882-00c04fa02f40"
  16. #define NS_IHISTORYENTRY_IID \
  17. {0xa41661d4, 0x1417, 0x11d5, \
  18. { 0x98, 0x82, 0x00, 0xc0, 0x4f, 0xa0, 0x2f, 0x40 }}
  19. class NS_NO_VTABLE nsIHistoryEntry : public nsISupports {
  20. public:
  21. NS_DEFINE_STATIC_IID_ACCESSOR(NS_IHISTORYENTRY_IID)
  22. /**
  23. * A readonly property that returns the URI
  24. * of the current entry. The object returned is
  25. * of type nsIURI
  26. */
  27. /* readonly attribute nsIURI URI; */
  28. NS_IMETHOD GetURI(nsIURI * *aURI) = 0;
  29. /**
  30. * A readonly property that returns the title
  31. * of the current entry. The object returned
  32. * is a encoded string
  33. */
  34. /* readonly attribute wstring title; */
  35. NS_IMETHOD GetTitle(PRUnichar * *aTitle) = 0;
  36. /**
  37. * A readonly property that returns a boolean
  38. * flag which indicates if the entry was created as a
  39. * result of a subframe navigation. This flag will be
  40. * 'false' when a frameset page is visited for
  41. * the first time. This flag will be 'true' for all
  42. * history entries created as a result of a subframe
  43. * navigation.
  44. */
  45. /* readonly attribute boolean isSubFrame; */
  46. NS_IMETHOD GetIsSubFrame(PRBool *aIsSubFrame) = 0;
  47. };
  48. /* Use this macro when declaring classes that implement this interface. */
  49. #define NS_DECL_NSIHISTORYENTRY \
  50. NS_IMETHOD GetURI(nsIURI * *aURI); \
  51. NS_IMETHOD GetTitle(PRUnichar * *aTitle); \
  52. NS_IMETHOD GetIsSubFrame(PRBool *aIsSubFrame);
  53. /* Use this macro to declare functions that forward the behavior of this interface to another object. */
  54. #define NS_FORWARD_NSIHISTORYENTRY(_to) \
  55. NS_IMETHOD GetURI(nsIURI * *aURI) { return _to GetURI(aURI); } \
  56. NS_IMETHOD GetTitle(PRUnichar * *aTitle) { return _to GetTitle(aTitle); } \
  57. NS_IMETHOD GetIsSubFrame(PRBool *aIsSubFrame) { return _to GetIsSubFrame(aIsSubFrame); }
  58. /* Use this macro to declare functions that forward the behavior of this interface to another object in a safe way. */
  59. #define NS_FORWARD_SAFE_NSIHISTORYENTRY(_to) \
  60. NS_IMETHOD GetURI(nsIURI * *aURI) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetURI(aURI); } \
  61. NS_IMETHOD GetTitle(PRUnichar * *aTitle) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetTitle(aTitle); } \
  62. NS_IMETHOD GetIsSubFrame(PRBool *aIsSubFrame) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetIsSubFrame(aIsSubFrame); }
  63. #if 0
  64. /* Use the code below as a template for the implementation class for this interface. */
  65. /* Header file */
  66. class nsHistoryEntry : public nsIHistoryEntry
  67. {
  68. public:
  69. NS_DECL_ISUPPORTS
  70. NS_DECL_NSIHISTORYENTRY
  71. nsHistoryEntry();
  72. private:
  73. ~nsHistoryEntry();
  74. protected:
  75. /* additional members */
  76. };
  77. /* Implementation file */
  78. NS_IMPL_ISUPPORTS1(nsHistoryEntry, nsIHistoryEntry)
  79. nsHistoryEntry::nsHistoryEntry()
  80. {
  81. /* member initializers and constructor code */
  82. }
  83. nsHistoryEntry::~nsHistoryEntry()
  84. {
  85. /* destructor code */
  86. }
  87. /* readonly attribute nsIURI URI; */
  88. NS_IMETHODIMP nsHistoryEntry::GetURI(nsIURI * *aURI)
  89. {
  90. return NS_ERROR_NOT_IMPLEMENTED;
  91. }
  92. /* readonly attribute wstring title; */
  93. NS_IMETHODIMP nsHistoryEntry::GetTitle(PRUnichar * *aTitle)
  94. {
  95. return NS_ERROR_NOT_IMPLEMENTED;
  96. }
  97. /* readonly attribute boolean isSubFrame; */
  98. NS_IMETHODIMP nsHistoryEntry::GetIsSubFrame(PRBool *aIsSubFrame)
  99. {
  100. return NS_ERROR_NOT_IMPLEMENTED;
  101. }
  102. /* End of implementation class template. */
  103. #endif
  104. // {A41661D5-1417-11D5-9882-00C04FA02F40}
  105. #define NS_HISTORYENTRY_CID \
  106. {0xa41661d5, 0x1417, 0x11d5, {0x98, 0x82, 0x0, 0xc0, 0x4f, 0xa0, 0x2f, 0x40}}
  107. #define NS_HISTORYENTRY_CONTRACTID \
  108. "@mozilla.org/browser/history-entry;1"
  109. #endif /* __gen_nsIHistoryEntry_h__ */