Base class for all displayed ObjCryst objects (with a title, and a sizer to stack objects). More...

Inheritance diagram for ObjCryst::WXCrystObj:

Collaboration diagram for ObjCryst::WXCrystObj:

Public Member Functions
	WXCrystObj (wxWindow *parent, int orient=wxHORIZONTAL, bool showName=true)
	Constructor, with a.

void	OnToggleCollapse (wxCommandEvent &WXUNUSED(event))
	Only display the title, and collapse everything else. More...

virtual bool	OnChangeName (const int id)=0
	When a WXFieldName has been changed by the user, it is handled here. More...

virtual void	CrystUpdate (const bool updateUI=false, const bool mutexlock=false)
	Get new values to be displayed from the underlying object, and raise flag if an UI update is necessary. More...

virtual void	UpdateUI (const bool mutexlock=false)
	Update the User Interface, if necessary. More...

virtual void	OnEnable (wxUpdateUIEvent &event)

virtual bool	Enable (bool enable)

virtual void	AddChild (WXCrystObjBasic *pChild, bool doBottomLayout=true)
	Notify that a new children has been added, also adding it to the correct sizer (which can be the top sizer or not). More...

Public Member Functions inherited from ObjCryst::WXCrystObjBasic
	WXCrystObjBasic (wxWindow *parent)
	Constructor.

virtual	~WXCrystObjBasic ()
	Destructor.

	wxDEPRECATED (virtual void BottomLayout(WXCrystObjBasic *pChild))
	Redo the Layout for the object and ask parent to take it into account. More...

void	AddedToList (WXCrystObjBasicList *list)

void	RemovedFromList (WXCrystObjBasicList *list)

virtual bool	Layout ()

virtual void	SetToolTip (const wxString &tip)
	Set tooltip for this window. More...

Protected Attributes
wxBoxSizer *	mpTopSizer
	Top sizer including the title and WXCrystObj::mpSizer.

wxBoxSizer *	mpSizer
	Sizer including all sub-objects.

WXFieldName *	mpWXTitle
	The title.

bool	mIsExpanded
	To be used for collapsing the sub-objects.

WXCrystObjBasicList	mList
	All windows but the title and collapse button are in this list.

wxButton *	mpCollapseButton
	The collapse button.

Protected Attributes inherited from ObjCryst::WXCrystObjBasic
WXCrystObjBasic *	mWXCrystParent
	Parent, if a WXCrystObjBasic itself.

bool	mIsShown
	Is the the window currently shown ?

bool	mNeedUpdateUI
	Do we need to update the display ?

CrystMutex	mMutex
	Mutex used to lock data when preparing to update the UI in non-main thread.

std::set< WXCrystObjBasicList * >	mvpList
	WXCrystObjBasicList which are aware of this object, and which should be told on destruction. More...

Detailed Description

Base class for all displayed ObjCryst objects (with a title, and a sizer to stack objects).

A button (which should be used to collapse the object) is used to create an indentation for the sub-objects.

Todo:: Allow the objects to be collabsable. The difficulty is that even if the object is not shown, it is not removed by the Sizer as long as it is not deleted... Needs some testing ! Otherwise it would also be possible to delete and re-create sub-objects when collapsing, but that would be more difficult.

Definition at line 248 of file wxCryst.h.

Member Function Documentation

void ObjCryst::WXCrystObj::AddChild	(	WXCrystObjBasic *	pChild,
		bool	doBottomLayout = `true`
	)

virtual

Notify that a new children has been added, also adding it to the correct sizer (which can be the top sizer or not).

Parameters

doBottomLayout ask for a new Layout of the window and of its parents.

Reimplemented from ObjCryst::WXCrystObjBasic.

Definition at line 855 of file wxCryst.cpp.

void ObjCryst::WXCrystObj::CrystUpdate	(	const bool	updateUI = `false`,
		const bool	mutexlock = `false`
	)

virtual

Get new values to be displayed from the underlying object, and raise flag if an UI update is necessary.

The actual GUI update is not made here. UpdateUI() should be called separately, from the main thread.

Parameters

updateUI	if true, this will call UpdateUI, either directly (if in the main thread), or by sending a message.
mutexlock	if true, a Mutex will be used to lock the data shared between main and background thread. The idea is to only use a few Mutexes to lock data from the top objects (wxRefinableObj,...), when calling CrystUpdate() and UpdateUI(). As sub-objects (WXField,...) are only updated from within a top object, the mutex lock in the top object will also lock the data in the sub-objects.

Implements ObjCryst::WXCrystObjBasic.

Reimplemented in ObjCryst::WXPowderPatternDiffraction, ObjCryst::WXPowderPatternBackground, ObjCryst::WXMolecule, ObjCryst::WXRefinableObj, ObjCryst::WXCrystal, ObjCryst::WXOptimizationObj, ObjCryst::WXPowderPattern, and ObjCryst::WXDiffractionSingleCrystal.

Definition at line 826 of file wxCryst.cpp.

virtual bool ObjCryst::WXCrystObj::OnChangeName ( const int id )

pure virtual

When a WXFieldName has been changed by the user, it is handled here.

This returns true if the value has been handled (for inheritance purposes).

Implemented in ObjCryst::WXProfileDoubleExponentialPseudoVoigt, ObjCryst::WXProfilePseudoVoigtAnisotropic, ObjCryst::WXProfilePseudoVoigt, ObjCryst::WXTextureEllipsoid, ObjCryst::WXRefinableObj, ObjCryst::WXRegistry< T >, ObjCryst::WXRegistry< ObjCryst::Scatterer >, ObjCryst::WXRegistry< ObjCryst::PowderPatternComponent >, ObjCryst::WXRegistry< ObjCryst::ZAtom >, ObjCryst::WXRegistry< ObjCryst::ScatteringPower >, ObjCryst::WXCrystal, ObjCryst::WXOptimizationObj, ObjCryst::WXLSQ, ObjCryst::WXScatteringPowerAtom, and ObjCryst::WXScatteringPowerSphere.

void ObjCryst::WXCrystObj::OnToggleCollapse ( wxCommandEvent & WXUNUSEDevent )

Only display the title, and collapse everything else.

Bug:: : the windows do collapse, but the size of the window is not changed, so it is pretty useless so far...

Definition at line 813 of file wxCryst.cpp.

void ObjCryst::WXCrystObj::UpdateUI ( const bool mutexlock = false )

virtual

Update the User Interface, if necessary.

Parameters

mutexlock if true, a Mutex will be used to lock the data shared between main and background thread.

The idea is to only use a few Mutexes to lock data from the top objects (wxRefinableObj,...), when calling CrystUpdate() and UpdateUI(). As sub-objects (WXField,...) are only updated from within a top object, the mutex lock in the top object will also lock the data in the sub-objects.

Implements ObjCryst::WXCrystObjBasic.

Reimplemented in ObjCryst::WXPowderPatternDiffraction, ObjCryst::WXPowderPatternBackground, ObjCryst::WXMolecule, ObjCryst::WXRefinableObj, ObjCryst::WXCrystal, ObjCryst::WXPowderPattern, ObjCryst::WXOptimizationObj, ObjCryst::WXAtom, ObjCryst::WXDiffractionSingleCrystal, ObjCryst::WXScatteringPowerAtom, and ObjCryst::WXScatteringPowerSphere.

Definition at line 834 of file wxCryst.cpp.

The documentation for this class was generated from the following files:

Public Member Functions

Protected Attributes

Detailed Description

Member Function Documentation