C# Class SIL.FieldWorks.IText.SandboxBase

The Sandbox is about to close, or move to another word...if there are pending edits, save them. This is done by simulating a Return key press in the combo.

Return the index of the line that contains the selection.

If hvoEntry is the id of a variant, try to find an entry it's a variant of that has a sense. Return the corresponding ILexEntryRef for the first such entry. If this is being called to establish a default monomorphemic guess, skip over any bound root or bound stem entries that hvoEntry may be a variant of.

Create the default selection that is wanted when we move to a new word in a way that does not predetermine what is selected. (For example, left and right arrow can move to a specific corresponding field.)

Make the root box.

Never show the style combo box in the toolbar while focused in the Sandbox.

The SandBox is never the control that should print.

Handle a problem deleting some selection in the sandbox. So far, the only cases we handle are backspace and delete merging morphemes. Enhance JohnT: could also handle deleting a range that merges morphemes.

Do nothing if the Sandbox somehow gets refreshed directly...its parent window destroys and recreates it.

If sizing to content, a change of the size of the root box requires us to resize the window.

Try to make a selection on the specified line, or some subsequent line in the direction indicated by increment.

Set the (real) LexEntry that is considered current. Broadcast a notification to delegates if it changed.

indicates whether the sandbox is in a state that can or should be saved.

Simulate MouseDown on the rootbox, but allow selections in read-only text.

Simulate MouseDownExtended on the rootbox, but allow selections in read-only text.

Call MouseMoveDrag on the rootbox

Call MouseUp on the rootbox

get the current dummy sandbox morphs

Clean up any resources being used.

Overide this to provide a context menu for some subclass.

Get's the real lex senses for each current morph.

Disables/enables the Edit/Undo menu item

Disables/enables the Edit/Undo menu item

When a sandbox is created, inform the main window that it needs to receive keyboard input until further notice. (See FWNX-785.)

When a sandbox is destroyed, inform the main window that it no longer exists to receive keyboard input. (See FWNX-785.)

Calling it through xCore doesn't seem to work, maybe this isn't a target? Try forcing it this way.

Handle the mouse moving...remember where it was last in case it turns into a hover.

Consistent with OnDisplayRedo.

Process right mouse button down. In particular, handle CTRL+Right Mouse Click.

This function will undo the last changes done to the project. This function is executed when the user clicks the undo menu item.

Select the indicated icon of the word.

Add to rgvsli an initial item that selects the indicated morpheme

Return the count of morphemes, after creating the initial one if there are none.

Copy to the secondary cache NamedObect hvoSec all alternatives of property flid of real object hvoMain. The user may change the actual writing system assigned to a given line at any time, so we need all the possibilities available in the local cache.

Return the hvo best describing the state of the secondary cache for LexEntry fields (by MSA, LexSense, or LexEntry).

Find the MoForm, from among those whose form (in some ws) is the given one starting from the most frequently referenced by the MorphBundles property of a WfiAnalysis. If there is no wordform analysis, then fall back to selecting any matching MoForm.

If we have an action installed for this icon selection, do it.

Given that we have set the form of hvoMorph (in the sandbox cache) to the given form, figure defaults for the LexEntry, LexGloss, and LexPos lines as far as possible. It is assumed that all three following lines are empty to begin with. Also set matching text for any other WSs that are displayed for MoForm. (This is important because if the user confirms the analysis, we will write that information back to the MoForm. If we leave the lines blank that process could remove the other alternatives.)

Given that we have made hvoEntryReal the lex entry for the (sandbox) morpheme hvoMorph, look for the sense given by hvoSenseReal and fill it in.

Find the actual original form of the current wordform. (For more information see definition for Sandbox.FormOfWordForm.)

find a selection of the given selType in the RootBox starting at xMin coordinate and spanning xMaxCountOfPixels along the mid y-coordinate of the given selOrig, by the direction and increment of dxPixelIncrement.

Obtain the HVO of the most desirable default annotation to use for a particular wordform.

Get the string that should be stored in the MorphBundle Form. This will include any prefix and/or postfix markers.

Given a selection (typically from a click), determine the object that should be the target for jumping to, and return the property that was clicked (which in the case of a right-click may generate a spelling menu instead).

Return the HVO of the most promising LexEntry to jump to. This is a fall-back when the user has not clicked on a morpheme.

If hvoEntryReal refers to a variant, try for the first sense of the entry it's a variant of. Otherwise, give up and return 0.

The wfi analysis currently used to setup the sandbox. Could have possibly come from a guess, not simply the current annotations InstanceOf.

Gets the WfiAnalysis HVO of the analysis we're displaying (if any).

Gets the WfiAnalysis HVO of the given analysis.

return the wordform that corresponds to the given form, or zero if none.

Copied from ChooseAnalysisHandler. Gets the wordform that owns the analysis we're displaying. (If there's no current analysis, or it is an object which someone has pathologically deleted in another window, return the current wordform.) It's possible for this to return null, if we're displaying a case-adjusted morpheme at the start of a sentence, and no wordform has been created for that case form.

Handle the End key (Ctrl-End if fControl is true). Return true to suppress normal End-Key processing

Handle the Home key (Ctrl-Home if fControl is true). Return true to suppress normal Home-Key processing

Handle a press of the left arrow key.

Handle a press of the right arrow key.

Handle a tab character. If there is no selection in the sandbox, we go to the first line. If there is one, we go Wordform -> Morph (or word gloss, if morphs not showing) Morph ->LexEntry LexEntry, LexGloss, LexPOS->Next LexEntry, or word gloss. Word gloss->WordPOS WordPOS -> Wordform.

This handles the user choosing an analysis from the pull-down in the top ("Word") line of the Sandbox. The sender must be a ChooseAnalysisHandler (CAH). The Sandbox switches to showing the analysis indicated by the 'Analysis' property of that CAH.

Required method for Designer support - do not modify the contents of this method with the code editor.

Check whether the given entry (or entry owning the given sense) is either a bound root or a bound stem. We don't want to use those as guesses for monomorphemic words. See LT-10323.

True if user is in gloss tab.

the given word is a phrase if it has any word breaking space characters

Load the real data into the secondary cache, and establish this as the state we'd return to if we undo all changes in the analysis (i.e. does fClearDirty).

Load the real data into the secondary cache.

Create a first morpheme whose content matches the word. Typically the user clicked or tabbed to an empty morpheme line.

Make a string in the specified ws, using the provided TSF if possible, if passed null, make one.

Move to the analysis icon if we're showing one, otherwise, to the following line.

Make and install the selection indicated by the array of objects on the first (and only root), an IP at the start of the property.

Make and install the selection indicated by the array of objects on the first (and only root), an IP at the start of the property.

Make and install the selection indicated by the array and a following atomic property that contains an icon.

Return the index of the next morpheme, based on the current selection and increment (direction).

Triggered to tell clients that the Sandbox has changed (e.g. been edited from its initial state) to help determine whether we should allow trying to save or undo the changes. Currently triggered by SandboxEditMonitor.PropChanged whenever a property changes on the cache

Resync the sandbox and reconstruct the rootbox to match the current state of the database.

given a (text) selection, scan the beginning of its paragraph box and then immediately before its paragraph box in search of the icon.

Make a selection at the end of the specified word gloss line.

Make a selection at the start of the indicated morpheme in the morphs line. That is, at the start of the prefix if there is one, otherwise, the start of the form.

Make a selection at the start of the indicated morpheme in the morphs line. That is, at the start of the prefix if there is one, otherwise, the start of the form.

Given an icon selection, find the nearest associated text. In left to right, that's the first text to right of the picture. In right to left, it's the first text to the left of the picture;

Select the indicated icon of the indicated morpheme.

Try to make a selection on startLine. If unsuccessful, try successive lines (the direction is indicated by increment, which should be 1 or -1). If the increment process reaches the beginning or end, wrap around. If it reaches limitLine, give up and return false. (However, it WILL try startLine once, even if it is equal to limitLine.

Find the next icon to jump to, and then select nearest text

Make a combo box appropriate for the specified selection. If fMouseDown is true, do so unconditionally...otherwise (mousemove) only if the new selection is on a different thing.