mirror of
https://github.com/Ryujinx/GtkSharp.git
synced 2024-12-26 17:55:41 +00:00
2187 lines
82 KiB
XML
2187 lines
82 KiB
XML
<Type Name="HTML" FullName="Gtk.HTML">
|
|
<TypeSignature Language="C#" Maintainer="Miguel de Icaza" Value="public class HTML : Gtk.Layout" />
|
|
<AssemblyInfo>
|
|
<AssemblyName>gtkhtml-sharp</AssemblyName>
|
|
<AssemblyPublicKey>
|
|
</AssemblyPublicKey>
|
|
<AssemblyVersion>2.8.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
|
|
<Docs>
|
|
<summary>Lightweight HTML rendering widget.</summary>
|
|
<remarks>
|
|
<para>
|
|
<see cref="T:Gtk.HTML" /> is a lightweight HTML rendering widget, as well as as
|
|
simple graphical HTML editor.
|
|
</para>
|
|
<para>
|
|
Developers can also use it as a widget container (<see cref="T:Gtk.Container" />). It is an easy way for viewing HTML
|
|
documents in your application and for layout UI of your
|
|
application throught HTML.
|
|
</para>
|
|
<para>
|
|
<see cref="T:Gtk.HTML" /> does not have support for CSS or JavaScript.
|
|
</para>
|
|
<para>
|
|
The following sample is a very minimal web browser.
|
|
</para>
|
|
<para>
|
|
<example>
|
|
<code lang="C#">
|
|
using System;
|
|
using System.Net;
|
|
using System.IO;
|
|
using Gtk;
|
|
|
|
namespace HtmlTest
|
|
{
|
|
class HtmlTest
|
|
{
|
|
HTML html;
|
|
Entry entry;
|
|
string currentUrl;
|
|
|
|
static void Main (string[] args)
|
|
{
|
|
new HtmlTest();
|
|
}
|
|
|
|
HtmlTest()
|
|
{
|
|
Application.Init ();
|
|
|
|
Window win = new Window ("HtmlTest");
|
|
win.SetDefaultSize (800, 600);
|
|
win.DeleteEvent += new DeleteEventHandler (OnWindowDelete);
|
|
|
|
VBox vbox = new VBox (false, 1);
|
|
win.Add (vbox);
|
|
|
|
HBox hbox = new HBox (false, 1);
|
|
|
|
Label label = new Label ("Address:");
|
|
|
|
entry = new Entry ("");
|
|
entry.Activated += new EventHandler (OnEntryActivated);
|
|
|
|
Button button = new Button ("Go!");
|
|
button.Clicked += new EventHandler (OnButtonClicked);
|
|
|
|
hbox.PackStart (label, false, false, 1);
|
|
hbox.PackStart (entry, true, true, 1);
|
|
hbox.PackStart (button, false, false, 1);
|
|
|
|
vbox.PackStart (hbox, false, false, 1);
|
|
|
|
ScrolledWindow sw = new ScrolledWindow ();
|
|
sw.VscrollbarPolicy = PolicyType.Always;
|
|
sw.HscrollbarPolicy = PolicyType.Always;
|
|
vbox.PackStart(sw, true, true, 1);
|
|
|
|
html = new HTML ();
|
|
html.LinkClicked += new LinkClickedHandler (OnLinkClicked);
|
|
sw.Add (html);
|
|
|
|
win.ShowAll();
|
|
Application.Run ();
|
|
|
|
}
|
|
|
|
void OnWindowDelete (object obj, DeleteEventArgs args)
|
|
{
|
|
Application.Quit();
|
|
}
|
|
|
|
void OnButtonClicked (object obj, EventArgs args)
|
|
{
|
|
currentUrl = entry.Text.Trim();
|
|
LoadHtml (currentUrl);
|
|
}
|
|
|
|
void OnEntryActivated (object obj, EventArgs args)
|
|
{
|
|
OnButtonClicked (obj, args);
|
|
}
|
|
|
|
void OnLinkClicked (object obj, LinkClickedArgs args)
|
|
{
|
|
string newUrl;
|
|
|
|
// decide absolute or relative
|
|
if (args.Url.StartsWith("http://"))
|
|
newUrl = args.Url;
|
|
else
|
|
newUrl = currentUrl + args.Url;
|
|
|
|
try {
|
|
LoadHtml (newUrl);
|
|
} catch { }
|
|
currentUrl = newUrl;
|
|
}
|
|
|
|
void LoadHtml (string URL)
|
|
{
|
|
HttpWebRequest web_request = (HttpWebRequest) WebRequest.Create (URL);
|
|
HttpWebResponse web_response = (HttpWebResponse) web_request.GetResponse ();
|
|
Stream stream = web_response.GetResponseStream ();
|
|
byte [] buffer = new byte [8192];
|
|
|
|
HTMLStream html_stream = html.Begin ();
|
|
int count;
|
|
|
|
while ((count = stream.Read (buffer, 0, 8192)) != 0){
|
|
html_stream.Write (buffer, count);
|
|
}
|
|
html.End (html_stream, HTMLStreamStatus.Ok);
|
|
}
|
|
}
|
|
}
|
|
</code>
|
|
</example>
|
|
</para>
|
|
</remarks>
|
|
</Docs>
|
|
<Base>
|
|
<BaseTypeName>Gtk.Layout</BaseTypeName>
|
|
</Base>
|
|
<Interfaces>
|
|
</Interfaces>
|
|
<Members>
|
|
<Member MemberName="Construct">
|
|
<MemberSignature Language="C#" Value="public static void Construct (Gtk.Widget html);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="html" Type="Gtk.Widget" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Constructs an instance of a Gtk.HTML widget</summary>
|
|
<param name="html">A <see cref="T:Gtk.HTML" /> derivative object.</param>
|
|
<remarks>This is a low-level routine, and should only be used
|
|
to initialize an instance of a <see cref="T:Gtk.HTML" /> derivative class.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="GetObjectById">
|
|
<MemberSignature Language="C#" Value="public IntPtr GetObjectById (string id);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.IntPtr</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="id" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Locates an object whose id is provided</summary>
|
|
<param name="id">The id assigned to an object in the HTML stream</param>
|
|
<returns>An IntPtr to the internal HTMLObject</returns>
|
|
<remarks />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Export">
|
|
<MemberSignature Language="C#" Value="public bool Export (string type, Gtk.HTMLSaveReceiverFn receiver);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="type" Type="System.String" />
|
|
<Parameter Name="receiver" Type="Gtk.HTMLSaveReceiverFn" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Sends HTML out from the widget.</summary>
|
|
<param name="type">a <see cref="T:System.String" />, a content type.</param>
|
|
<param name="receiver">an object of type <see cref="T:Gtk.HTMLSaveReceiverFn" /></param>
|
|
<returns>a <see cref="T:System.Boolean" />, true if the export happened successfully, false if otherwise.</returns>
|
|
<remarks />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Copy">
|
|
<MemberSignature Language="C#" Value="public void Copy ();" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Copies the selection to the clipboard.</summary>
|
|
<remarks>Copies the selection into the clipboard.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="SelectWord">
|
|
<MemberSignature Language="C#" Value="public void SelectWord ();" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Selects the word under the cursor.</summary>
|
|
<remarks>This routine selects the word under the cursor.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="ToggleFontStyle">
|
|
<MemberSignature Language="C#" Value="public void ToggleFontStyle (Gtk.HTMLFontStyle style);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="style" Type="Gtk.HTMLFontStyle" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Changes the font style by adjusting flags from bold to regular or vice-versa. For a full list of possible flags, see <see cref="T:Gtk.HTMLFontStyle" />. </summary>
|
|
<param name="style">a <see cref="T:Gtk.HTMLFontStyle" /></param>
|
|
<remarks />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="SelectParagraph">
|
|
<MemberSignature Language="C#" Value="public void SelectParagraph ();" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Selects a paragraph.</summary>
|
|
<remarks>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="ZoomReset">
|
|
<MemberSignature Language="C#" Value="public void ZoomReset ();" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Resets the magnification of the text to 100% (normal).</summary>
|
|
<remarks />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Write">
|
|
<MemberSignature Language="C#" Value="public void Write (Gtk.HTMLStream handle, string buffer, ulong size);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="handle" Type="Gtk.HTMLStream" />
|
|
<Parameter Name="buffer" Type="System.String" />
|
|
<Parameter Name="size" Type="System.UInt64" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Writes <paramref name="size" /> bytes of content from <paramref name="buffer" /> to <paramref name="handle" />.</summary>
|
|
<param name="handle">a <see cref="T:Gtk.HTMLStream" /></param>
|
|
<param name="buffer">a <see cref="T:System.String" /></param>
|
|
<param name="size">a <see cref="T:System.UInt64" /></param>
|
|
<remarks />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Undo">
|
|
<MemberSignature Language="C#" Value="public void Undo ();" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Undoes the last operation.</summary>
|
|
<remarks>If the widget is Editable, this undoes the last operation.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Cut">
|
|
<MemberSignature Language="C#" Value="public void Cut ();" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Cuts the selection into the clipboard.</summary>
|
|
<remarks>If the widget is editable, this cuts the selection
|
|
into the clipboard; Otherwise it just copies the selection
|
|
into the clipboard.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="GetUrlBaseRelative">
|
|
<MemberSignature Language="C#" Value="public string GetUrlBaseRelative (string url);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.String</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="url" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Computes url from widget base url.</summary>
|
|
<param name="url">The new component of the url.</param>
|
|
<returns>The new base-relative url.</returns>
|
|
<remarks />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="UpdateStyles">
|
|
<MemberSignature Language="C#" Value="public void UpdateStyles ();" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>This method is designed to be called after the style, indentation, or other font attributes of an editable HTML widget have changed.</summary>
|
|
<remarks>When this is called, it will trigger the emission of signals for paragraphs whose indentation or style has changed.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Begin">
|
|
<MemberSignature Language="C#" Value="public Gtk.HTMLStream Begin ();" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gtk.HTMLStream</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Starts incremental content updating.</summary>
|
|
<returns>A <see cref="T:Gtk.HTMLStream" /> handle to push content.</returns>
|
|
<remarks>
|
|
<para>
|
|
Use the Begin method to push new HTML content into the
|
|
widget. The content type is expected to be in the format
|
|
defined by <see cref="P:Gtk.HTML.DefaultContentType" />,
|
|
which by default is "html/text; charset=utf-8".
|
|
</para>
|
|
<example>
|
|
<code lang="C#">
|
|
using System;
|
|
using Gtk;
|
|
|
|
class X {
|
|
|
|
static void Main ()
|
|
{
|
|
Application.Init ();
|
|
Window w = new Window ("Sample");
|
|
HTML html = new HTML ();
|
|
w.Add (html);
|
|
w.ShowAll ();
|
|
|
|
HTMLStream s = html.Begin ();
|
|
string line;
|
|
|
|
while ((line = Console.ReadLine ()) != null)
|
|
s.Write (line);
|
|
html.End (s, HTMLStreamStatus.Ok);
|
|
Application.Run ();
|
|
}
|
|
}
|
|
|
|
</code>
|
|
</example>
|
|
<para>
|
|
Compile and run:
|
|
</para>
|
|
<para>
|
|
mcs sample.cs -pkg:gtkhtml-sharp
|
|
</para>
|
|
<para>
|
|
echo "<html>
|
|
<body>Hello <b>World</b></body>
|
|
</html>" | mono sample.exe
|
|
</para>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="ImagesRef">
|
|
<MemberSignature Language="C#" Value="public void ImagesRef ();" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Sets up internal references to all images.</summary>
|
|
<remarks>FIXME: verify this.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Paste">
|
|
<MemberSignature Language="C#" Value="public void Paste (bool as_cite);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="as_cite" Type="System.Boolean" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Paste clipboard contents into editor</summary>
|
|
<param name="as_cite">Whether to paste as a citation.</param>
|
|
<remarks>
|
|
If the widget is in editing mode (see <see cref="P:Gtk.HTML.Editable" />), the contents of the clipboard
|
|
are pasted into the HTML editor. If the value of <paramref name="as_cite" /> is true, then the contents are pasted
|
|
as a citation.
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="LoadEmpty">
|
|
<MemberSignature Language="C#" Value="public void LoadEmpty ();" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Set up an empty <see cref="T:Gtk.HTML" /> widget.</summary>
|
|
<remarks />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="End">
|
|
<MemberSignature Language="C#" Value="public void End (Gtk.HTMLStream handle, Gtk.HTMLStreamStatus status);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="handle" Type="Gtk.HTMLStream" />
|
|
<Parameter Name="status" Type="Gtk.HTMLStreamStatus" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Ends incremental updating</summary>
|
|
<param name="handle">The <see cref="T:Gtk.HTMLStream" /> to close.</param>
|
|
<param name="status">The <see cref="T:Gtk.HTMLStreamStatus" /> representing the state of the stream when closed.</param>
|
|
<remarks>
|
|
<para>
|
|
Closes the <see cref="Gtk.HTMLStream" /> represented
|
|
by <paramref name="stream" /> and notifies the HTML widget that
|
|
it should not expect any more content from that stream.
|
|
</para>
|
|
<example>
|
|
<code lang="C#">
|
|
using System;
|
|
using Gtk;
|
|
|
|
class X {
|
|
|
|
static void Main ()
|
|
{
|
|
Application.Init ();
|
|
Window w = new Window ("Sample");
|
|
HTML html = new HTML ();
|
|
w.Add (html);
|
|
w.ShowAll ();
|
|
|
|
HTMLStream s = html.Begin ();
|
|
string line;
|
|
|
|
while ((line = Console.ReadLine ()) != null)
|
|
s.Write (line);
|
|
html.End (s, HTMLStreamStatus.Ok);
|
|
Application.Run ();
|
|
}
|
|
}
|
|
|
|
</code>
|
|
</example>
|
|
<para>
|
|
Compile and run:
|
|
</para>
|
|
<para>
|
|
mcs sample.cs -pkg:gtkhtml-sharp
|
|
</para>
|
|
<para>
|
|
echo "<html>
|
|
<body>Hello <b>World</b></body>
|
|
</html>" | mono sample.exe
|
|
</para>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Redo">
|
|
<MemberSignature Language="C#" Value="public void Redo ();" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Redoes the last Undone operation</summary>
|
|
<remarks>If the widget is editable, this redoes the last
|
|
undone operation.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="AppendHtml">
|
|
<MemberSignature Language="C#" Value="public void AppendHtml (string html_src);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="html_src" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Adds HTML to the end of the HTML currently being rendered by the widget.</summary>
|
|
<param name="html_src">an object of type <see cref="T:System.String" /></param>
|
|
<remarks />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="SelectLine">
|
|
<MemberSignature Language="C#" Value="public void SelectLine ();" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Selects the line the cursor is currently on.</summary>
|
|
<remarks />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="IndentPopLevel">
|
|
<MemberSignature Language="C#" Value="public void IndentPopLevel ();" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Removes an indent level.</summary>
|
|
<remarks />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="SelectAll">
|
|
<MemberSignature Language="C#" Value="public void SelectAll ();" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Selects all the contents.</summary>
|
|
<remarks>Selects all of the contents of the HTML widget.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Begin">
|
|
<MemberSignature Language="C#" Value="public Gtk.HTMLStream Begin (string target_frame, string content_type, Gtk.HTMLBeginFlags flags);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gtk.HTMLStream</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="target_frame" Type="System.String" />
|
|
<Parameter Name="content_type" Type="System.String" />
|
|
<Parameter Name="flags" Type="Gtk.HTMLBeginFlags" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Begins processing HTML.</summary>
|
|
<param name="target_frame">an object of type <see cref="T:System.String" /></param>
|
|
<param name="content_type">an object of type <see cref="T:System.String" /></param>
|
|
<param name="flags">an object of type <see cref="T:Gtk.HTMLBeginFlags" /></param>
|
|
<returns>an object of type <see cref="T:Gtk.HTMLStream" /></returns>
|
|
<remarks />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="EnableDebug">
|
|
<MemberSignature Language="C#" Value="public void EnableDebug (bool debug);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="debug" Type="System.Boolean" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Enables or disables debugging features.</summary>
|
|
<param name="debug">an object of type <see cref="T:System.Boolean" />, true for enabled, false for disabled</param>
|
|
<remarks />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="EditMakeCursorVisible">
|
|
<MemberSignature Language="C#" Value="public bool EditMakeCursorVisible ();" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Makes the edit cursor visible.</summary>
|
|
<returns>a <see cref="T:System.Boolean" />, true if the operation was a success.</returns>
|
|
<remarks />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="SetEditorApi">
|
|
<MemberSignature Language="C#" Value="public void SetEditorApi (Gtk.HTMLEditorAPI api, IntPtr data);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="api" Type="Gtk.HTMLEditorAPI" />
|
|
<Parameter Name="data" Type="System.IntPtr" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Unsupported in Gtk#. Installs hooks for the editor.</summary>
|
|
<param name="api">an object of type <see cref="T:Gtk.HTMLEditorAPI" /></param>
|
|
<param name="data">an object of type <see cref="T:System.IntPtr" /></param>
|
|
<remarks>This API is currently not supported.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="InsertGtkHtml">
|
|
<MemberSignature Language="C#" Value="public void InsertGtkHtml (Gtk.HTML to_be_destroyed);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="to_be_destroyed" Type="Gtk.HTML" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>To be added.</summary>
|
|
<param name="to_be_destroyed">an object of type <see cref="T:Gtk.HTML" /></param>
|
|
<remarks />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="ZoomIn">
|
|
<MemberSignature Language="C#" Value="public void ZoomIn ();" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Zooms in.</summary>
|
|
<remarks>Zooms in the view.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="InsertHtml">
|
|
<MemberSignature Language="C#" Value="public void InsertHtml (string html_src);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="html_src" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Inserts HTML into the existing HTML of the widget.</summary>
|
|
<param name="html_src">an object of type <see cref="T:System.String" /></param>
|
|
<remarks />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="SetFontStyle">
|
|
<MemberSignature Language="C#" Value="public void SetFontStyle (Gtk.HTMLFontStyle and_mask, Gtk.HTMLFontStyle or_mask);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="and_mask" Type="Gtk.HTMLFontStyle" />
|
|
<Parameter Name="or_mask" Type="Gtk.HTMLFontStyle" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Sets the font style for the widget.</summary>
|
|
<param name="and_mask">an object of type <see cref="T:Gtk.HTMLFontStyle" /></param>
|
|
<param name="or_mask">an object of type <see cref="T:Gtk.HTMLFontStyle" /></param>
|
|
<remarks />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="ImageUnref">
|
|
<MemberSignature Language="C#" Value="public void ImageUnref (string url);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="url" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Unrefs an image.</summary>
|
|
<param name="url">an object of type <see cref="T:System.String" /></param>
|
|
<remarks>(TODO: explain refcounting for images.)</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="ImageRef">
|
|
<MemberSignature Language="C#" Value="public void ImageRef (string url);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="url" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Refs an image.</summary>
|
|
<param name="url">an object of type <see cref="T:System.String" /></param>
|
|
<remarks />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="JumpToAnchor">
|
|
<MemberSignature Language="C#" Value="public bool JumpToAnchor (string anchor);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="anchor" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Jumps to an anchor by name, making it visible.</summary>
|
|
<param name="anchor">The anchor to locate.</param>
|
|
<returns>
|
|
<see langword="true" /> if the anchor is found.</returns>
|
|
<remarks>Scroll the document display to show the HTML anchor requested.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="ImagePreload">
|
|
<MemberSignature Language="C#" Value="public void ImagePreload (string url);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="url" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Preloads the image at the URL <paramref name="url" /></summary>
|
|
<param name="url">a <see cref="T:System.String" />, an image URL.</param>
|
|
<remarks />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="RequestPaste">
|
|
<MemberSignature Language="C#" Value="public int RequestPaste (Gdk.Atom selection, int type, int time, bool as_cite);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Int32</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="selection" Type="Gdk.Atom" />
|
|
<Parameter Name="type" Type="System.Int32" />
|
|
<Parameter Name="time" Type="System.Int32" />
|
|
<Parameter Name="as_cite" Type="System.Boolean" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>To be added</summary>
|
|
<param name="selection">an object of type <see cref="T:Gdk.Atom" /></param>
|
|
<param name="type">an object of type <see cref="T:System.Int32" /></param>
|
|
<param name="time">an object of type <see cref="T:System.Int32" /></param>
|
|
<param name="as_cite">an object of type <see cref="T:System.Boolean" /></param>
|
|
<returns>an object of type <see cref="T:System.Int32" /></returns>
|
|
<remarks />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="ImagesUnref">
|
|
<MemberSignature Language="C#" Value="public void ImagesUnref ();" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Unrefs images.</summary>
|
|
<remarks />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Save">
|
|
<MemberSignature Language="C#" Value="public bool Save (Gtk.HTMLSaveReceiverFn receiver);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="receiver" Type="Gtk.HTMLSaveReceiverFn" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Invokes a delegate function to save the HTML.</summary>
|
|
<param name="receiver">a <see cref="T:Gtk.HTMLSaveReceiverFn" /></param>
|
|
<returns>an object of type <see cref="T:System.Boolean" />, whether the operation succeeded.</returns>
|
|
<remarks />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Begin">
|
|
<MemberSignature Language="C#" Value="public Gtk.HTMLStream Begin (string content_type);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gtk.HTMLStream</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="content_type" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Starts incremental content updating. With a specific
|
|
content type.</summary>
|
|
<param name="content_type">The content type for the data to be
|
|
streamed.</param>
|
|
<returns>A <see cref="T:Gtk.HTMLStream" /> handle to push content.</returns>
|
|
<remarks>
|
|
<para>
|
|
Use the Begin method to push new HTML content into the
|
|
widget. The content type has to be specified (like this
|
|
for example: "html/text; charset=utf-8").
|
|
</para>
|
|
<example>
|
|
<code lang="C#">
|
|
using System;
|
|
using Gtk;
|
|
|
|
class X {
|
|
|
|
static void Main ()
|
|
{
|
|
Application.Init ();
|
|
Window w = new Window ("Sample");
|
|
HTML html = new HTML ();
|
|
w.Add (html);
|
|
w.ShowAll ();
|
|
|
|
HTMLStream s = html.Begin ("text/html; charset=utf-8");
|
|
string line;
|
|
|
|
while ((line = Console.ReadLine ()) != null)
|
|
s.Write (line);
|
|
html.End (s, HTMLStreamStatus.Ok);
|
|
Application.Run ();
|
|
}
|
|
}
|
|
|
|
</code>
|
|
</example>
|
|
<para>
|
|
Compile and run:
|
|
</para>
|
|
<para>
|
|
mcs sample.cs -pkg:gtkhtml-sharp
|
|
</para>
|
|
<para>
|
|
echo "<html>
|
|
<body>Hello <b>World</b></body>
|
|
</html>" | mono sample.exe
|
|
</para>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="AllowSelection">
|
|
<MemberSignature Language="C#" Value="public void AllowSelection (bool allow);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="allow" Type="System.Boolean" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Set whether selection is allowed in this widget.</summary>
|
|
<param name="allow">an object of type <see cref="T:System.Boolean" />, true if selection is allowed.</param>
|
|
<remarks />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="DropUndo">
|
|
<MemberSignature Language="C#" Value="public void DropUndo ();" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Drops all the undo information.</summary>
|
|
<remarks>Drops all the Undo and Redo information from the widget.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="SelectParagraphExtended">
|
|
<MemberSignature Language="C#" Value="public void SelectParagraphExtended ();" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>To be added</summary>
|
|
<remarks />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="ZoomOut">
|
|
<MemberSignature Language="C#" Value="public void ZoomOut ();" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Zooms out.</summary>
|
|
<remarks>Zooms out the view.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Command">
|
|
<MemberSignature Language="C#" Value="public bool Command (string command_name);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="command_name" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Execute a command on the widget.</summary>
|
|
<param name="command_name">an object of type <see cref="T:System.String" />, one of the values named in <see cref="T:Gtk.HTMLCommandType" />.</param>
|
|
<returns>an object of type <see cref="T:System.Boolean" /> for whether the command succeeded.</returns>
|
|
<remarks />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public HTML (IntPtr raw);" />
|
|
<MemberType>Constructor</MemberType>
|
|
<ReturnValue />
|
|
<Parameters>
|
|
<Parameter Name="raw" Type="System.IntPtr" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Internal constructor</summary>
|
|
<param name="raw">Pointer to the C object.</param>
|
|
<remarks>
|
|
<para>This is an internal constructor, and should not be used by user code.</para>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public HTML ();" />
|
|
<MemberType>Constructor</MemberType>
|
|
<ReturnValue />
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Creates an empty <see cref="T:Gtk.HTML" /> widget.</summary>
|
|
<remarks>
|
|
<para>
|
|
It creates an empty <see cref="T:Gtk.HTML" /> widget. The
|
|
returned widget is empty, and defaults to not be editable.
|
|
</para>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Editable">
|
|
<MemberSignature Language="C#" Value="public bool Editable { set; get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Whether the contents can be edited.</summary>
|
|
<value>
|
|
<see langword="true" /> if the contents are editable,
|
|
<see langword="false" />otherwise. </value>
|
|
<remarks>
|
|
Whether this <see cref="T:Gtk.HTML" /> instance can be used as an HTML
|
|
editor. Note: <see cref="M:Gtk.HTML.Begin" /> must be called before this can be set = <see langword="true" />.
|
|
</remarks>
|
|
</Docs>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>GLib.Property(Name="editable")</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
</Member>
|
|
<Member MemberName="ParagraphIndentation">
|
|
<MemberSignature Language="C#" Value="public uint ParagraphIndentation { get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.UInt32</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>The indentation level of a paragraph.</summary>
|
|
<value>an object of type <see cref="T:System.UInt32" /></value>
|
|
<remarks />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Base">
|
|
<MemberSignature Language="C#" Value="public string Base { set; get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.String</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>The base URL of this document.</summary>
|
|
<value>an object of type <see cref="T:System.String" /></value>
|
|
<remarks />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Title">
|
|
<MemberSignature Language="C#" Value="public string Title { set; get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.String</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>The title of this HTML document.</summary>
|
|
<value>an object of type <see cref="T:System.String" /></value>
|
|
<remarks />
|
|
</Docs>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>GLib.Property(Name="title")</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
</Member>
|
|
<Member MemberName="DefaultContentType">
|
|
<MemberSignature Language="C#" Value="public string DefaultContentType { set; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.String</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>The default content type.</summary>
|
|
<value>an object of type <see cref="T:System.String" /></value>
|
|
<remarks />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="ParagraphStyle">
|
|
<MemberSignature Language="C#" Value="public Gtk.HTMLParagraphStyle ParagraphStyle { set; get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gtk.HTMLParagraphStyle</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>The style of a paragraph.</summary>
|
|
<value>an object of type <see cref="T:Gtk.HTMLParagraphStyle" /></value>
|
|
<remarks />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Blocking">
|
|
<MemberSignature Language="C#" Value="public bool Blocking { set; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>To be added</summary>
|
|
<value>an object of type <see cref="T:System.Boolean" /></value>
|
|
<remarks />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Magnification">
|
|
<MemberSignature Language="C#" Value="public double Magnification { set; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Double</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>The current widget magnification level.</summary>
|
|
<value>an object of type <see cref="T:System.Double" /></value>
|
|
<remarks />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="ParagraphAlignment">
|
|
<MemberSignature Language="C#" Value="public Gtk.HTMLParagraphAlignment ParagraphAlignment { set; get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gtk.HTMLParagraphAlignment</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>The alignment of text (right, left, center)</summary>
|
|
<value>an object of type <see cref="T:Gtk.HTMLParagraphAlignment" /></value>
|
|
<remarks />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="AllowFrameset">
|
|
<MemberSignature Language="C#" Value="public bool AllowFrameset { set; get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Whether to allow framesets in this widget.</summary>
|
|
<value>an object of type <see cref="T:System.Boolean" /></value>
|
|
<remarks />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="InsertionFontStyleChanged">
|
|
<MemberSignature Language="C#" Value="public event Gtk.InsertionFontStyleChangedHandler InsertionFontStyleChanged;" />
|
|
<MemberType>Event</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gtk.InsertionFontStyleChangedHandler</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Raised when the font style under the cursor is changed.</summary>
|
|
<remarks />
|
|
</Docs>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>GLib.Signal(CName="insertion_font_style_changed")</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
</Member>
|
|
<Member MemberName="TitleChanged">
|
|
<MemberSignature Language="C#" Value="public event Gtk.TitleChangedHandler TitleChanged;" />
|
|
<MemberType>Event</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gtk.TitleChangedHandler</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Occurs when the title changes in HTML</summary>
|
|
<remarks>
|
|
This event is raised when the HTML parser encounters the
|
|
<title> tag on the HTML stream. To get the title, use
|
|
the <see cref="P:Gtk.HTML.Title" /> property.
|
|
</remarks>
|
|
</Docs>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>GLib.Signal(CName="title_changed")</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
</Member>
|
|
<Member MemberName="SetBase">
|
|
<MemberSignature Language="C#" Value="public event Gtk.SetBaseHandler SetBase;" />
|
|
<MemberType>Event</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gtk.SetBaseHandler</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Raised when the base URL of the document is changed.</summary>
|
|
<remarks />
|
|
</Docs>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>GLib.Signal(CName="set_base")</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
</Member>
|
|
<Member MemberName="SizeChanged">
|
|
<MemberSignature Language="C#" Value="public event EventHandler SizeChanged;" />
|
|
<MemberType>Event</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.EventHandler</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Raised when the size of text is changed.</summary>
|
|
<remarks />
|
|
</Docs>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>GLib.Signal(CName="size_changed")</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
</Member>
|
|
<Member MemberName="CurrentParagraphStyleChanged">
|
|
<MemberSignature Language="C#" Value="public event Gtk.CurrentParagraphStyleChangedHandler CurrentParagraphStyleChanged;" />
|
|
<MemberType>Event</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gtk.CurrentParagraphStyleChangedHandler</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Raised when the text style of this paragraph is changed.</summary>
|
|
<remarks />
|
|
</Docs>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>GLib.Signal(CName="current_paragraph_style_changed")</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
</Member>
|
|
<Member MemberName="LoadDone">
|
|
<MemberSignature Language="C#" Value="public event EventHandler LoadDone;" />
|
|
<MemberType>Event</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.EventHandler</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Raised after a webpage is finished loading.</summary>
|
|
<remarks />
|
|
</Docs>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>GLib.Signal(CName="load_done")</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
</Member>
|
|
<Member MemberName="CursorMove">
|
|
<MemberSignature Language="C#" Value="public event Gtk.CursorMoveHandler CursorMove;" />
|
|
<MemberType>Event</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gtk.CursorMoveHandler</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Occurs when the cursor moves.</summary>
|
|
<remarks>
|
|
This event is raised when the widget is in editing mode and
|
|
the cursor has moved.
|
|
</remarks>
|
|
</Docs>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>GLib.Signal(CName="cursor_move")</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
</Member>
|
|
<Member MemberName="OnCommand">
|
|
<MemberSignature Language="C#" Value="public event Gtk.OnCommandHandler OnCommand;" />
|
|
<MemberType>Event</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gtk.OnCommandHandler</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Raised when a command is issued to the widget.</summary>
|
|
<remarks />
|
|
</Docs>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>GLib.Signal(CName="command")</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
</Member>
|
|
<Member MemberName="UrlRequested">
|
|
<MemberSignature Language="C#" Value="public event Gtk.UrlRequestedHandler UrlRequested;" />
|
|
<MemberType>Event</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gtk.UrlRequestedHandler</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Occurs when a url is Requested</summary>
|
|
<remarks>
|
|
<para>
|
|
This event is raised when an URL is requested (typically
|
|
an image).
|
|
</para>
|
|
<para>
|
|
The following example shows how a simple HTML source that
|
|
requests an image (hello.png). If the file is found, then
|
|
it will be streamed into the HTML widget. The model
|
|
allows for data to be delivered as it comes, and when the
|
|
data has all arrived, the End method can be invoked on the
|
|
html stream provided by the <see cref="P:Gtk.UrlRequestedArgs.Handle" />.
|
|
</para>
|
|
<example>
|
|
<code lang="C#">
|
|
using System;
|
|
using System.IO;
|
|
using Gtk;
|
|
|
|
class X {
|
|
|
|
static void Main ()
|
|
{
|
|
Application.Init ();
|
|
Window w = new Window ("Sample");
|
|
HTML html = new HTML ();
|
|
html.UrlRequested += new UrlRequestedHandler (LoadFromDisk);
|
|
w.Add (html);
|
|
w.ShowAll ();
|
|
|
|
HTMLStream s = html.Begin ();
|
|
s.Write ("<html><body>My image: <img src=\"hello.png\"></body></html>");
|
|
html.End (s, HTMLStreamStatus.Ok);
|
|
Application.Run ();
|
|
}
|
|
|
|
static void LoadFromDisk (object sender, UrlRequestedArgs args)
|
|
{
|
|
try {
|
|
FileStream s = File.OpenRead (args.Url);
|
|
byte [] buffer = new byte [8192];
|
|
int n;
|
|
|
|
while ((n = s.Read (buffer, 0, 8192)) != 0) {
|
|
args.Handle.Write (buffer, n);
|
|
}
|
|
args.Handle.Close (HTMLStreamStatus.Ok);
|
|
} catch {
|
|
// Ignore errors.
|
|
}
|
|
}
|
|
}
|
|
</code>
|
|
</example>
|
|
<para>
|
|
Make sure there is a "hello.png" file in your directory to
|
|
see it, otherwise the sample will show the "broken image
|
|
link" image.
|
|
</para>
|
|
<para>
|
|
mcs sample.cs -pkg:gtkhtml-sharp
|
|
</para>
|
|
<para>
|
|
mono sample.exe
|
|
</para>
|
|
</remarks>
|
|
</Docs>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>GLib.Signal(CName="url_requested")</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
</Member>
|
|
<Member MemberName="IframeCreated">
|
|
<MemberSignature Language="C#" Value="public event Gtk.IframeCreatedHandler IframeCreated;" />
|
|
<MemberType>Event</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gtk.IframeCreatedHandler</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Raised after an IFRAME is created.</summary>
|
|
<remarks />
|
|
</Docs>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>GLib.Signal(CName="iframe_created")</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
</Member>
|
|
<Member MemberName="Scroll">
|
|
<MemberSignature Language="C#" Value="public event Gtk.ScrollHandler Scroll;" />
|
|
<MemberType>Event</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gtk.ScrollHandler</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Raised when the widget is scrolled.</summary>
|
|
<remarks />
|
|
</Docs>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>GLib.Signal(CName="scroll")</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
</Member>
|
|
<Member MemberName="CurrentParagraphIndentationChanged">
|
|
<MemberSignature Language="C#" Value="public event Gtk.CurrentParagraphIndentationChangedHandler CurrentParagraphIndentationChanged;" />
|
|
<MemberType>Event</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gtk.CurrentParagraphIndentationChangedHandler</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Raised when the indent level of the current paragraph is changed.</summary>
|
|
<remarks />
|
|
</Docs>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>GLib.Signal(CName="current_paragraph_indentation_changed")</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
</Member>
|
|
<Member MemberName="CurrentParagraphAlignmentChanged">
|
|
<MemberSignature Language="C#" Value="public event Gtk.CurrentParagraphAlignmentChangedHandler CurrentParagraphAlignmentChanged;" />
|
|
<MemberType>Event</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gtk.CurrentParagraphAlignmentChangedHandler</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Raised when the alignment of the current paragraph is changed.</summary>
|
|
<remarks />
|
|
</Docs>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>GLib.Signal(CName="current_paragraph_alignment_changed")</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
</Member>
|
|
<Member MemberName="InsertionColorChanged">
|
|
<MemberSignature Language="C#" Value="public event Gtk.InsertionColorChangedHandler InsertionColorChanged;" />
|
|
<MemberType>Event</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gtk.InsertionColorChangedHandler</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Raised when the text color to insert is changed.</summary>
|
|
<remarks />
|
|
</Docs>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>GLib.Signal(CName="insertion_color_changed")</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
</Member>
|
|
<Member MemberName="LinkClicked">
|
|
<MemberSignature Language="C#" Value="public event Gtk.LinkClickedHandler LinkClicked;" />
|
|
<MemberType>Event</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gtk.LinkClickedHandler</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Occurs when the user clicks on a hyperlink</summary>
|
|
<remarks>
|
|
<para>
|
|
This event is raised when the user clicks on a hyperlink
|
|
in the HTML widget.
|
|
</para>
|
|
<example>
|
|
<code lang="C#">
|
|
using System;
|
|
using System.IO;
|
|
using Gtk;
|
|
|
|
class X {
|
|
|
|
static void Main ()
|
|
{
|
|
Application.Init ();
|
|
Window w = new Window ("Sample");
|
|
HTML html = new HTML ("<html><body>Click <a href=\"http://www.go-mono.com\">me</a>");
|
|
html.LinkClicked += new LinkClickedHandler (OnLinkClicked);
|
|
w.Add (html);
|
|
w.ShowAll ();
|
|
Application.Run ();
|
|
}
|
|
|
|
static void OnLinkClicked (object o, LinkClickedArgs args)
|
|
{
|
|
Console.WriteLine ("The link clicked url is: " + args.Url);
|
|
}
|
|
}
|
|
</code>
|
|
</example>
|
|
<para>
|
|
mcs sample.cs -pkg:gtkhtml-sharp
|
|
</para>
|
|
<para>
|
|
mono sample.exe
|
|
</para>
|
|
<para>
|
|
Click on the "me" link to see the message on the console.
|
|
</para>
|
|
</remarks>
|
|
</Docs>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>GLib.Signal(CName="link_clicked")</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
</Member>
|
|
<Member MemberName="Submit">
|
|
<MemberSignature Language="C#" Value="public event Gtk.SubmitHandler Submit;" />
|
|
<MemberType>Event</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gtk.SubmitHandler</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Raised when a form submit button is clicked.</summary>
|
|
<remarks />
|
|
</Docs>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>GLib.Signal(CName="submit")</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
</Member>
|
|
<Member MemberName="Redirect">
|
|
<MemberSignature Language="C#" Value="public event Gtk.RedirectHandler Redirect;" />
|
|
<MemberType>Event</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gtk.RedirectHandler</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Raised when an HTTP redirect is received.</summary>
|
|
<remarks />
|
|
</Docs>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>GLib.Signal(CName="redirect")</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
</Member>
|
|
<Member MemberName="OnUrl">
|
|
<MemberSignature Language="C#" Value="public event Gtk.OnUrlHandler OnUrl;" />
|
|
<MemberType>Event</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gtk.OnUrlHandler</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Occurs when the user hovers over a hyper-link.</summary>
|
|
<remarks>
|
|
<para>
|
|
This event is raised when the mouse pointer hovers over a
|
|
hyper link or leaves a link. In the former case the value
|
|
of <see cref="P:Gtk.OnUrlHandler.Url" /> is the link
|
|
target, and in the later the empty string.
|
|
</para>
|
|
<example>
|
|
<code lang="C#">
|
|
using System;
|
|
using System.IO;
|
|
using Gtk;
|
|
|
|
class X {
|
|
|
|
static void Main ()
|
|
{
|
|
Application.Init ();
|
|
Window w = new Window ("Sample");
|
|
HTML html = new HTML ("<html><body>Click <a href=\"http://www.go-mono.com\">me</a>");
|
|
html.OnUrl += new OnUrlHandler (OnUrl);
|
|
w.Add (html);
|
|
w.ShowAll ();
|
|
Application.Run ();
|
|
}
|
|
|
|
static void OnUrl (object o, OnUrlArgs args)
|
|
{
|
|
Console.WriteLine ("The mouse is over: " + args.Url);
|
|
}
|
|
}
|
|
</code>
|
|
</example>
|
|
<para>
|
|
mcs sample.cs -pkg:gtkhtml-sharp
|
|
</para>
|
|
<para>
|
|
mono sample.exe
|
|
</para>
|
|
<para>
|
|
Hover in and out of the link to see the effects on the console.
|
|
</para>
|
|
</remarks>
|
|
</Docs>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>GLib.Signal(CName="on_url")</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
</Member>
|
|
<Member MemberName="SetBaseTarget">
|
|
<MemberSignature Language="C#" Value="public event Gtk.SetBaseTargetHandler SetBaseTarget;" />
|
|
<MemberType>Event</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gtk.SetBaseTargetHandler</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Raised when the base URL target is changed.</summary>
|
|
<remarks />
|
|
</Docs>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>GLib.Signal(CName="set_base_target")</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
</Member>
|
|
<Member MemberName="LoadFromString">
|
|
<MemberSignature Language="C#" Value="public void LoadFromString (string str);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="str" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Load a string into the HTML viewing widget.</summary>
|
|
<param name="str">The string to load.</param>
|
|
<remarks />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public HTML (string Astr);" />
|
|
<MemberType>Constructor</MemberType>
|
|
<ReturnValue />
|
|
<Parameters>
|
|
<Parameter Name="Astr" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>A constructor.</summary>
|
|
<param name="Astr">an object of type <see cref="T:System.String" />(FIXME: check this)</param>
|
|
<remarks />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="DocumentBase">
|
|
<MemberSignature Language="C#" Value="public string DocumentBase { set; get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.String</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>The base URL of the document.</summary>
|
|
<value>A <see cref="T:System.String" /> containing the URL.</value>
|
|
<remarks />
|
|
</Docs>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>GLib.Property(Name="document_base")</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
</Member>
|
|
<Member MemberName="TargetBase">
|
|
<MemberSignature Language="C#" Value="public string TargetBase { set; get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.String</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>To be added</summary>
|
|
<value>an object of type <see cref="T:System.String" /></value>
|
|
<remarks />
|
|
</Docs>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>GLib.Property(Name="target_base")</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
</Member>
|
|
<Member MemberName="MagicLinks">
|
|
<MemberSignature Language="C#" Value="public bool MagicLinks { set; get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Whether magic links (auto-recognizing URLs and making them clickable) is activated.</summary>
|
|
<value>a <see cref="T:System.Boolean" /></value>
|
|
<remarks />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="MagicSmileys">
|
|
<MemberSignature Language="C#" Value="public bool MagicSmileys { set; get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Whether magic smileys (automatically recognizing smileys and turning them into small graphics) is activated.</summary>
|
|
<value>a <see cref="T:System.Boolean" /></value>
|
|
<remarks />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Animate">
|
|
<MemberSignature Language="C#" Value="public bool Animate { set; get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>To be added</summary>
|
|
<value>a <see cref="T:System.Boolean" /></value>
|
|
<remarks />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="InlineSpelling">
|
|
<MemberSignature Language="C#" Value="public bool InlineSpelling { set; get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Whether or not to check spelling inline by indicating misspelled words.</summary>
|
|
<value>a <see cref="T:System.Boolean" /></value>
|
|
<remarks />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="PrintWithHeaderFooter">
|
|
<MemberSignature Language="C#" Value="public void PrintWithHeaderFooter (Gnome.PrintContext print_context, double header_height, double footer_height, Gtk.HTMLPrintCallback header_print, Gtk.HTMLPrintCallback footer_print);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="print_context" Type="Gnome.PrintContext" />
|
|
<Parameter Name="header_height" Type="System.Double" />
|
|
<Parameter Name="footer_height" Type="System.Double" />
|
|
<Parameter Name="header_print" Type="Gtk.HTMLPrintCallback" />
|
|
<Parameter Name="footer_print" Type="Gtk.HTMLPrintCallback" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Adds a header and footer to the HTML and prints it using <paramref name="print_context" />.</summary>
|
|
<param name="print_context">a <see cref="T:Gnome.PrintContext" /></param>
|
|
<param name="header_height">a <see cref="T:System.Double" /></param>
|
|
<param name="footer_height">a <see cref="T:System.Double" /></param>
|
|
<param name="header_print">a <see cref="T:Gtk.HTMLPrintCallback" />, a header generation routine</param>
|
|
<param name="footer_print">a <see cref="T:Gtk.HTMLPrintCallback" />, a footer generation routine</param>
|
|
<remarks />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="PrintSetMaster">
|
|
<MemberSignature Language="C#" Value="public void PrintSetMaster (Gnome.PrintJob print_master);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="print_master" Type="Gnome.PrintJob" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>To be added</summary>
|
|
<param name="print_master">a <see cref="T:Gnome.PrintJob" /></param>
|
|
<remarks />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Print">
|
|
<MemberSignature Language="C#" Value="public void Print (Gnome.PrintContext print_context);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="print_context" Type="Gnome.PrintContext" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Prints this document using <paramref name="print_context" />.</summary>
|
|
<param name="print_context">a <see cref="T:Gnome.PrintContext" /></param>
|
|
<remarks />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="PrintGetPagesNum">
|
|
<MemberSignature Language="C#" Value="public int PrintGetPagesNum (Gnome.PrintContext print_context, double header_height, double footer_height);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Int32</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="print_context" Type="Gnome.PrintContext" />
|
|
<Parameter Name="header_height" Type="System.Double" />
|
|
<Parameter Name="footer_height" Type="System.Double" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Gets the number of pages this HTML would print to given a context <paramref name="print_context" /> with the given header and footer heights.</summary>
|
|
<param name="print_context">a <see cref="T:Gnome.PrintContext" /></param>
|
|
<param name="header_height">a <see cref="T:System.Double" /></param>
|
|
<param name="footer_height">a <see cref="T:System.Double" /></param>
|
|
<returns>a <see cref="T:System.Int32" /></returns>
|
|
<remarks />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="ObjectRequested">
|
|
<MemberSignature Language="C#" Value="public event Gtk.ObjectRequestedHandler ObjectRequested;" />
|
|
<MemberType>Event</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gtk.ObjectRequestedHandler</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>To be added</summary>
|
|
<remarks />
|
|
</Docs>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>GLib.Signal(CName="object_requested")</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
</Member>
|
|
<Member MemberName="HasUndo">
|
|
<MemberSignature Language="C#" Value="public bool HasUndo { get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Whether the widget has an Undo option or not.</summary>
|
|
<value>a <see cref="T:System.Boolean" /></value>
|
|
<remarks />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="GType">
|
|
<MemberSignature Language="C#" Value="public static GLib.GType GType { get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>GLib.GType</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>GType Property.</summary>
|
|
<value>a <see cref="T:GLib.GType" /></value>
|
|
<remarks>Returns the native <see cref="T:GLib.GType" /> value for <see cref="T:Gtk.HTML" />.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="OnSetBaseTarget">
|
|
<MemberSignature Language="C#" Value="protected virtual void OnSetBaseTarget (string base_url);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="base_url" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Default handler for the <see cref="M:Gtk.HTML.SetBaseTarget" /> event.</summary>
|
|
<param name="base_url">a <see cref="T:System.String" /></param>
|
|
<remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Gtk.HTML.SetBaseTarget" /> event.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="OnObjectRequested">
|
|
<MemberSignature Language="C#" Value="protected virtual bool OnObjectRequested (Gtk.HTMLEmbedded arg2);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="arg2" Type="Gtk.HTMLEmbedded" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Default handler for the <see cref="M:Gtk.HTML.ObjectRequested" /> event.</summary>
|
|
<param name="arg2">a <see cref="T:Gtk.HTMLEmbedded" /></param>
|
|
<returns>a <see cref="T:System.Boolean" /></returns>
|
|
<remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Gtk.HTML.ObjectRequested" /> event.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="OnOnUrl">
|
|
<MemberSignature Language="C#" Value="protected virtual void OnOnUrl (string url);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="url" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Default handler for the <see cref="M:Gtk.HTML.OnUrl" /> event.</summary>
|
|
<param name="url">a <see cref="T:System.String" /></param>
|
|
<remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Gtk.HTML.OnUrl" /> event.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="OnRedirect">
|
|
<MemberSignature Language="C#" Value="protected virtual void OnRedirect (string url, int delay);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="url" Type="System.String" />
|
|
<Parameter Name="delay" Type="System.Int32" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Default handler for the <see cref="M:Gtk.HTML.Redirect" /> event.</summary>
|
|
<param name="url">a <see cref="T:System.String" /></param>
|
|
<param name="delay">a <see cref="T:System.Int32" /></param>
|
|
<remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Gtk.HTML.Redirect" /> event.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="OnSubmit">
|
|
<MemberSignature Language="C#" Value="protected virtual void OnSubmit (string method, string url, string encoding);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="method" Type="System.String" />
|
|
<Parameter Name="url" Type="System.String" />
|
|
<Parameter Name="encoding" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Default handler for the <see cref="M:Gtk.HTML.Submit" /> event.</summary>
|
|
<param name="method">a <see cref="T:System.String" /></param>
|
|
<param name="url">a <see cref="T:System.String" /></param>
|
|
<param name="encoding">a <see cref="T:System.String" /></param>
|
|
<remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Gtk.HTML.Submit" /> event.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="OnLinkClicked">
|
|
<MemberSignature Language="C#" Value="protected virtual void OnLinkClicked (string url);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="url" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Default handler for the <see cref="M:Gtk.HTML.LinkClicked" /> event.</summary>
|
|
<param name="url">a <see cref="T:System.String" /></param>
|
|
<remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Gtk.HTML.LinkClicked" /> event.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="OnInsertionColorChanged">
|
|
<MemberSignature Language="C#" Value="protected virtual void OnInsertionColorChanged (Gdk.Color color);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="color" Type="Gdk.Color" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Default handler for the <see cref="M:Gtk.HTML.InsertionColorChanged" /> event.</summary>
|
|
<param name="color">a <see cref="T:Gdk.Color" /></param>
|
|
<remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Gtk.HTML.InsertionColorChanged" /> event.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="OnCurrentParagraphAlignmentChanged">
|
|
<MemberSignature Language="C#" Value="protected virtual void OnCurrentParagraphAlignmentChanged (Gtk.HTMLParagraphAlignment new_alignment);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="new_alignment" Type="Gtk.HTMLParagraphAlignment" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Default handler for the <see cref="M:Gtk.HTML.CurrentParagraphAlignmentChanged" /> event.</summary>
|
|
<param name="new_alignment">a <see cref="T:Gtk.HTMLParagraphAlignment" /></param>
|
|
<remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Gtk.HTML.CurrentParagraphAlignmentChanged" /> event.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="OnCurrentParagraphIndentationChanged">
|
|
<MemberSignature Language="C#" Value="protected virtual void OnCurrentParagraphIndentationChanged (uint new_indentation);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="new_indentation" Type="System.UInt32" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Default handler for the <see cref="M:Gtk.HTML.CurrentParagraphIndentationChanged" /> event.</summary>
|
|
<param name="new_indentation">a <see cref="T:System.UInt32" /></param>
|
|
<remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Gtk.HTML.CurrentParagraphIndentationChanged" /> event.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="OnScroll">
|
|
<MemberSignature Language="C#" Value="protected virtual void OnScroll (Gtk.Orientation orientation, Gtk.ScrollType scroll_type, float position);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="orientation" Type="Gtk.Orientation" />
|
|
<Parameter Name="scroll_type" Type="Gtk.ScrollType" />
|
|
<Parameter Name="position" Type="System.Single" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Default handler for the <see cref="M:Gtk.HTML.Scroll" /> event.</summary>
|
|
<param name="orientation">a <see cref="T:Gtk.Orientation" /></param>
|
|
<param name="scroll_type">a <see cref="T:Gtk.ScrollType" /></param>
|
|
<param name="position">a <see cref="T:System.Single" /></param>
|
|
<remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Gtk.HTML.Scroll" /> event.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="OnIframeCreated">
|
|
<MemberSignature Language="C#" Value="protected virtual void OnIframeCreated (Gtk.HTML iframe);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="iframe" Type="Gtk.HTML" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Default handler for the <see cref="M:Gtk.HTML.IframeCreated" /> event.</summary>
|
|
<param name="iframe">a <see cref="T:Gtk.HTML" /></param>
|
|
<remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Gtk.HTML.IframeCreated" /> event.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="OnOnCommand">
|
|
<MemberSignature Language="C#" Value="protected virtual bool OnOnCommand (Gtk.HTMLCommandType com_type);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="com_type" Type="Gtk.HTMLCommandType" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Default handler for the <see cref="M:Gtk.HTML.OnCommand" /> event.</summary>
|
|
<param name="com_type">a <see cref="T:Gtk.HTMLCommandType" /></param>
|
|
<returns>a <see cref="T:System.Boolean" /></returns>
|
|
<remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Gtk.HTML.OnCommand" /> event.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="OnCursorMove">
|
|
<MemberSignature Language="C#" Value="protected virtual void OnCursorMove (Gtk.DirectionType dir_type, Gtk.HTMLCursorSkipType skip);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="dir_type" Type="Gtk.DirectionType" />
|
|
<Parameter Name="skip" Type="Gtk.HTMLCursorSkipType" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Default handler for the <see cref="M:Gtk.HTML.CursorMove" /> event.</summary>
|
|
<param name="dir_type">a <see cref="T:Gtk.DirectionType" /></param>
|
|
<param name="skip">a <see cref="T:Gtk.HTMLCursorSkipType" /></param>
|
|
<remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Gtk.HTML.CursorMove" /> event.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="OnLoadDone">
|
|
<MemberSignature Language="C#" Value="protected virtual void OnLoadDone ();" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Default handler for the <see cref="M:Gtk.HTML.LoadDone" /> event.</summary>
|
|
<remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Gtk.HTML.LoadDone" /> event.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="OnCurrentParagraphStyleChanged">
|
|
<MemberSignature Language="C#" Value="protected virtual void OnCurrentParagraphStyleChanged (Gtk.HTMLParagraphStyle new_style);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="new_style" Type="Gtk.HTMLParagraphStyle" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Default handler for the <see cref="M:Gtk.HTML.CurrentParagraphStyleChanged" /> event.</summary>
|
|
<param name="new_style">a <see cref="T:Gtk.HTMLParagraphStyle" /></param>
|
|
<remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Gtk.HTML.CurrentParagraphStyleChanged" /> event.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="OnSizeChanged">
|
|
<MemberSignature Language="C#" Value="protected virtual void OnSizeChanged ();" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Default handler for the <see cref="M:Gtk.HTML.SizeChanged" /> event.</summary>
|
|
<remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Gtk.HTML.SizeChanged" /> event.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="OnSetBase">
|
|
<MemberSignature Language="C#" Value="protected virtual void OnSetBase (string base_url);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="base_url" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Default handler for the <see cref="M:Gtk.HTML.SetBase" /> event.</summary>
|
|
<param name="base_url">a <see cref="T:System.String" /></param>
|
|
<remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Gtk.HTML.SetBase" /> event.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="OnTitleChanged">
|
|
<MemberSignature Language="C#" Value="protected virtual void OnTitleChanged (string new_title);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="new_title" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Default handler for the <see cref="M:Gtk.HTML.TitleChanged" /> event.</summary>
|
|
<param name="new_title">a <see cref="T:System.String" /></param>
|
|
<remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Gtk.HTML.TitleChanged" /> event.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="OnInsertionFontStyleChanged">
|
|
<MemberSignature Language="C#" Value="protected virtual void OnInsertionFontStyleChanged (Gtk.HTMLFontStyle style);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="style" Type="Gtk.HTMLFontStyle" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Default handler for the <see cref="M:Gtk.HTML.InsertionFontStyleChanged" /> event.</summary>
|
|
<param name="style">a <see cref="T:Gtk.HTMLFontStyle" /></param>
|
|
<remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Gtk.HTML.InsertionFontStyleChanged" /> event.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="protected HTML (GLib.GType gtype);" />
|
|
<MemberType>Constructor</MemberType>
|
|
<ReturnValue />
|
|
<Parameters>
|
|
<Parameter Name="gtype" Type="GLib.GType" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Protected Constructor.</summary>
|
|
<param name="gtype">a <see cref="T:GLib.GType" /></param>
|
|
<remarks>Chain to this constructor if you have manually registered a native <see cref="T:GLib.GType" /> value for your subclass.</remarks>
|
|
</Docs>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>System.Obsolete(Message=null, IsError=False)</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
</Member>
|
|
<Member MemberName="Indent">
|
|
<MemberSignature Language="C#" Value="public IntPtr Indent { set; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.IntPtr</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>Sets the indentation level for the widget.</summary>
|
|
<value>a <see cref="T:System.IntPtr" /></value>
|
|
<remarks />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="OnUrlRequested">
|
|
<MemberSignature Language="C#" Value="protected virtual void OnUrlRequested (string url, Gtk.HTMLStream handle);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="url" Type="System.String" />
|
|
<Parameter Name="handle" Type="Gtk.HTMLStream" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Default handler for the <see cref="M:Gtk.HTML.UrlRequested" /> event.</summary>
|
|
<param name="url">a <see cref="T:System.String" /></param>
|
|
<param name="handle">a <see cref="T:Gtk.HTMLStream" /></param>
|
|
<remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Gtk.HTML.UrlRequested" /> event.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Write">
|
|
<MemberSignature Language="C#" Value="public void Write (Gtk.HTMLStream handle, string buffer, int size);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="handle" Type="Gtk.HTMLStream" />
|
|
<Parameter Name="buffer" Type="System.String" />
|
|
<Parameter Name="size" Type="System.Int32" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Writes <paramref name="size" /> bytes of content from <paramref name="buffer" /> to <paramref name="handle" />.</summary>
|
|
<param name="handle">a <see cref="T:Gtk.HTMLStream" /></param>
|
|
<param name="buffer">a <see cref="T:System.String" /></param>
|
|
<param name="size">a <see cref="T:System.Int32" /></param>
|
|
<remarks>Use the overload with ulong size for 64 bit deployments. </remarks>
|
|
</Docs>
|
|
</Member>
|
|
</Members>
|
|
</Type>
|