PageRenderTime 275ms CodeModel.GetById 121ms app.highlight 4ms RepoModel.GetById 148ms app.codeStats 0ms

/gecko_api/include/nsIWebBrowserSetup.h

http://firefox-mac-pdf.googlecode.com/
C++ Header | 177 lines | 56 code | 34 blank | 87 comment | 0 complexity | 09412dd373d5fac648df861d92bf4c2b 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/nsIWebBrowserSetup.idl
  3 */
  4
  5#ifndef __gen_nsIWebBrowserSetup_h__
  6#define __gen_nsIWebBrowserSetup_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
 17
 18/* starting interface:    nsIWebBrowserSetup */
 19#define NS_IWEBBROWSERSETUP_IID_STR "f15398a0-8018-11d3-af70-00a024ffc08c"
 20
 21#define NS_IWEBBROWSERSETUP_IID \
 22  {0xf15398a0, 0x8018, 0x11d3, \
 23    { 0xaf, 0x70, 0x00, 0xa0, 0x24, 0xff, 0xc0, 0x8c }}
 24
 25/**
 26 * The nsIWebBrowserSetup interface lets you set properties on a browser
 27 * object; you can do so at any time during the life cycle of the browser.
 28 *
 29 * @note Unless stated otherwise, settings are presumed to be enabled by
 30 *       default.
 31 *
 32 * @status FROZEN
 33 */
 34class NS_NO_VTABLE NS_SCRIPTABLE nsIWebBrowserSetup : public nsISupports {
 35 public: 
 36
 37  NS_DECLARE_STATIC_IID_ACCESSOR(NS_IWEBBROWSERSETUP_IID)
 38
 39  /**
 40     * Boolean. Enables/disables plugin support for this browser.
 41     *
 42     * @see setProperty
 43     */
 44  enum { SETUP_ALLOW_PLUGINS = 1U };
 45
 46  /**
 47     * Boolean. Enables/disables Javascript support for this browser.
 48     *
 49     * @see setProperty
 50     */
 51  enum { SETUP_ALLOW_JAVASCRIPT = 2U };
 52
 53  /**
 54     * Boolean. Enables/disables meta redirect support for this browser.
 55     * Meta redirect timers will be ignored if this option is disabled.
 56     *
 57     * @see setProperty
 58     */
 59  enum { SETUP_ALLOW_META_REDIRECTS = 3U };
 60
 61  /**
 62     * Boolean. Enables/disables subframes within the browser
 63     *
 64     * @see setProperty
 65     */
 66  enum { SETUP_ALLOW_SUBFRAMES = 4U };
 67
 68  /**
 69     * Boolean. Enables/disables image loading for this browser
 70     * window. If you disable the images, load a page, then enable the images,
 71     * the page will *not* automatically load the images for the previously
 72     * loaded page. This flag controls the state of a webBrowser at load time 
 73     * and does not automatically re-load a page when the state is toggled. 
 74     * Reloading must be done by hand, or by walking through the DOM tree and 
 75     * re-setting the src attributes.
 76     *
 77     * @see setProperty
 78     */
 79  enum { SETUP_ALLOW_IMAGES = 5U };
 80
 81  /**
 82     * Boolean. Enables/disables whether the document as a whole gets focus before
 83     * traversing the document's content, or after traversing its content.
 84     *
 85     * NOTE: this property is obsolete and now has no effect
 86     *
 87     * @see setProperty
 88     */
 89  enum { SETUP_FOCUS_DOC_BEFORE_CONTENT = 6U };
 90
 91  /**
 92     * Boolean. Enables/disables the use of global history in the browser. Visited
 93     * URLs will not be recorded in the global history when it is disabled.
 94     *
 95     * @see setProperty
 96     */
 97  enum { SETUP_USE_GLOBAL_HISTORY = 256U };
 98
 99  /**
100     * Boolean. A value of PR_TRUE makes the browser a chrome wrapper.
101     * Default is PR_FALSE.
102     *
103     * @since mozilla1.0
104     *
105     * @see setProperty
106     */
107  enum { SETUP_IS_CHROME_WRAPPER = 7U };
108
109  /**
110     * Sets an integer or boolean property on the new web browser object.
111     * Only PR_TRUE and PR_FALSE are legal boolean values.
112     *
113     * @param aId The identifier of the property to be set.
114     * @param aValue The value of the property.
115     */
116  /* void setProperty (in unsigned long aId, in unsigned long aValue); */
117  NS_SCRIPTABLE NS_IMETHOD SetProperty(PRUint32 aId, PRUint32 aValue) = 0;
118
119};
120
121  NS_DEFINE_STATIC_IID_ACCESSOR(nsIWebBrowserSetup, NS_IWEBBROWSERSETUP_IID)
122
123/* Use this macro when declaring classes that implement this interface. */
124#define NS_DECL_NSIWEBBROWSERSETUP \
125  NS_SCRIPTABLE NS_IMETHOD SetProperty(PRUint32 aId, PRUint32 aValue); 
126
127/* Use this macro to declare functions that forward the behavior of this interface to another object. */
128#define NS_FORWARD_NSIWEBBROWSERSETUP(_to) \
129  NS_SCRIPTABLE NS_IMETHOD SetProperty(PRUint32 aId, PRUint32 aValue) { return _to SetProperty(aId, aValue); } 
130
131/* Use this macro to declare functions that forward the behavior of this interface to another object in a safe way. */
132#define NS_FORWARD_SAFE_NSIWEBBROWSERSETUP(_to) \
133  NS_SCRIPTABLE NS_IMETHOD SetProperty(PRUint32 aId, PRUint32 aValue) { return !_to ? NS_ERROR_NULL_POINTER : _to->SetProperty(aId, aValue); } 
134
135#if 0
136/* Use the code below as a template for the implementation class for this interface. */
137
138/* Header file */
139class nsWebBrowserSetup : public nsIWebBrowserSetup
140{
141public:
142  NS_DECL_ISUPPORTS
143  NS_DECL_NSIWEBBROWSERSETUP
144
145  nsWebBrowserSetup();
146
147private:
148  ~nsWebBrowserSetup();
149
150protected:
151  /* additional members */
152};
153
154/* Implementation file */
155NS_IMPL_ISUPPORTS1(nsWebBrowserSetup, nsIWebBrowserSetup)
156
157nsWebBrowserSetup::nsWebBrowserSetup()
158{
159  /* member initializers and constructor code */
160}
161
162nsWebBrowserSetup::~nsWebBrowserSetup()
163{
164  /* destructor code */
165}
166
167/* void setProperty (in unsigned long aId, in unsigned long aValue); */
168NS_IMETHODIMP nsWebBrowserSetup::SetProperty(PRUint32 aId, PRUint32 aValue)
169{
170    return NS_ERROR_NOT_IMPLEMENTED;
171}
172
173/* End of implementation class template. */
174#endif
175
176
177#endif /* __gen_nsIWebBrowserSetup_h__ */