[openvrml-commit] openvrml/doc openvrml-xembed.texi,1.2,1.3

[Braden M. <br...@us...>]

Update of /cvsroot/openvrml/openvrml/doc
In directory sc8-pr-cvs3.sourceforge.net:/tmp/cvs-serv4802/doc

Modified Files:
	openvrml-xembed.texi 
Log Message:

Changes to facilitate setting openvrml-player's location entry after
the world has been loaded.

Significantly, access to the GIOChannel used by the GtkVrmlBrowser
(i.e., the request channel) needed to be made thread-safe.
Accordingly, all access to the request channel now goes through the
function openvrml_xembed::write_request_chars.


Index: openvrml-xembed.texi
===================================================================
RCS file: /cvsroot/openvrml/openvrml/doc/openvrml-xembed.texi,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -d -r1.2 -r1.3
*** openvrml-xembed.texi	5 Feb 2007 05:36:11 -0000	1.2
--- openvrml-xembed.texi	2 Sep 2007 18:27:55 -0000	1.3
***************
*** 262,269 ****
  command; so it should be issued as soon as possible.
  
  @section Commands
  
  @cindex load-url
! @subsection @code{load-url}
  
  The @code{load-url} command initiates loading of a VRML or X3D world.
--- 262,321 ----
  command; so it should be issued as soon as possible.
  
+ @cindex browser-event
+ @section The @code{browser-event} Request
+ 
+ @code{openvrml-xembed} sends a @code{browser-event} request
+ corresponding to @code{openvrml::browser_event}s for each listener the
+ host application has registered with an
+ @code{add-browser-event-listener} command.  This request takes the
+ following form:
+ 
+ @example
+ browser-event @var{listener-id} @var{event}
+ @end example
+ 
+ @table @var
+ @item listener-id
+ An integer identifer corresponding to that used with the
+ @code{add-browser-event-listener} command.
+ 
+ @item event
+ An integer identifier for a browser event.  These correspond to
+ @code{openvrml::browser_event::type_id}; i.e.:
+ 
+ @multitable @columnfractions .2 .8
+ @headitem event @tab @code{openvrml::browser_event::type_id}
+ @item 1
+ @tab @code{openvrml::browser_event::initialized}
+ @item 2
+ @tab @code{openvrml::browser_event::shutdown}
+ @end multitable
+ @end table
+ 
+ @cindex world-url
+ @section The @code{world-url} Request
+ 
+ @code{world-url} is sent in response to a @code{get-world-url} command
+ from the host application.
+ 
+ The @code{world-url} request isn't semantically a request; however, it
+ falls under this heading since it is sent from @code{openvrml-xembed}
+ to the host application via the request channel.
+ 
+ The @code{world-url} request takes the following form:
+ 
+ @example
+ world-url @var{url}
+ @end example
+ 
+ @table @var
+ @item url
+ The URL for the currently loaded world.
+ @end table
+ 
  @section Commands
  
  @cindex load-url
! @subsection The @code{load-url} Command
  
  The @code{load-url} command initiates loading of a VRML or X3D world.
***************
*** 281,285 ****
  
  @cindex get-url-result
! @subsection @code{get-url-result}
  
  The @code{get-url-result} command should be sent immediately in
--- 333,337 ----
  
  @cindex get-url-result
! @subsection The @code{get-url-result} Command
  
  The @code{get-url-result} command should be sent immediately in
***************
*** 309,313 ****
  
  @cindex new-stream
! @subsection @code{new-stream}
  
  The @code{new-stream} command indicates to @code{openvrml-xembed}
--- 361,365 ----
  
  @cindex new-stream
! @subsection The @code{new-stream} Command
  
  The @code{new-stream} command indicates to @code{openvrml-xembed}
***************
*** 341,345 ****
  
  @cindex write
! @subsection @code{write}
  
  The @code{write} command writes data to a stream for which
--- 393,397 ----
  
  @cindex write
! @subsection The @code{write} Command
  
  The @code{write} command writes data to a stream for which
***************
*** 375,379 ****
  
  @cindex destroy-stream
! @subsection @code{destroy-stream}
  
  @code{destroy-stream} should be sent for a @var{stream-id} after no
--- 427,431 ----
  
  @cindex destroy-stream
! @subsection The @code{destroy-stream} Command
  
  @code{destroy-stream} should be sent for a @var{stream-id} after no
***************
*** 394,397 ****
--- 446,495 ----
  already been sent.
  
+ @cindex add-browser-event-listener
+ @subsection The @code{add-browser-event-listener} Command
+ 
+ A listener for browser events can be registered with
+ @code{add-browser-event-listener}.  These events correspond to those
+ represented by the @code{openvrml::browser_event} class.  This command
+ takes the following form:
+ 
+ @example
+ add-browser-event-listener @var{listener-id}
+ @end example
+ 
+ @table @var
+ @item listener-id
+ An integer identifier for a listener.
+ @end table
+ 
+ @cindex remove-browser-event-listener
+ @subsection The @code{remove-browser-event-listener} Command
+ 
+ @code{remove-browser-event-listener} removes a listener that was
+ previously added with @code{add-browser-event-listener}.  The command
+ takes the form:
+ 
+ @example
+ remove-browser-event-listener @var{listener-id}
+ @end example
+ 
+ @table @var
+ @item listener-id
+ The integer identifier of a listener previously added with
+ @code{add-browser-event-listener}.
+ @end table
+ 
+ @cindex get-world-url
+ @subsection The @code{get-world-url} Command
+ 
+ Get the URL of the currently-loaded world.  The XEmbed control
+ responds to this command by sending @code{world-url} via the request
+ channel.  This command takes no arguments:
+ 
+ @example
+ get-world-url
+ @end example
+ 
+ 
  @node Problems
  @chapter Getting Help and Reporting Bugs