ruby-****@sourc*****
ruby-****@sourc*****
2005年 2月 20日 (日) 04:39:13 JST
-------------------------
REMOTE_ADDR = 84.220.100.112
REMOTE_HOST =
URL = http://ruby-gnome2.sourceforge.jp//?Gtk%3A%3AMozEmbed
-------------------------
= class Gtk::MozEmbed
This class wraps the GtkMozEmbed widget in a Ruby class.
The GtkMozEmbed is provided by either Mozilla or Firefox.
You need to have libgtkmozembed.so in your library path
to use and mozilla-gtkmozembed.pc and gtkmozembed.h in
order to compile.
== Object Hierarchy
* Object
* GLib::Instantiatable
* GLib::Object
* Gtk::Object
* Gtk::Widget
* Gtk::Container
* Gtk::Bin
* Gtk::MozEmbed
== Class Methods
--- Gtk::MozEmbed.new
+
Constructor for the Gtk::MozEmbed object.
+
* Returns: a newly created Gtk::MozEmbed widget.
--- Gtk::MozEmbed.set_comp_path(path)
+
You should call this method before the constructor.
The path should be something like /usr/lib/mozilla or
/usr/lib/mozilla-firefox depending on your installation and
distribution.
+
FIXME - Not sure if this is needed, perhaps we should call this
inside Init_gtkmozembed() and set the value at compile time
before initializing XPCOM.
+
* path: the mozilla component path (String).
* Returns: nil.
--- Gtk::MozEmbed.set_profile_path(profile_path, profile_name)
+
You should call this method before the constructor. The
profile_path parameter should be set to $ENV['HOME']+'/.mozilla'.
+
A new profile directory with this name will be created in the
profile_path directory.
+
* profile_name: the name of the application using the widget (String).
* profile_path: the path to store the profile (String).
* Returns: nil.
== Instance Methods
+
--- can_go_back?
+
This method reflects the status of the browsing history.
+
* Returns: True if the browser can go back one page.
--- can_go_forward?
+
This method reflects the status of the browsing history.
+
* Returns: True if the browser can go forward one page.
--- chrome_mask=(flags)
+
This method returns the given parameter 'flags'.
+
* flags: a combination of Gtk::MozEmbed::ChromeFlags Set the chrome mask.
* Returns: the given parameter 'flags'.
--- get_chrome_mask(flags)
Get the chrome mask.
* Returns: a combination of Moz::GtkEmbed::ChromeFlags.
--- go_back
Tells the browser to go back one page in the history.
* Returns: the object itself.
--- go_forward
Tells the browser to go one page forward in the history.
* Returns: the object itself.
--- js_status
The ECMAScript status message, useful when the "js_status" signal
is raised.
* Returns: the selected url.
--- link_message
The location of the selected link, useful when the "link_message"
signal is raised.
* Returns: the selected url.
--- location
The current location, usefull when the "location" signal is raised.
* Returns: the current location (String).
--- location=(url)
This method starts loading the given url, and returns
immediately. The url should be in the form "http://www.gnome.org".
* url: the url to load (String).
* Returns: the given parameter 'url'.
--- reload
Forces a page reload of a specific type.
- * flags: one of the Gtk::MozEmbed::ReloadFlags (Gtk::MozEmbed::RELOADNORMAL, Gtk::MozEmbed::RELOADBYPASSCACHE, Gtk::MozEmbed::RELOADBYPASSPROXY, Gtk::MozEmbed::RELOADBYPASSPROXYANDCACHE).
+ * flags: one of the Gtk::MozEmbed::ReloadFlags.
* Returns: the object itself.
--- set_chrome_mask(flags)
This method returns the object itself.
* flags: a combination of Gtk::MozEmbed::ChromeFlags Set the chrome mask.
* Returns: the object itself.
--- set_location(url)
This method starts loading the given url, and returns
immediately. The url should be in the form "http://www.gnome.org".
* url: the url to load (String).
* Returns: the object itself.
--- stop_load
Stops loading the current page.
* Returns: the object itself.
--- title
The title of the currently loaded page, usefull when the "title"
signal is raised.
* Returns: the page title.
== Signals
--- link_message: self
This signal is raised when the user selects or moves the mouse over a link. See alsa Gtk::MozEmbed#link_message.
--- js_status: self
This signal is raised when an ECMAScript message needs to be displayed. See also Gtk::MozEmbed#js_status.
--- location: self
This signal is raised when the location of the document changes. See Gtk::MozEmbed#location.
--- title: self
This signal is raised when the title of the displayed document changes. See Gtk::MozEmbed#title.
--- progress: self, cur, max
This signal is raised to let the ui update an optional the progress bar.
cur: The bytes received.
max: This il the number of bytes of the document or something <1 if it cannot be determined.
--- net_state: self, flags, status
This signal is raised when the connection status changes.
--- net_start: self
This signal is raised when the widget starts to load a page asincronously.
--- net_stop: self
This signal is raised when the widget has finished to load a page asincronously.
--- new_window: self, ?, ?
The current page has requested to open a new window... don't know if this is supported right now.
--- visibility: self, visibility
If The widget wants to show/hide itself.
visibility: true or false
--- destroy_browser: self
The document has requested to be closed. This usually should close the current window.
--- open_uri: self, uri
This signal il raised just before the widget starts to load a new page.
If you return true than the loading of the uri will NOT be permitted.
uri: the requested page
+
+ == Flags
+
+ === ChromeFlags
+
+ --- Gtk::MozEmbed::DEFAULTCHROME
+ --- Gtk::MozEmbed::WINDOWBORDERSON
+ --- Gtk::MozEmbed::WINDOWCLOSEON
+ --- Gtk::MozEmbed::WINDOWRESIZEON,
+ --- Gtk::MozEmbed::MENUBARON
+ --- Gtk::MozEmbed::TOOLBARON,
+ --- Gtk::MozEmbed::LOCATIONBARON
+ --- Gtk::MozEmbed::STATUSBARON,
+ --- Gtk::MozEmbed::PERSONALTOOLBARON
+ --- Gtk::MozEmbed::SCROLLBARSON,
+ --- Gtk::MozEmbed::TITLEBARON
+ --- Gtk::MozEmbed::EXTRACHROMEON,
+ --- Gtk::MozEmbed::WINDOWRAISED
+ --- Gtk::MozEmbed::WINDOWLOWERED,
+ --- Gtk::MozEmbed::CENTERSCREEN
+ --- Gtk::MozEmbed::DEPENDENT,
+ --- Gtk::MozEmbed::MODAL
+ --- Gtk::MozEmbed::OPENASDIALOG,
+ --- Gtk::MozEmbed::OPENASCHROME
+ --- Gtk::MozEmbed::ALLCHROME
+
+ === ReloadFlags
+
+ --- Gtk::MozEmbed::RELOADNORMAL
+ --- Gtk::MozEmbed::RELOADBYPASSCACHE
+ --- Gtk::MozEmbed::RELOADBYPASSPROXY
+ --- Gtk::MozEmbed::RELOADBYPASSPROXYANDCACHE
== See Also
((<Gtk>)), http://www.mozilla.org/unix/gtk-embedding.html.
- ((<MirkoMaischberger>))