dectris.albula.DMainFrame Class Reference

class DMainFrame represents a graphical unit that contains DSubFrames Open a DMainFrame via openMainFrame(). More...

Inheritance diagram for dectris.albula.DMainFrame:

Public Member Functions
def	__init__ (self, viewerClient, objID)
def	openSubFrame (self, hideToolButtons=False, title=None)
	Open a DSubFrame within the DMainFrame. More...
def	showToolBar (self)
	Show ToolBar. More...
def	hideToolBar (self)
	Hide ToolBar. More...
def	enableClose (self)
	If called, clicking exit button closes DMainFrame. More...
def	disableClose (self)
	If called, clicking exit button does not close DMainFrame. More...
def	enableKeyboardShortcuts (self)
	Enable keyboard shortcuts. More...
def	disableKeyboardShortcuts (self)
	Disable keyboard shortcuts. More...
def	subFrames (self)
	Returns a list of open DSubFrames within that DMainFrame. More...
def	synchronizeViewport (self, flag)
	Toggles viewport synchronization between DSubFrames. More...
def	synchronizeContrast (self, flag)
	Toggles contrast synchronization between DSubFrames. More...
def	synchronizeStatistics (self, flag)
	Toggles statistics synchronization between DSubFrames. More...
Public Member Functions inherited from dectris.albula.DFrame
def	viewerClient (self)
def	objID (self)
def	close (self)
	Closes the Frame. More...
def	waitForClose (self)
	Blocks until object is closed by user. More...
def	sendCommand (self, command, argList=list())

Detailed Description

class DMainFrame represents a graphical unit that contains DSubFrames Open a DMainFrame via openMainFrame().

Constructor & Destructor Documentation

__init__()

def dectris.albula.DMainFrame.__init__	(		self,
			viewerClient,
			objID
	)

Reimplemented from dectris.albula.DFrame.

Member Function Documentation

disableClose()

def dectris.albula.DMainFrame.disableClose

(

self

)

If called, clicking exit button does not close DMainFrame.

DFrame.close() is not affected. See DMainFrame.enableClose().

disableKeyboardShortcuts()

def dectris.albula.DMainFrame.disableKeyboardShortcuts

(

self

)

Disable keyboard shortcuts.

When keyboard shortcuts are enabled the user may set the contrast, go through the image series and resize the image via shortcuts

enableClose()

def dectris.albula.DMainFrame.enableClose

(

self

)

If called, clicking exit button closes DMainFrame.

This is default. See disableClose().

enableKeyboardShortcuts()

def dectris.albula.DMainFrame.enableKeyboardShortcuts

(

self

)

Enable keyboard shortcuts.

When keyboard shortcuts are enabled the user may set the contrast, go through the image series and resize the image via shortcuts. See also disableKeybordShort

hideToolBar()

def dectris.albula.DMainFrame.hideToolBar

(

self

)

Hide ToolBar.

Beamline scientists may want to prevent users from changing the settings in the Albula ToolBar.

openSubFrame()

def dectris.albula.DMainFrame.openSubFrame	(		self,
			hideToolButtons = False,
			title = None
	)

Open a DSubFrame within the DMainFrame.

Parameters

hideToolButtons	If set, hide the tool buttons of the DSubFrame. See DSubFrame.showToolButtons and DSubFrame.hideToolButtons.
title	String that will be displayed in the title bar. If title is set, the DSubFrame does no longer show the file path to the loaded image. Restore the default behaviour by calling unsetTitle(). See also DSubFrame.setTitle() and DSubFrame.unsetTitle().

showToolBar()

def dectris.albula.DMainFrame.showToolBar

(

self

)

Show ToolBar.

See hideToolBar().

subFrames()

def dectris.albula.DMainFrame.subFrames

(

self

)

Returns a list of open DSubFrames within that DMainFrame.

Note these DSubFrames are not necessarily identical to those explicitely opened by openSubFrame(), because the user may open and close DSubFrames himself.

synchronizeContrast()

def dectris.albula.DMainFrame.synchronizeContrast	(		self,
			flag
	)

Toggles contrast synchronization between DSubFrames.

Parameters

flag	Eiter True or False

synchronizeStatistics()

def dectris.albula.DMainFrame.synchronizeStatistics	(		self,
			flag
	)

Toggles statistics synchronization between DSubFrames.

Parameters

flag	Eiter True or False

synchronizeViewport()

def dectris.albula.DMainFrame.synchronizeViewport	(		self,
			flag
	)

Toggles viewport synchronization between DSubFrames.

Parameters

flag	Eiter True or False