1347 lines
62 KiB
XML
1347 lines
62 KiB
XML
<?xml version="1.0"?>
|
|
<doc>
|
|
<assembly>
|
|
<name>Gallio.Common.Splash</name>
|
|
</assembly>
|
|
<members>
|
|
<member name="T:Gallio.Common.Splash.DisposableCookie">
|
|
<summary>
|
|
Invokes a delegate when disposed.
|
|
</summary>
|
|
<remarks>
|
|
<para>
|
|
This type is useful for creating APIs that leverage the C# "using" syntax for scoping.
|
|
</para>
|
|
<example>
|
|
<code>
|
|
using (document.BeginStyle(Style.Default)) // returns a DisposableCookie
|
|
{
|
|
document.AppendText("Hello world");
|
|
}
|
|
</code>
|
|
</example>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:Gallio.Common.Splash.DisposableCookie.#ctor(Gallio.Common.Splash.DisposableCookie.Action)">
|
|
<summary>
|
|
Creates a disposable cookie.
|
|
</summary>
|
|
<param name="action">The action to perform when <see cref="M:Gallio.Common.Splash.DisposableCookie.Dispose"/> is called.</param>
|
|
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="action"/> is null.</exception>
|
|
</member>
|
|
<member name="M:Gallio.Common.Splash.DisposableCookie.Dispose">
|
|
<summary>
|
|
Invokes the dispose action.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Gallio.Common.Splash.DisposableCookie.Action">
|
|
<summary>
|
|
Specifies the action to perform when <see cref="M:Gallio.Common.Splash.DisposableCookie.Dispose"/> is called.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Gallio.Common.Splash.EmbeddedImage">
|
|
<summary>
|
|
An embedded image wraps an <see cref="P:Gallio.Common.Splash.EmbeddedImage.Image"/> so that it can be embedded in
|
|
a Splash document.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Gallio.Common.Splash.EmbeddedObject">
|
|
<summary>
|
|
An embedded object that can be drawn into a <see cref="T:Gallio.Common.Splash.SplashView"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Gallio.Common.Splash.EmbeddedObject.CreateClient(Gallio.Common.Splash.IEmbeddedObjectSite)">
|
|
<summary>
|
|
Creates an instance of an embedded object client attached to the specified site.
|
|
</summary>
|
|
<param name="site">The site.</param>
|
|
<returns>The client.</returns>
|
|
</member>
|
|
<member name="M:Gallio.Common.Splash.EmbeddedImage.#ctor(System.Drawing.Image)">
|
|
<summary>
|
|
Creates an embedded image.
|
|
</summary>
|
|
<param name="image">The image to draw into the client area.</param>
|
|
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="image"/> is null.</exception>
|
|
</member>
|
|
<member name="M:Gallio.Common.Splash.EmbeddedImage.CreateClient(Gallio.Common.Splash.IEmbeddedObjectSite)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:Gallio.Common.Splash.EmbeddedImage.Image">
|
|
<summary>
|
|
Gets the image.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Gallio.Common.Splash.EmbeddedImage.Margin">
|
|
<summary>
|
|
Gets or sets the margin around the image.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Gallio.Common.Splash.EmbeddedImage.Baseline">
|
|
<summary>
|
|
Gets or sets the baseline of the image.
|
|
</summary>
|
|
<remarks>
|
|
The default value is 0 which positions the bottom of the image in line with the
|
|
baseline of surrounding text. Use a positive value to raise the image above the
|
|
text baseline or a negative value to lower it below the text baseline.
|
|
</remarks>
|
|
</member>
|
|
<member name="T:Gallio.Common.Splash.IEmbeddedObjectClient">
|
|
<summary>
|
|
Represents an instance of an embedded object that has been attached to a particular site.
|
|
</summary>
|
|
<remarks>
|
|
<para>
|
|
When the client is disposed, it should release all attachments to its site.
|
|
</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:Gallio.Common.Splash.IEmbeddedObjectClient.Measure">
|
|
<summary>
|
|
Measure the client.
|
|
</summary>
|
|
<returns>The embedded object measurements.</returns>
|
|
</member>
|
|
<member name="M:Gallio.Common.Splash.IEmbeddedObjectClient.Show(System.Drawing.Rectangle,System.Boolean)">
|
|
<summary>
|
|
Shows the embedded object and sets its bounds.
|
|
</summary>
|
|
<param name="bounds">The bounds of the embedded object.</param>
|
|
<param name="rightToLeft">True if the current reading order is right to left.</param>
|
|
</member>
|
|
<member name="M:Gallio.Common.Splash.IEmbeddedObjectClient.Hide">
|
|
<summary>
|
|
Hides the embedded object.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Gallio.Common.Splash.IEmbeddedObjectClient.Paint(System.Drawing.Graphics,Gallio.Common.Splash.PaintOptions,System.Drawing.Rectangle,System.Boolean)">
|
|
<summary>
|
|
Paints the embedded object.
|
|
</summary>
|
|
<param name="g">The graphics context. Not null.</param>
|
|
<param name="paintOptions">The paint options. Not null.</param>
|
|
<param name="bounds">The bounds of the embedded object.</param>
|
|
<param name="rightToLeft">True if the current reading order is right to left.</param>
|
|
</member>
|
|
<member name="P:Gallio.Common.Splash.IEmbeddedObjectClient.RequiresPaint">
|
|
<summary>
|
|
Returns true if the <see cref="M:Gallio.Common.Splash.IEmbeddedObjectClient.Paint(System.Drawing.Graphics,Gallio.Common.Splash.PaintOptions,System.Drawing.Rectangle,System.Boolean)"/> method should be called or false if the
|
|
client paints itself by other means.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Gallio.Common.Splash.EmbeddedControl">
|
|
<summary>
|
|
An embedded image wraps a <see cref="P:Gallio.Common.Splash.EmbeddedControl.Control"/> so that it can be embedded in
|
|
a Splash document.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Gallio.Common.Splash.EmbeddedControl.#ctor(System.Windows.Forms.Control)">
|
|
<summary>
|
|
Creates an embedded control.
|
|
</summary>
|
|
<param name="control">The control to draw into the client area.</param>
|
|
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="control"/> is null.</exception>
|
|
</member>
|
|
<member name="M:Gallio.Common.Splash.EmbeddedControl.CreateClient(Gallio.Common.Splash.IEmbeddedObjectSite)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:Gallio.Common.Splash.EmbeddedControl.Control">
|
|
<summary>
|
|
Gets the control.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Gallio.Common.Splash.EmbeddedControl.Margin">
|
|
<summary>
|
|
Gets or sets the margin around the control.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Gallio.Common.Splash.EmbeddedControl.Baseline">
|
|
<summary>
|
|
Gets or sets the baseline of the control.
|
|
</summary>
|
|
<remarks>
|
|
The default value is 0 which positions the bottom of the control in line with the
|
|
baseline of surrounding text. Use a positive value to raise the control above the
|
|
text baseline or a negative value to lower it below the text baseline.
|
|
</remarks>
|
|
</member>
|
|
<member name="T:Gallio.Common.Splash.EmbeddedObjectMeasurements">
|
|
<summary>
|
|
Describes the measurements of an embedded object.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Gallio.Common.Splash.EmbeddedObjectMeasurements.#ctor(System.Drawing.Size)">
|
|
<summary>
|
|
Initializes the measurements.
|
|
</summary>
|
|
<param name="size">The size of the embedded object.</param>
|
|
</member>
|
|
<member name="P:Gallio.Common.Splash.EmbeddedObjectMeasurements.Size">
|
|
<summary>
|
|
Gets or sets the size of the embedded object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Gallio.Common.Splash.EmbeddedObjectMeasurements.Margin">
|
|
<summary>
|
|
Gets or sets the margin around the embedded object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Gallio.Common.Splash.EmbeddedObjectMeasurements.Descent">
|
|
<summary>
|
|
Gets or sets the descent height of the object in pixels.
|
|
</summary>
|
|
<remarks>
|
|
The descent is the number of pixels from the baseline of the object
|
|
to its bottom. It used to align the baseline of the object with the baseline
|
|
of the text that surrounds it on the line.
|
|
</remarks>
|
|
</member>
|
|
<member name="T:Gallio.Common.Splash.IEmbeddedObjectSite">
|
|
<summary>
|
|
Describes the environment of an embedded object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Gallio.Common.Splash.IEmbeddedObjectSite.CharIndex">
|
|
<summary>
|
|
Gets the index of the character that represents the embedded object
|
|
for selection and hit testing in the document.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Gallio.Common.Splash.IEmbeddedObjectSite.ParentControl">
|
|
<summary>
|
|
Gets the control of the containing view.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Gallio.Common.Splash.IEmbeddedObjectSite.ParagraphStyle">
|
|
<summary>
|
|
Gets the style of the paragraph that contains the embedded object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Gallio.Common.Splash.IEmbeddedObjectSite.InlineStyle">
|
|
<summary>
|
|
Gets the style of the inline run that contains the embedded object.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Gallio.Common.Splash.Internal.DeviceContext">
|
|
<summary>
|
|
A low-level wrapper for a graphics context.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Gallio.Common.Splash.Internal.EmbeddedObjectHost.LayoutBounds">
|
|
<summary>
|
|
Gets or sets the layout bounds relative to the layout origin.
|
|
This is set during the main layout operation and cached until relayout occurs.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Gallio.Common.Splash.Internal.Paragraph">
|
|
<summary>
|
|
Internal structure describing a paragraph in the document.
|
|
Each paragraph consists of a number of characters subdivided into runs that have
|
|
the same style or that represent embedded objects.
|
|
</summary>
|
|
<remarks>
|
|
Packed into 16 bytes per Paragraph. Keep it that way or make it smaller.
|
|
</remarks>
|
|
</member>
|
|
<member name="T:Gallio.Common.Splash.Internal.Run">
|
|
<summary>
|
|
Internal structure describing a run of text or an embedded object in the document.
|
|
</summary>
|
|
<remarks>
|
|
Packed into 4 bytes per Run. Keep it that way.
|
|
</remarks>
|
|
</member>
|
|
<member name="T:Gallio.Common.Splash.Internal.ScriptLine">
|
|
<summary>
|
|
Internal structure that maps a visual line onto a particular range of runs
|
|
within a paragraph and includes the character position of required line breaks.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Gallio.Common.Splash.Internal.ScriptLine.Y">
|
|
<summary>
|
|
The absolute vertical offset of the line in the document when rendered.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Gallio.Common.Splash.Internal.ScriptLine.X">
|
|
<summary>
|
|
The absolute horizontal offset of the line in the document when rendered.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Gallio.Common.Splash.Internal.ScriptLine.Height">
|
|
<summary>
|
|
The height of the line.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Gallio.Common.Splash.Internal.ScriptLine.Descent">
|
|
<summary>
|
|
The descent height of the line (below text baseline).
|
|
</summary>
|
|
</member>
|
|
<member name="F:Gallio.Common.Splash.Internal.ScriptLine.ParagraphIndex">
|
|
<summary>
|
|
The index of the paragraph that appears on the line.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Gallio.Common.Splash.Internal.ScriptLine.ScriptRunIndex">
|
|
<summary>
|
|
The index of the paragraph's first script run that appears on the line.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Gallio.Common.Splash.Internal.ScriptLine.ScriptRunCount">
|
|
<summary>
|
|
The number of script runs that appear on the line.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Gallio.Common.Splash.Internal.ScriptLine.TruncatedLeadingCharsCount">
|
|
<summary>
|
|
The number of leading chars in the first script run to truncate due to word wrap.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Gallio.Common.Splash.Internal.ScriptLine.TruncatedTrailingCharsCount">
|
|
<summary>
|
|
The number of trailing chars in the last script run to truncate due to word wrap.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Gallio.Common.Splash.Internal.ScriptLine.Ascent">
|
|
<summary>
|
|
The ascent height of the line (above text baseline).
|
|
</summary>
|
|
</member>
|
|
<member name="T:Gallio.Common.Splash.Internal.ScriptParagraph">
|
|
<summary>
|
|
Internal structure with script information necessary for layout and display of a paragraph.
|
|
Includes script information for each run in the paragraph.
|
|
</summary>
|
|
<remarks>
|
|
We pool allocated script paragraph structures and cache them to improve performance
|
|
and reduce the number of memory allocations.
|
|
</remarks>
|
|
</member>
|
|
<member name="T:Gallio.Common.Splash.Internal.ScriptRun">
|
|
<summary>
|
|
Internal structure with script information necessary for layout and display of a run.
|
|
A single run may be subdivided into multiple script runs.
|
|
</summary>
|
|
<remarks>
|
|
Since a script paragraph can contain many script runs and each one uses a variable amount
|
|
of storage for buffers of various kinds, this structure contains indices into shared
|
|
buffers managed by the containing script paragraph. This reduces the number of required
|
|
memory allocations per paragraph.
|
|
</remarks>
|
|
</member>
|
|
<member name="F:Gallio.Common.Splash.Internal.ScriptRun.ScriptAnalysis">
|
|
<summary>
|
|
The script analysis for the run produced during itemization.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Gallio.Common.Splash.Internal.ScriptRun.CharIndexInParagraph">
|
|
<summary>
|
|
The index of the first character of the run relative to the first character of its containing paragraph.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Gallio.Common.Splash.Internal.ScriptRun.GlyphIndexInParagraph">
|
|
<summary>
|
|
The index of the first glyph of the run relative to the first glyph of its containing paragraph.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Gallio.Common.Splash.Internal.ScriptRun.GlyphCount">
|
|
<summary>
|
|
The number of glyphs in the run.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Gallio.Common.Splash.Internal.ScriptRun.Height">
|
|
<summary>
|
|
The height of the run excluding its margins.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Gallio.Common.Splash.Internal.ScriptRun.Descent">
|
|
<summary>
|
|
The descent height of the run (below text baseline).
|
|
</summary>
|
|
</member>
|
|
<member name="F:Gallio.Common.Splash.Internal.ScriptRun.TopMargin">
|
|
<summary>
|
|
The top margin of the run.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Gallio.Common.Splash.Internal.ScriptRun.BottomMargin">
|
|
<summary>
|
|
The bottom margin of the run.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Gallio.Common.Splash.Internal.ScriptRun.ABC">
|
|
<summary>
|
|
The advance width spacing of the run.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Gallio.Common.Splash.Internal.ScriptRun.Ascent">
|
|
<summary>
|
|
The ascent height of the run (above text baseline).
|
|
</summary>
|
|
</member>
|
|
<member name="T:Gallio.Common.Splash.Key`1">
|
|
<summary>
|
|
A strongly-typed key to be used together with an associative array to help the
|
|
compiler perform better type checking of the value associated with the key.
|
|
</summary>
|
|
<typeparam name="TValue">The type of value associated with the key.</typeparam>
|
|
</member>
|
|
<member name="M:Gallio.Common.Splash.Key`1.#ctor(System.String)">
|
|
<summary>
|
|
Creates a new key.
|
|
</summary>
|
|
<param name="name">The unique name of the key.</param>
|
|
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="name"/> is null.</exception>
|
|
</member>
|
|
<member name="M:Gallio.Common.Splash.Key`1.ToString">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:Gallio.Common.Splash.Key`1.Name">
|
|
<summary>
|
|
Gets the unique name of the key.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Gallio.Common.Splash.PaintOptions">
|
|
<summary>
|
|
Provides style parameters for painting.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Gallio.Common.Splash.PaintOptions.#ctor">
|
|
<summary>
|
|
Initializes paint options to system defaults.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Gallio.Common.Splash.PaintOptions.BackgroundColor">
|
|
<summary>
|
|
Gets or sets the background color.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Gallio.Common.Splash.PaintOptions.SelectedTextColor">
|
|
<summary>
|
|
Gets or sets the selected text color.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Gallio.Common.Splash.PaintOptions.SelectedBackgroundColor">
|
|
<summary>
|
|
Gets or sets the selected background color.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Gallio.Common.Splash.ParagraphChangedEventArgs">
|
|
<summary>
|
|
Arguments for the event raised when a paragraph is changed.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Gallio.Common.Splash.ParagraphChangedEventArgs.#ctor(System.Int32)">
|
|
<summary>
|
|
Creates event arguments for paragraph changed.
|
|
</summary>
|
|
<param name="paragraphIndex">The index of the paragraph that was changed.</param>
|
|
</member>
|
|
<member name="P:Gallio.Common.Splash.ParagraphChangedEventArgs.ParagraphIndex">
|
|
<summary>
|
|
Gets the index of the paragraph that was changed.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Gallio.Common.Splash.PixelTabStopRuler">
|
|
<summary>
|
|
A tab stop ruler based on per-pixel offsets.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Gallio.Common.Splash.TabStopRuler">
|
|
<summary>
|
|
Describes the strategy for advancing to tab stops.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Gallio.Common.Splash.TabStopRuler.AdvanceToNextTabStop(System.Int32)">
|
|
<summary>
|
|
Advances the X position to the next tab stop.
|
|
</summary>
|
|
<param name="xPosition">The X position to advance.</param>
|
|
<returns>The advanced X position.</returns>
|
|
</member>
|
|
<member name="M:Gallio.Common.Splash.TabStopRuler.Equals(Gallio.Common.Splash.TabStopRuler)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:Gallio.Common.Splash.PixelTabStopRuler.#ctor(System.Int32,System.Int32)">
|
|
<summary>
|
|
Creates a tab stop ruler based on per-pixel offsets.
|
|
</summary>
|
|
<param name="pixelsPerTabStop">The number of pixels per tab stop, or 0 to always advance the minimum tab width.</param>
|
|
<param name="minimumTabWidth">The minimum tab width, or 0 if there is no minimum.</param>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">Thrown if <paramref name="pixelsPerTabStop"/> or
|
|
<paramref name="minimumTabWidth"/> is less than 0.</exception>
|
|
</member>
|
|
<member name="M:Gallio.Common.Splash.PixelTabStopRuler.AdvanceToNextTabStop(System.Int32)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:Gallio.Common.Splash.PixelTabStopRuler.Equals(System.Object)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:Gallio.Common.Splash.PixelTabStopRuler.Equals(Gallio.Common.Splash.TabStopRuler)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:Gallio.Common.Splash.PixelTabStopRuler.Equals(Gallio.Common.Splash.PixelTabStopRuler)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:Gallio.Common.Splash.PixelTabStopRuler.GetHashCode">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:Gallio.Common.Splash.PixelTabStopRuler.PixelsPerTabStop">
|
|
<summary>
|
|
Gets the number of pixels per tab stop, or 0 to always advance the minimum tab width.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Gallio.Common.Splash.PixelTabStopRuler.MinimumTabWidth">
|
|
<summary>
|
|
Gets the minimum tab width.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Gallio.Common.Splash.SnapPosition">
|
|
<summary>
|
|
Provides the result of mapping a screen position to a character index.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Gallio.Common.Splash.SnapPosition.#ctor(Gallio.Common.Splash.SnapKind,System.Int32)">
|
|
<summary>
|
|
Initializes a snap result.
|
|
</summary>
|
|
<param name="kind">The snap kind.</param>
|
|
<param name="charIndex">The character index of the snap, or -1 if no snap.</param>
|
|
</member>
|
|
<member name="P:Gallio.Common.Splash.SnapPosition.Kind">
|
|
<summary>
|
|
Gets the snap kind.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Gallio.Common.Splash.SnapPosition.CharIndex">
|
|
<summary>
|
|
Gets the character index of the snap, or -1 if no snap.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Gallio.Common.Splash.SnapKind">
|
|
<summary>
|
|
Describes the kind of snap.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Gallio.Common.Splash.SnapKind.None">
|
|
<summary>
|
|
The character snap did not succeed. The position was outside the bounds of the document.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Gallio.Common.Splash.SnapKind.Exact">
|
|
<summary>
|
|
The character snap was exact.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Gallio.Common.Splash.SnapKind.Leading">
|
|
<summary>
|
|
The character snap was before the actual character or at a position above
|
|
the start of the document. (eg. To the left of the character if the reading order is left-to-right.)
|
|
</summary>
|
|
</member>
|
|
<member name="F:Gallio.Common.Splash.SnapKind.Trailing">
|
|
<summary>
|
|
The character snap was after the actual character or at a position above
|
|
the start of the document. (eg. To the right of the character if the reading order is left-to-right.)
|
|
</summary>
|
|
</member>
|
|
<member name="T:Gallio.Common.Splash.SplashDocument">
|
|
<summary>
|
|
A splash document contains styled text and embedded objects and retains layout information
|
|
for presentation.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Gallio.Common.Splash.SplashDocument.ObjectRunPlaceholderChar">
|
|
<summary>
|
|
The character used as a placeholder for text itemizing when a paragraph contains an object run.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Gallio.Common.Splash.SplashDocument.MaxCharsPerRun">
|
|
<summary>
|
|
The maximum number of characters that a text run can contain.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Gallio.Common.Splash.SplashDocument.MaxObjects">
|
|
<summary>
|
|
The maximum number of distinct objects supported by the implementation.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Gallio.Common.Splash.SplashDocument.MaxStyles">
|
|
<summary>
|
|
The maximum number of distinct styles supported by the implementation.
|
|
</summary>
|
|
<value>256</value>
|
|
</member>
|
|
<member name="M:Gallio.Common.Splash.SplashDocument.#ctor">
|
|
<summary>
|
|
Creates an empty splash document.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Gallio.Common.Splash.SplashDocument.Clear">
|
|
<summary>
|
|
Clears the text in the document.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Gallio.Common.Splash.SplashDocument.GetTextRange(System.Int32,System.Int32)">
|
|
<summary>
|
|
Gets a range of the document text.
|
|
</summary>
|
|
<param name="start">The start character index.</param>
|
|
<param name="length">The length of the range.</param>
|
|
<returns>The text in the specified range.</returns>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">Thrown if <paramref name="start"/>
|
|
or <paramref name="length"/> are negative or refer to a range that exceeds the document length.</exception>
|
|
</member>
|
|
<member name="M:Gallio.Common.Splash.SplashDocument.GetStyleAtIndex(System.Int32)">
|
|
<summary>
|
|
Gets the style of the text at the specified character index.
|
|
</summary>
|
|
<param name="index">The character index.</param>
|
|
<returns>The style.</returns>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">Thrown if <paramref name="index"/> is
|
|
outside of the bounds of the document.</exception>
|
|
</member>
|
|
<member name="M:Gallio.Common.Splash.SplashDocument.GetObjectAtIndex(System.Int32)">
|
|
<summary>
|
|
Gets the embedded object at the specified character index, or null if none.
|
|
</summary>
|
|
<param name="index">The character index.</param>
|
|
<returns>The embedded object, or null if none.</returns>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">Thrown if <paramref name="index"/> is
|
|
outside of the bounds of the document.</exception>
|
|
</member>
|
|
<member name="M:Gallio.Common.Splash.SplashDocument.TryGetAnnotationAtIndex``1(Gallio.Common.Splash.Key{``0},System.Int32,``0@)">
|
|
<summary>
|
|
Gets the annotation with the specified key at the specified character index.
|
|
</summary>
|
|
<param name="key">The annotation key.</param>
|
|
<param name="index">The character index.</param>
|
|
<param name="value">Set to the annotation value, or default if none.</param>
|
|
<returns>True if an annotation was found.</returns>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">Thrown if <paramref name="index"/> is
|
|
outside of the bounds of the document.</exception>
|
|
</member>
|
|
<member name="M:Gallio.Common.Splash.SplashDocument.TryGetCurrentAnnotation``1(Gallio.Common.Splash.Key{``0},``0@)">
|
|
<summary>
|
|
Gets the current annotation with the specified key.
|
|
</summary>
|
|
<param name="key">The annotation key.</param>
|
|
<param name="value">Set to the annotation value, or default if none.</param>
|
|
<returns>True if there is a current annotation.</returns>
|
|
</member>
|
|
<member name="M:Gallio.Common.Splash.SplashDocument.AppendText(System.String)">
|
|
<summary>
|
|
Appends text to the document.
|
|
</summary>
|
|
<param name="text">The text to append.</param>
|
|
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="text"/> is null.</exception>
|
|
</member>
|
|
<member name="M:Gallio.Common.Splash.SplashDocument.AppendLine">
|
|
<summary>
|
|
Appends a new line to the document.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Gallio.Common.Splash.SplashDocument.AppendObject(Gallio.Common.Splash.EmbeddedObject)">
|
|
<summary>
|
|
Appends an object to the document.
|
|
</summary>
|
|
<param name="obj">The object to append.</param>
|
|
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="obj"/> is null.</exception>
|
|
</member>
|
|
<member name="M:Gallio.Common.Splash.SplashDocument.BeginStyle(Gallio.Common.Splash.Style)">
|
|
<summary>
|
|
Pushes a new style onto the style stack.
|
|
Subsequently appended content will use the new style.
|
|
</summary>
|
|
<example>
|
|
<code>
|
|
using (document.BeginStyle(linkStyle))
|
|
{
|
|
using (document.BeginAnnotation("href", "http://www.gallio.org"))
|
|
{
|
|
document.AppendText("Gallio");
|
|
}
|
|
}
|
|
</code>
|
|
</example>
|
|
<param name="style">The style to use.</param>
|
|
<returns>A value that when disposed automatically calls <see cref="M:Gallio.Common.Splash.SplashDocument.EndStyle"/>.
|
|
Used with the C# "using" syntax to end the style at the end of a block scope.</returns>
|
|
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="style"/> is null.</exception>
|
|
<exception cref="T:System.InvalidOperationException">Thrown if more than <see cref="F:Gallio.Common.Splash.SplashDocument.MaxStyles"/> distinct styles are used.</exception>
|
|
<seealso cref="M:Gallio.Common.Splash.SplashDocument.EndStyle"/>
|
|
</member>
|
|
<member name="M:Gallio.Common.Splash.SplashDocument.EndStyle">
|
|
<summary>
|
|
Pops the current style off the style stack.
|
|
Subsequently appended content will use the previous style.
|
|
</summary>
|
|
<exception cref="T:System.InvalidOperationException">Thrown if the style stack only contains the default style.</exception>
|
|
<seealso cref="M:Gallio.Common.Splash.SplashDocument.BeginStyle(Gallio.Common.Splash.Style)"/>
|
|
</member>
|
|
<member name="M:Gallio.Common.Splash.SplashDocument.BeginAnnotation``1(Gallio.Common.Splash.Key{``0},``0)">
|
|
<summary>
|
|
Pushes an annotation value onto the keyed annotation stack.
|
|
Subsequently appended content will acquire the new annotation value.
|
|
</summary>
|
|
<remarks>
|
|
<para>
|
|
Each annotation key has its own separate stack.
|
|
</para>
|
|
</remarks>
|
|
<example>
|
|
<code>
|
|
using (document.BeginStyle(linkStyle))
|
|
{
|
|
using (document.BeginAnnotation("href", "http://www.gallio.org"))
|
|
{
|
|
document.AppendText("Gallio");
|
|
}
|
|
}
|
|
</code>
|
|
</example>
|
|
<param name="key">The annotation key.</param>
|
|
<param name="value">The annotation value.</param>
|
|
<returns>A value that when disposed automatically calls <see cref="M:Gallio.Common.Splash.SplashDocument.EndAnnotation``1(Gallio.Common.Splash.Key{``0})"/>.
|
|
Used with the C# "using" syntax to end the annotation at the end of a block scope.</returns>
|
|
<seealso cref="M:Gallio.Common.Splash.SplashDocument.EndAnnotation``1(Gallio.Common.Splash.Key{``0})"/>
|
|
</member>
|
|
<member name="M:Gallio.Common.Splash.SplashDocument.EndAnnotation``1(Gallio.Common.Splash.Key{``0})">
|
|
<summary>
|
|
Pushes an annotation value onto the keyed annotation stack.
|
|
Subsequently appended content will acquire the new annotation value.
|
|
</summary>
|
|
<remarks>
|
|
<para>
|
|
Each annotation key has its own separate stack.
|
|
</para>
|
|
</remarks>
|
|
<param name="key">The annotation key.</param>
|
|
<exception cref="T:System.InvalidOperationException">Thrown if there is no current annotation with the
|
|
specified key.</exception>
|
|
<seealso cref="M:Gallio.Common.Splash.SplashDocument.BeginAnnotation``1(Gallio.Common.Splash.Key{``0},``0)"/>
|
|
</member>
|
|
<member name="M:Gallio.Common.Splash.SplashDocument.ToString">
|
|
<summary>
|
|
Returns the plain text content of the document as a string.
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="E:Gallio.Common.Splash.SplashDocument.DocumentCleared">
|
|
<summary>
|
|
Event raised when the document is cleared.
|
|
</summary>
|
|
</member>
|
|
<member name="E:Gallio.Common.Splash.SplashDocument.ParagraphChanged">
|
|
<summary>
|
|
Event raised when a paragraph is changed.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Gallio.Common.Splash.SplashDocument.ParagraphCount">
|
|
<summary>
|
|
Gets the number of paragraphs in the document.
|
|
</summary>
|
|
<remarks>
|
|
This number is guaranteed to always be at least 1 even in an empty document.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:Gallio.Common.Splash.SplashDocument.CharCount">
|
|
<summary>
|
|
Gets the number of characters in the document.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Gallio.Common.Splash.SplashDocument.CurrentStyle">
|
|
<summary>
|
|
Gets the current style.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Gallio.Common.Splash.Native.ABC.abcA">
|
|
<summary>
|
|
The A spacing of the character. The A spacing is the distance to add to the current position before drawing the character glyph.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Gallio.Common.Splash.Native.ABC.abcB">
|
|
<summary>
|
|
The B spacing of the character. The B spacing is the width of the drawn portion of the character glyph.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Gallio.Common.Splash.Native.ABC.abcC">
|
|
<summary>
|
|
The C spacing of the character. The C spacing is the distance to add to the current position to provide white space to the right of the character glyph.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Gallio.Common.Splash.SplashLayout">
|
|
<summary>
|
|
Describes the layout of a splash document.
|
|
</summary>
|
|
<remarks>
|
|
<para>
|
|
Much of this implementation is based on information from the amazing Neatpad tutorial by James Brown.
|
|
http://www.catch22.net/tuts/neatpad
|
|
</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:Gallio.Common.Splash.SplashLayout.#ctor(Gallio.Common.Splash.SplashDocument,System.Windows.Forms.Control)">
|
|
<summary>
|
|
Creates a layout for a document.
|
|
</summary>
|
|
<param name="document">The document.</param>
|
|
<param name="parentControl">The parent control to which embedded objects can
|
|
attach themselves.</param>
|
|
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="document"/>
|
|
or <paramref name="parentControl"/> is null.</exception>
|
|
</member>
|
|
<member name="M:Gallio.Common.Splash.SplashLayout.Dispose">
|
|
<summary>
|
|
Disposes the layout.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Gallio.Common.Splash.SplashLayout.Dispose(System.Boolean)">
|
|
<summary>
|
|
Disposes the layout.
|
|
</summary>
|
|
<param name="disposing">True if <see cref="M:Gallio.Common.Splash.SplashLayout.Dispose"/> was called explicitly.</param>
|
|
</member>
|
|
<member name="M:Gallio.Common.Splash.SplashLayout.Reset">
|
|
<summary>
|
|
Resets all layout information and frees internal buffers.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Gallio.Common.Splash.SplashLayout.Update(System.Drawing.Point)">
|
|
<summary>
|
|
Updates the layout.
|
|
</summary>
|
|
<remarks>
|
|
<para>
|
|
Call this method some time after UpdateRequired is raised or whenever the layout origin changes.
|
|
</para>
|
|
</remarks>
|
|
<param name="layoutOrigin">The origin of the document layout area in the parent control.</param>
|
|
</member>
|
|
<member name="M:Gallio.Common.Splash.SplashLayout.GetSnapPositionAtPoint(System.Drawing.Point,System.Drawing.Point)">
|
|
<summary>
|
|
Gets the snap position that corresponds to a point in the control.
|
|
</summary>
|
|
<param name="point">The point to check.</param>
|
|
<param name="layoutOrigin">The origin of the document layout area in the parent control.</param>
|
|
<returns>The character snap.</returns>
|
|
</member>
|
|
<member name="M:Gallio.Common.Splash.SplashLayout.Paint(System.Drawing.Graphics,System.Drawing.Point,System.Drawing.Rectangle,Gallio.Common.Splash.PaintOptions,System.Int32,System.Int32)">
|
|
<summary>
|
|
Paints a region of text.
|
|
</summary>
|
|
<remarks>
|
|
Be sure to update the layout before calling this method.
|
|
</remarks>
|
|
<param name="graphics">The graphics context.</param>
|
|
<param name="layoutOrigin">The origin of the document layout area in the parent control.</param>
|
|
<param name="clipRect">The clip rectangle of the region to paint in the device context.</param>
|
|
<param name="paintOptions">The paint options.</param>
|
|
<param name="selectedCharIndex">The index of the first selected character. Ignored if
|
|
the number of selected characters is 0.</param>
|
|
<param name="selectedCharCount">The number of selected characters or 0 if none.
|
|
May be negative if the selection is reversed.</param>
|
|
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="graphics"/> or
|
|
<paramref name="paintOptions"/> is null.</exception>
|
|
</member>
|
|
<member name="M:Gallio.Common.Splash.SplashLayout.AppendScriptLinesForScriptParagraph(Gallio.Common.Splash.Internal.DeviceContext,System.Int32)">
|
|
<summary>
|
|
Computes the layout of a <see cref="T:Gallio.Common.Splash.Internal.ScriptParagraph"/> and appends one or
|
|
more <see cref="T:Gallio.Common.Splash.Internal.ScriptLine"/>s to the <see cref="F:Gallio.Common.Splash.SplashLayout.scriptLineBuffer"/>.
|
|
</summary>
|
|
<param name="deviceContext">The HDC state.</param>
|
|
<param name="paragraphIndex">The paragraph index to layout.</param>
|
|
</member>
|
|
<member name="M:Gallio.Common.Splash.SplashLayout.GetScriptParagraph(Gallio.Common.Splash.Internal.DeviceContext,System.Int32)">
|
|
<summary>
|
|
Gets a fully analyzed <see cref="T:Gallio.Common.Splash.Internal.ScriptParagraph"/> by paragraph index.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Gallio.Common.Splash.SplashLayout.AnalyzeParagraph(Gallio.Common.Splash.Internal.DeviceContext,Gallio.Common.Splash.Internal.Paragraph*,Gallio.Common.Splash.Internal.ScriptParagraph*)">
|
|
<summary>
|
|
Analyzes a <see cref="T:Gallio.Common.Splash.Internal.Paragraph"/> to populate a <see cref="T:Gallio.Common.Splash.Internal.ScriptParagraph"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="E:Gallio.Common.Splash.SplashLayout.UpdateRequired">
|
|
<summary>
|
|
Event raised when a layout property changes and requires an update.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Gallio.Common.Splash.SplashLayout.Document">
|
|
<summary>
|
|
Gets the document this layout is for.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Gallio.Common.Splash.SplashLayout.ParentControl">
|
|
<summary>
|
|
Gets the parent control to which embedded objects can attach themselves.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Gallio.Common.Splash.SplashLayout.DesiredLayoutWidth">
|
|
<summary>
|
|
Gets or sets the desired layout width.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Gallio.Common.Splash.SplashLayout.DesiredLayoutRightToLeft">
|
|
<summary>
|
|
Gets or sets the desired reading order for the layout.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Gallio.Common.Splash.SplashLayout.CurrentLayoutWidth">
|
|
<summary>
|
|
Gets or sets the current layout width which may differ from the desired layout width
|
|
if a relayout is pending.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Gallio.Common.Splash.SplashLayout.CurrentLayoutHeight">
|
|
<summary>
|
|
Gets or sets the current layout height which may differ from the expected layout height
|
|
if a relayout is pending.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Gallio.Common.Splash.SplashLayout.CurrentLayoutRightToLeft">
|
|
<summary>
|
|
Gets or sets the current reading order which may differ from the desired reading order
|
|
if a relayout is pending.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Gallio.Common.Splash.Style">
|
|
<summary>
|
|
Describes the style of a text run.
|
|
</summary>
|
|
<remarks>
|
|
<para>
|
|
A style is immutable once created and can be compared for equality with other styles.
|
|
</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:Gallio.Common.Splash.Style.Equals(Gallio.Common.Splash.Style)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:Gallio.Common.Splash.Style.Equals(System.Object)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:Gallio.Common.Splash.Style.GetHashCode">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:Gallio.Common.Splash.Style.Default">
|
|
<summary>
|
|
Gets a default style based on current system font and color settings.
|
|
</summary>
|
|
<value>The style.</value>
|
|
</member>
|
|
<member name="P:Gallio.Common.Splash.Style.Font">
|
|
<summary>
|
|
Gets the font.
|
|
</summary>
|
|
<remarks>
|
|
This is an inline style property.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:Gallio.Common.Splash.Style.Color">
|
|
<summary>
|
|
Gets the color.
|
|
</summary>
|
|
<remarks>
|
|
This is an inline style property.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:Gallio.Common.Splash.Style.TabStopRuler">
|
|
<summary>
|
|
Gets the tab stop ruler.
|
|
</summary>
|
|
<remarks>
|
|
This is a paragraph style property.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:Gallio.Common.Splash.Style.WordWrap">
|
|
<summary>
|
|
Gets whether to perform word-wrapping.
|
|
</summary>
|
|
<remarks>
|
|
This is a paragraph style property.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:Gallio.Common.Splash.Style.LeftMargin">
|
|
<summary>
|
|
Gets the left margin width in pixels.
|
|
</summary>
|
|
<remarks>
|
|
This is a paragraph style property.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:Gallio.Common.Splash.Style.RightMargin">
|
|
<summary>
|
|
Gets the right margin width in pixels.
|
|
</summary>
|
|
<remarks>
|
|
This is a paragraph style property.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:Gallio.Common.Splash.Style.FirstLineIndent">
|
|
<summary>
|
|
Gets the first line indent in pixels.
|
|
</summary>
|
|
<remarks>
|
|
This is a paragraph style property.
|
|
</remarks>
|
|
</member>
|
|
<member name="T:Gallio.Common.Splash.StyleBuilder">
|
|
<summary>
|
|
Builds <see cref="T:Gallio.Common.Splash.Style"/> objects.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Gallio.Common.Splash.StyleBuilder.#ctor">
|
|
<summary>
|
|
Creates a builder with all style properties inherited.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Gallio.Common.Splash.StyleBuilder.#ctor(Gallio.Common.Splash.Style)">
|
|
<summary>
|
|
Creates a builder initialized as a copy of an existing style.
|
|
</summary>
|
|
<param name="style">The style to copy.</param>
|
|
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="style"/> is null.</exception>
|
|
</member>
|
|
<member name="M:Gallio.Common.Splash.StyleBuilder.#ctor(Gallio.Common.Splash.StyleBuilder)">
|
|
<summary>
|
|
Creates a builder initialized as a copy of an existing style builder.
|
|
</summary>
|
|
<param name="styleBuilder">The style builder to copy.</param>
|
|
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="styleBuilder"/> is null.</exception>
|
|
</member>
|
|
<member name="M:Gallio.Common.Splash.StyleBuilder.ToStyle(Gallio.Common.Splash.Style)">
|
|
<summary>
|
|
Creates an immutable style object from the builder's properties.
|
|
</summary>
|
|
<param name="inheritedStyle">The style to inherit.</param>
|
|
<returns>The new style object.</returns>
|
|
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="inheritedStyle"/> is null.</exception>
|
|
</member>
|
|
<member name="M:Gallio.Common.Splash.StyleBuilder.ToStyle">
|
|
<summary>
|
|
Creates an immutable style object from the builder's properties and supplies
|
|
any inherited properties from <see cref="P:Gallio.Common.Splash.Style.Default"/>.
|
|
</summary>
|
|
<returns>The new style object.</returns>
|
|
</member>
|
|
<member name="P:Gallio.Common.Splash.StyleBuilder.Font">
|
|
<summary>
|
|
Gets or sets the font.
|
|
</summary>
|
|
<remarks>
|
|
This is an inline style property.
|
|
</remarks>
|
|
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="value"/> contains null.</exception>
|
|
</member>
|
|
<member name="P:Gallio.Common.Splash.StyleBuilder.Color">
|
|
<summary>
|
|
Gets or sets the color.
|
|
</summary>
|
|
<remarks>
|
|
This is an inline style property.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:Gallio.Common.Splash.StyleBuilder.TabStopRuler">
|
|
<summary>
|
|
Gets or sets the tab stop ruler.
|
|
</summary>
|
|
<remarks>
|
|
This is a paragraph style property.
|
|
</remarks>
|
|
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="value"/> contains null.</exception>
|
|
</member>
|
|
<member name="P:Gallio.Common.Splash.StyleBuilder.WordWrap">
|
|
<summary>
|
|
Gets or sets whether to perform word-wrapping.
|
|
</summary>
|
|
<remarks>
|
|
This is a paragraph style property.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:Gallio.Common.Splash.StyleBuilder.LeftMargin">
|
|
<summary>
|
|
Gets or sets the left margin width in pixels.
|
|
</summary>
|
|
<remarks>
|
|
This is a paragraph style property.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:Gallio.Common.Splash.StyleBuilder.RightMargin">
|
|
<summary>
|
|
Gets or sets the right margin width in pixels.
|
|
</summary>
|
|
<remarks>
|
|
This is a paragraph style property.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:Gallio.Common.Splash.StyleBuilder.FirstLineIndent">
|
|
<summary>
|
|
Gets or sets the first line indent in pixels.
|
|
</summary>
|
|
<remarks>
|
|
This is a paragraph style property.
|
|
</remarks>
|
|
</member>
|
|
<member name="T:Gallio.Common.Splash.StyleProperty`1">
|
|
<summary>
|
|
Specifies a style property that may either be set explicitly or inherited from
|
|
another style.
|
|
</summary>
|
|
<typeparam name="T">The type of value held by the property.</typeparam>
|
|
</member>
|
|
<member name="F:Gallio.Common.Splash.StyleProperty`1.Inherit">
|
|
<summary>
|
|
Gets a special value that indicates that a style property value is inherited.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Gallio.Common.Splash.StyleProperty`1.#ctor(`0)">
|
|
<summary>
|
|
Creates a style property with the specified value.
|
|
</summary>
|
|
<param name="value">The value.</param>
|
|
</member>
|
|
<member name="M:Gallio.Common.Splash.StyleProperty`1.GetValueOrInherit(`0)">
|
|
<summary>
|
|
Gets the value of the property if it is not inherited
|
|
otherwise returns the inherited value.
|
|
</summary>
|
|
<param name="inheritedValue">The inherited value.</param>
|
|
<returns>The value.</returns>
|
|
</member>
|
|
<member name="M:Gallio.Common.Splash.StyleProperty`1.op_Implicit(`0)~Gallio.Common.Splash.StyleProperty{`0}">
|
|
<summary>
|
|
Creates a style property with the specified value.
|
|
</summary>
|
|
<param name="value">The value.</param>
|
|
<returns>The style property.</returns>
|
|
</member>
|
|
<member name="M:Gallio.Common.Splash.StyleProperty`1.op_Equality(Gallio.Common.Splash.StyleProperty{`0},Gallio.Common.Splash.StyleProperty{`0})">
|
|
<summary>
|
|
Returns true if the properties are equal.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Gallio.Common.Splash.StyleProperty`1.op_Inequality(Gallio.Common.Splash.StyleProperty{`0},Gallio.Common.Splash.StyleProperty{`0})">
|
|
<summary>
|
|
Returns true if the properties are not equal.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Gallio.Common.Splash.StyleProperty`1.Equals(System.Object)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:Gallio.Common.Splash.StyleProperty`1.GetHashCode">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:Gallio.Common.Splash.StyleProperty`1.Equals(Gallio.Common.Splash.StyleProperty{`0})">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:Gallio.Common.Splash.StyleProperty`1.Inherited">
|
|
<summary>
|
|
Returns true if the property value is inherited.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Gallio.Common.Splash.StyleProperty`1.Value">
|
|
<summary>
|
|
Gets the value of the property if it is not inherited.
|
|
</summary>
|
|
<exception cref="T:System.InvalidOperationException">Thrown if the property is inherited.</exception>
|
|
</member>
|
|
<member name="T:Gallio.Common.Splash.Stylesheet">
|
|
<summary>
|
|
Manages a collection of styles.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Gallio.Common.Splash.Stylesheet.#ctor">
|
|
<summary>
|
|
Creates an empty stylesheet.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Gallio.Common.Splash.Stylesheet.AddStyle(System.String,Gallio.Common.Splash.Style)">
|
|
<summary>
|
|
Adds a style to the stylesheet.
|
|
</summary>
|
|
<param name="name">The style name.</param>
|
|
<param name="style">The style to add.</param>
|
|
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="name"/> or <paramref name="style"/> is null.</exception>
|
|
<exception cref="T:System.InvalidOperationException">Thrown if there is already a style with name <paramref name="name"/>.</exception>
|
|
</member>
|
|
<member name="M:Gallio.Common.Splash.Stylesheet.GetStyle(System.String,Gallio.Common.Splash.Style)">
|
|
<summary>
|
|
Gets a style by name.
|
|
</summary>
|
|
<param name="name">The style name.</param>
|
|
<param name="defaultStyle">The default style to return if no style
|
|
is present with the specified name.</param>
|
|
<returns>The style.</returns>
|
|
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="name"/> is null.</exception>
|
|
</member>
|
|
<member name="T:Gallio.Common.Splash.SplashView">
|
|
<summary>
|
|
A SplashView is a custom control to display styled text intermixed with
|
|
embedded content such as images.
|
|
</summary>
|
|
<remarks>
|
|
<para>
|
|
This control is optimized for high-performance append-only text output such as
|
|
scrolling consoles. Consequently, the control does not support editing or
|
|
modifications to currently displayed content (besides clearing it).
|
|
</para>
|
|
<para>
|
|
Display updates are performed asynchronously in batches.
|
|
</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:Gallio.Common.Splash.SplashView.#ctor">
|
|
<summary>
|
|
Creates an empty SplashView.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Gallio.Common.Splash.SplashView.Dispose(System.Boolean)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:Gallio.Common.Splash.SplashView.GetSnapPositionAtPoint(System.Drawing.Point)">
|
|
<summary>
|
|
Gets the snap position that corresponds to a point in the control.
|
|
</summary>
|
|
<param name="point">The point relative to the layout origin.</param>
|
|
<returns>The character snap.</returns>
|
|
</member>
|
|
<member name="M:Gallio.Common.Splash.SplashView.Select(System.Int32,System.Int32)">
|
|
<summary>
|
|
Sets the selection.
|
|
</summary>
|
|
<param name="selectionStart">The selection start character index.</param>
|
|
<param name="selectionLength">The selection length or 0 if none.</param>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">Thrown if <paramref name="selectionStart"/>
|
|
or <paramref name="selectionLength"/> is less than 0.</exception>
|
|
</member>
|
|
<member name="M:Gallio.Common.Splash.SplashView.SelectAll">
|
|
<summary>
|
|
Sets the selection to include all text in the document.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Gallio.Common.Splash.SplashView.SelectNone">
|
|
<summary>
|
|
Clears the selection.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Gallio.Common.Splash.SplashView.GetSelectedText">
|
|
<summary>
|
|
Gets the currently selected text in the document, or an empty string
|
|
if there is no selection.
|
|
</summary>
|
|
<returns>The selected text.</returns>
|
|
</member>
|
|
<member name="M:Gallio.Common.Splash.SplashView.CopySelectedTextToClipboard">
|
|
<summary>
|
|
Copies the selected text to the clipboard.
|
|
Does nothing if there is no current selection.
|
|
</summary>
|
|
<returns>True if some text was copied, false if there was no current selection.</returns>
|
|
</member>
|
|
<member name="M:Gallio.Common.Splash.SplashView.OnHandleCreated(System.EventArgs)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:Gallio.Common.Splash.SplashView.OnPaint(System.Windows.Forms.PaintEventArgs)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:Gallio.Common.Splash.SplashView.OnPaddingChanged(System.EventArgs)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:Gallio.Common.Splash.SplashView.OnResize(System.EventArgs)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:Gallio.Common.Splash.SplashView.OnRightToLeftChanged(System.EventArgs)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:Gallio.Common.Splash.SplashView.OnMouseDown(System.Windows.Forms.MouseEventArgs)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:Gallio.Common.Splash.SplashView.OnMouseUp(System.Windows.Forms.MouseEventArgs)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:Gallio.Common.Splash.SplashView.OnMouseMove(System.Windows.Forms.MouseEventArgs)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:Gallio.Common.Splash.SplashView.OnSelectionChanged(System.EventArgs)">
|
|
<summary>
|
|
Called when the selection changes.
|
|
</summary>
|
|
<param name="e">The event arguments.</param>
|
|
</member>
|
|
<member name="M:Gallio.Common.Splash.SplashView.MousePositionToLayout(System.Drawing.Point)">
|
|
<summary>
|
|
Maps a mouse position to a layout point.
|
|
</summary>
|
|
<param name="mousePosition">The mouse position.</param>
|
|
<returns>The layout point.</returns>
|
|
</member>
|
|
<member name="M:Gallio.Common.Splash.SplashView.ProcessCmdKey(System.Windows.Forms.Message@,System.Windows.Forms.Keys)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:Gallio.Common.Splash.SplashView.UpdateContextMenu">
|
|
<summary>
|
|
Updates the context menu in time for pop-up.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Gallio.Common.Splash.SplashView.IsInputChar(System.Char)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:Gallio.Common.Splash.SplashView.IsInputKey(System.Windows.Forms.Keys)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:Gallio.Common.Splash.SplashView.OnKeyDown(System.Windows.Forms.KeyEventArgs)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="E:Gallio.Common.Splash.SplashView.SelectionChanged">
|
|
<summary>
|
|
Event raised when the selection has changed.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Gallio.Common.Splash.SplashView.BackColor">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:Gallio.Common.Splash.SplashView.SelectedTextColor">
|
|
<summary>
|
|
Gets or sets the selected text color.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Gallio.Common.Splash.SplashView.SelectedBackgroundColor">
|
|
<summary>
|
|
Gets or sets the selected text color.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Gallio.Common.Splash.SplashView.SelectionStart">
|
|
<summary>
|
|
Gets the selection start character index.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Gallio.Common.Splash.SplashView.SelectionLength">
|
|
<summary>
|
|
Gets the selection length, or 0 if none.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Gallio.Common.Splash.SplashView.MinimumTextLayoutWidth">
|
|
<summary>
|
|
Gets or sets the minimum width of the text area.
|
|
</summary>
|
|
<remarks>
|
|
If the control is resized to less than this width, then the control will automatically
|
|
display a horizontal scrollbar.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:Gallio.Common.Splash.SplashView.Document">
|
|
<summary>
|
|
Gets the document displayed in the view.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Gallio.Common.Splash.SplashView.DefaultCursor">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:Gallio.Common.Splash.SplashView.DefaultSize">
|
|
<inheritdoc />
|
|
</member>
|
|
</members>
|
|
</doc>
|