aboutsummaryrefslogblamecommitdiffstats
path: root/doc/reference/tmpl/ephy-embed-single.sgml
blob: e49aa628b73c45bdb99c882d7a0d6e85e9419338 (plain) (tree)
1
2
3
4
5
6
7
8
                                  
               

                                              
                                           


                                             



                                                                               
       
      



                                                                    
 
                             
 




                                                                      
      


                                                                               

       
                                     



       


                                            




                                                           
         

 




                                                                
         

 







                                                           
       
           
          

 
<!-- ##### SECTION Title ##### -->
EphyEmbedSingle

<!-- ##### SECTION Short_Description ##### -->
An interface to the global embedded browser

<!-- ##### SECTION Long_Description ##### -->
<para>
While Epiphany is running, its global embed_shell variable (an #EphyEmbedShell)
holds a reference to an #EphyEmbedSingle. The only class which implements
#EphyEmbedSingle is #MozillaEmbedSingle, so the two types are interchangeable
via casting.
</para>
<para>
<example>
<title>Acquiring an <structname>EphyEmbedSingle</structname></title>
<programlisting>#<![CDATA[include <ephy-embed-shell.h>]]>
#<![CDATA[include <ephy-embed-single.h>

EphyEmbedSingle *ephy_single;

/* embed_shell is a global variable, initialized as Epiphany starts */
ephy_single = ephy_embed_shell_get_embed_single (embed_shell);
]]></programlisting>
</example>
</para>
<para>
Since there is only one #EphyEmbedShell, there is only one #EphyEmbedSingle. It
is used to perform browser-related actions which do not refer to an individual
#EphyEmbed.
</para>

<!-- ##### SECTION See_Also ##### -->
<para>

</para>

<!-- ##### SECTION Stability_Level ##### -->


<!-- ##### FUNCTION ephy_embed_single_clear_cache ##### -->
<para>

</para>

@single: 


<!-- ##### FUNCTION ephy_embed_single_clear_auth_cache ##### -->
<para>

</para>

@single: 


<!-- ##### FUNCTION ephy_embed_single_open_window ##### -->
<para>

</para>

@single: 
@parent: 
@address: 
@name: 
@features: 
@Returns: