C# Class SIL.FieldWorks.IText.SandboxBase.SandboxVc

Inheritance: SIL.FieldWorks.Common.RootSites.FwBaseVc, IDisposable

Show file Open project: sillsdev/FieldWorks

Protected Properties

Property	Type	Description
m_caches	CachePair
m_wsAnalysis	int
m_wsUi	int
m_wsVern	int

Private Properties

Property	Type	Description
AddPullDownIcon	void
ConvertPictureWidthToMillipoints	int
DisplayLexGloss	void
DisplayMorphBundles	void
DisplayMorphForm	void
DisplayWordGloss	void
DisplayWordPOS	void
DisplayWordform	void
GetActualWs	int
GetBestAlt	int
MakeNextFlowObjectEditable	void
MakeNextFlowObjectReadOnly	void
SetBGColor	void
SetEditabilityOfNextFlowObject	void
SetIndentForMissingIcon	void
SetIndentOrDisplayPullDown	void
UpdateLineChoices	void

Public Methods

Method	Description
AddGlossLabels ( IVwEnv vwenv, ITsStrFactory tsf, int color, string baseLabel, SIL.FieldWorks.FDO.FdoCache cache, WsListManager wsList ) : void	Add to the vwenv the label(s) for a gloss line. If multiple glosses are wanted, it generates a set of labels
CheckDisposed ( ) : void	Throw if the IsDisposed property is true
Display ( IVwEnv vwenv, int hvo, int frag ) : void
DisplayVariant ( IVwEnv vwenv, int tag, int frag ) : ITsString
DisplayVec ( IVwEnv vwenv, int hvo, int tag, int frag ) : void
Dispose ( ) : void
SandboxVc ( CachePair caches, SIL.FieldWorks.IText.InterlinLineChoices choices, bool fIconsForAnalysisChoices, SandboxBase sandbox ) : System

Protected Methods

Method	Description
AddColoredString ( IVwEnv vwenv, int color, ITsStrFactory tsf, int ws, string str ) : void	Add the specified string in the specified color to the display, using the UI Writing system.
AddOptionalNamedObj ( IVwEnv vwenv, int hvo, int tag, int dummyTag, int dummyFrag, int tagIcon, int ws, int choiceIndex ) : void	Add to the vwenv a display of property tag of object hvo, which stores an SbNamedObj. If the property is non-null, display the name of the SbNamedObj. If not, display the dummyTag 'property' using the dummyFrag.
Dispose ( bool fDisposing ) : void
SetColor ( IVwEnv vwenv, int color ) : void	Called right before adding a string or opening a flow object, sets its color.

Private Methods

Method	Description
AddPullDownIcon ( IVwEnv vwenv, int tag ) : void
ConvertPictureWidthToMillipoints ( IPicture picture ) : int	We want a width in millipoints (72000/inch). Value we have is in 100/mm. There are 25.4 mm/inch.
DisplayLexGloss ( IVwEnv vwenv, int hvo, int ws, int choiceIndex ) : void
DisplayMorphBundles ( IVwEnv vwenv, int hvo ) : void
DisplayMorphForm ( IVwEnv vwenv, int hvo, int frag, int ws, int choiceIndex ) : void
DisplayWordGloss ( IVwEnv vwenv, int hvo, int ws, int choiceIndex ) : void
DisplayWordPOS ( IVwEnv vwenv, int hvo, int ws, int choiceIndex ) : void
DisplayWordform ( IVwEnv vwenv, int ws, int choiceIndex ) : void
GetActualWs ( int hvo, int tag, int ws ) : int
GetBestAlt ( int hvo, int tag, int wsPreferred, int wsDefault, int wsList ) : int
MakeNextFlowObjectEditable ( IVwEnv vwenv ) : void
MakeNextFlowObjectReadOnly ( IVwEnv vwenv ) : void
SetBGColor ( IVwEnv vwenv, int guessColor ) : void
SetEditabilityOfNextFlowObject ( IVwEnv vwenv, bool fEditable ) : void
SetIndentForMissingIcon ( IVwEnv vwenv ) : void	Set the indent needed when the icon is missing.
SetIndentOrDisplayPullDown ( IVwEnv vwenv, int tag, bool fWantIcon ) : void	If fWantIcon is true, add a pull-down icon; otherwise, set enough indent so the next thing in the paragraph will line up with things that have icons.
UpdateLineChoices ( SIL.FieldWorks.IText.InterlinLineChoices choices ) : void

Method Details

AddColoredString() protected static method

Add the specified string in the specified color to the display, using the UI Writing system.

protected static AddColoredString ( IVwEnv vwenv, int color, ITsStrFactory tsf, int ws, string str ) : void
vwenv	IVwEnv
color	int
tsf	ITsStrFactory
ws	int
str	string
return	void

AddGlossLabels() public method

Add to the vwenv the label(s) for a gloss line. If multiple glosses are wanted, it generates a set of labels

public AddGlossLabels ( IVwEnv vwenv, ITsStrFactory tsf, int color, string baseLabel, SIL.FieldWorks.FDO.FdoCache cache, WsListManager wsList ) : void
vwenv	IVwEnv
tsf	ITsStrFactory
color	int
baseLabel	string
cache	SIL.FieldWorks.FDO.FdoCache
wsList	WsListManager
return	void

AddOptionalNamedObj() protected method

Add to the vwenv a display of property tag of object hvo, which stores an SbNamedObj. If the property is non-null, display the name of the SbNamedObj. If not, display the dummyTag 'property' using the dummyFrag.

protected AddOptionalNamedObj ( IVwEnv vwenv, int hvo, int tag, int dummyTag, int dummyFrag, int tagIcon, int ws, int choiceIndex ) : void
vwenv	IVwEnv
hvo	int
tag	int
dummyTag	int
dummyFrag	int
tagIcon	int	If non-zero, display a pull-down icon before the item, marked with this tag.
ws	int	which alternative of the name to display
choiceIndex	int	which item in m_choices this comes from. The icon is displayed /// only if it is the first one for its flid.
return	void

CheckDisposed() public method

Throw if the IsDisposed property is true

public CheckDisposed ( ) : void
return	void

Display() public method

public Display ( IVwEnv vwenv, int hvo, int frag ) : void
vwenv	IVwEnv
hvo	int
frag	int
return	void

DisplayVariant() public method

public DisplayVariant ( IVwEnv vwenv, int tag, int frag ) : ITsString
vwenv	IVwEnv
tag	int
frag	int
return	ITsString

DisplayVec() public method

public DisplayVec ( IVwEnv vwenv, int hvo, int tag, int frag ) : void
vwenv	IVwEnv
hvo	int
tag	int
frag	int
return	void

Dispose() public method

public Dispose ( ) : void
return	void

Dispose() protected method

protected Dispose ( bool fDisposing ) : void
fDisposing	bool
return	void

SandboxVc() public method

public SandboxVc ( CachePair caches, SIL.FieldWorks.IText.InterlinLineChoices choices, bool fIconsForAnalysisChoices, SandboxBase sandbox ) : System
caches	CachePair
choices	SIL.FieldWorks.IText.InterlinLineChoices
fIconsForAnalysisChoices	bool
sandbox	SandboxBase
return	System

SetColor() protected static method

Called right before adding a string or opening a flow object, sets its color.

protected static SetColor ( IVwEnv vwenv, int color ) : void
vwenv	IVwEnv
color	int
return	void

Property Details

m_caches protected property

protected CachePair m_caches
return	CachePair

m_wsAnalysis protected property

protected int m_wsAnalysis
return	int

m_wsUi protected property

protected int m_wsUi
return	int

m_wsVern protected property

protected int m_wsVern
return	int