C# Class XCore.ReBarAdapter

Creates the toolbars for an XCore application.

Inheritance: XCore.BarAdapterBase

Show file Open project: sillsdev/FieldWorks

Protected Properties

Property	Type	Description
m_choiceGroupCollection	XCore.ChoiceGroupCollection

Public Methods

Method	Description
CreateUIForChoiceGroup ( XCore.ChoiceGroup group ) : void	do a limited update of the toolbar Create or update the toolbar or a combobox owned by the toolbar when the user's cursor is hovering over a button and we do a redraw, this method is called. This allows us to update the enabled state of the button without getting flashing tool tips, which is what we get if we were to clear the toolbar and rebuild the buttons, as is normally done at idle time.
CreateUIForChoiceGroupCollection ( XCore.ChoiceGroupCollection groupCollection ) : void	Overrides method to create the toolbars, but witout the items on them, which are handled elsewhere.
ForceFullRegenerate ( ) : void	Used during Refresh, this indicates that the next idle call to regenerate the toolbar if anything has changed should behave unconditionally as if something HAS changed, and rebuild the toolbar. For example, the normal DoesToolStripNeedRegenerating does not notice that unselected items in the style combo list are different from the ones in the current menu.
OnIdle ( ) : void	Redraw all of the toolbars on idle in case of some items have been enabled/disabled/made invisible, etc.
PersistLayout ( ) : void	store the location/settings of various widgets so that we can restore them next time

Protected Methods

Method	Description
DepersistLayout ( ) : void	get the location/settings of various widgets so that we can restore them

Private Methods

Method	Description
DoesToolStripNeedRegenerating ( XCore.ChoiceGroup choiceGroup, ToolStrip toolStrip ) : bool
FillToolbar ( XCore.ChoiceGroup choiceGroup, ToolStrip toolStrip ) : void
InCombo ( ToolStrip toolbar ) : bool	Tells whether the user is manipulating some combo of the toolbar, in which case the toolbar should not be rebuilt now
InitializeToolStrips ( ) : void

Method Details

CreateUIForChoiceGroup() public method

do a limited update of the toolbar Create or update the toolbar or a combobox owned by the toolbar

when the user's cursor is hovering over a button and we do a redraw, this method is called. This allows us to update the enabled state of the button without getting flashing tool tips, which is what we get if we were to clear the toolbar and rebuild the buttons, as is normally done at idle time.

public CreateUIForChoiceGroup ( XCore.ChoiceGroup group ) : void
group	XCore.ChoiceGroup	/// The group that is the basis for this toolbar. ///
return	void

CreateUIForChoiceGroupCollection() public method

Overrides method to create the toolbars, but witout the items on them, which are handled elsewhere.

public CreateUIForChoiceGroupCollection ( XCore.ChoiceGroupCollection groupCollection ) : void
groupCollection	XCore.ChoiceGroupCollection	Collection of toolbar definitions to create.
return	void

DepersistLayout() protected method

get the location/settings of various widgets so that we can restore them

protected DepersistLayout ( ) : void
return	void

ForceFullRegenerate() public method

Used during Refresh, this indicates that the next idle call to regenerate the toolbar if anything has changed should behave unconditionally as if something HAS changed, and rebuild the toolbar. For example, the normal DoesToolStripNeedRegenerating does not notice that unselected items in the style combo list are different from the ones in the current menu.

public ForceFullRegenerate ( ) : void
return	void

OnIdle() public method

Redraw all of the toolbars on idle in case of some items have been enabled/disabled/made invisible, etc.

public OnIdle ( ) : void
return	void

PersistLayout() public method

store the location/settings of various widgets so that we can restore them next time

public PersistLayout ( ) : void
return	void

Property Details

m_choiceGroupCollection protected property

protected ChoiceGroupCollection,XCore m_choiceGroupCollection
return	XCore.ChoiceGroupCollection