[ruby-gnome2-doc-cvs] [Hiki] create - Gtk::MozEmbed

Back to archive index

ruby-****@sourc***** ruby-****@sourc*****
2005年 2月 20日 (日) 04:09:26 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).  
    * 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.

== See Also
((<Gtk>)). http://www.mozilla.org/unix/gtk-embedding.html

- ((<MirkoMaischberger>))





ruby-gnome2-cvs メーリングリストの案内
Back to archive index