scriptforge.SFDialogs.SF_DialogControl Class Reference

Inheritance diagram for scriptforge.SFDialogs.SF_DialogControl:

Collaboration diagram for scriptforge.SFDialogs.SF_DialogControl:

Public Member Functions
def	CurrentNode (self)
def	RootNode (self)
def	AddSubNode (self, parentnode, displayvalue, datavalue=ScriptForge.cstSymEmpty)
def	AddSubTree (self, parentnode, flattree, withdatavalue=False)
def	CreateRoot (self, displayvalue, datavalue=ScriptForge.cstSymEmpty)
def	FindNode (self, displayvalue, datavalue=ScriptForge.cstSymEmpty, casesensitive=False)
def	Resize (self, left=-99999, top=-99999, width=-1, height=-1)
def	SetFocus (self)
def	SetTableData (self, dataarray, widths=(1,), alignments='', rowheaderwidth=10)
def	WriteLine (self, line='')
Public Member Functions inherited from scriptforge.SFServices
def	__init__ (self, reference=-1, objtype=None, classmodule=0, name='')
def	__getattr__ (self, name)
def	__setattr__ (self, name, value)
def	__repr__ (self)
def	Dispose (self)
def	ExecMethod (self, flags=0, methodname='', *args)
def	GetProperty (self, propertyname, arg=None)
def	Properties (self)
def	basicmethods (self)
def	basicproperties (self)
def	SetProperty (self, propertyname, value)

Static Public Attributes
string	serviceimplementation = 'basic'
string	servicename = 'SFDialogs.DialogControl'
tuple	servicesynonyms = ()
	serviceproperties
Static Public Attributes inherited from scriptforge.SFServices
	vbGet
	vbLet
	vbMethod
	vbSet
int	flgPost = 32
int	flgDateArg = 64
int	flgDateRet = 128
int	flgArrayArg = 512
int	flgArrayRet = 1024
int	flgUno = 256
int	flgObject = 2048
int	flgHardCode = 4096
	moduleClass
	moduleStandard
bool	forceGetProperty = False
dictionary	propertysynonyms = {}
tuple	internal_attributes
	SIMPLEEXEC = ScriptForge.InvokeSimpleScript
	EXEC = ScriptForge.InvokeBasicService

Additional Inherited Members
Public Attributes inherited from scriptforge.SFServices
	objectreference
	objecttype
	classmodule
	name
	internal
	localProperties
	serviceimplementation

Detailed Description

    Each instance of the current class represents a single control within a dialog box.
    The focus is clearly set on getting and setting the values displayed by the controls of the dialog box,
    not on their formatting.
    A special attention is given to controls with type TreeControl.

Definition at line 2035 of file scriptforge.py.

Member Function Documentation

AddSubNode()

def scriptforge.SFDialogs.SF_DialogControl.AddSubNode	(		self,
			parentnode,
			displayvalue,
			datavalue = ScriptForge.cstSymEmpty
	)

Definition at line 2069 of file scriptforge.py.

References scriptforge.SFServices.ExecMethod(), sfx2::SfxNotebookBar.ExecMethod(), scriptforge.SFServices.flgUno, and scriptforge.SFServices.vbMethod.

AddSubTree()

def scriptforge.SFDialogs.SF_DialogControl.AddSubTree	(		self,
			parentnode,
			flattree,
			withdatavalue = False
	)

Definition at line 2072 of file scriptforge.py.

References scriptforge.SFServices.ExecMethod(), sfx2::SfxNotebookBar.ExecMethod(), and scriptforge.SFServices.vbMethod.

CreateRoot()

def scriptforge.SFDialogs.SF_DialogControl.CreateRoot	(		self,
			displayvalue,
			datavalue = ScriptForge.cstSymEmpty
	)

Definition at line 2075 of file scriptforge.py.

References scriptforge.SFServices.ExecMethod(), sfx2::SfxNotebookBar.ExecMethod(), scriptforge.SFServices.flgUno, and scriptforge.SFServices.vbMethod.

CurrentNode()

def scriptforge.SFDialogs.SF_DialogControl.CurrentNode

(

self

)

Definition at line 2062 of file scriptforge.py.

References scriptforge.SFServices.EXEC, scriptforge.SFServices.flgUno, access2base._BasicObject.objectreference, scriptforge.SFServices.objectreference, and scriptforge.SFServices.vbGet.

FindNode()

def scriptforge.SFDialogs.SF_DialogControl.FindNode	(		self,
			displayvalue,
			datavalue = ScriptForge.cstSymEmpty,
			casesensitive = False
	)

Definition at line 2078 of file scriptforge.py.

References scriptforge.SFServices.ExecMethod(), sfx2::SfxNotebookBar.ExecMethod(), scriptforge.SFServices.flgUno, and scriptforge.SFServices.vbMethod.

Resize()

def scriptforge.SFDialogs.SF_DialogControl.Resize	(		self,
			left = -99999,
			top = -99999,
			width = -1,
			height = -1
	)

Definition at line 2081 of file scriptforge.py.

References scriptforge.SFServices.ExecMethod(), sfx2::SfxNotebookBar.ExecMethod(), and scriptforge.SFServices.vbMethod.

RootNode()

def scriptforge.SFDialogs.SF_DialogControl.RootNode

(

self

)

Definition at line 2066 of file scriptforge.py.

References scriptforge.SFServices.EXEC, scriptforge.SFServices.flgUno, access2base._BasicObject.objectreference, scriptforge.SFServices.objectreference, and scriptforge.SFServices.vbGet.

SetFocus()

def scriptforge.SFDialogs.SF_DialogControl.SetFocus

(

self

)

Definition at line 2084 of file scriptforge.py.

References scriptforge.SFServices.ExecMethod(), sfx2::SfxNotebookBar.ExecMethod(), and scriptforge.SFServices.vbMethod.

SetTableData()

def scriptforge.SFDialogs.SF_DialogControl.SetTableData	(		self,
			dataarray,
			widths = (1,),
			alignments = '',
			rowheaderwidth = 10
	)

Definition at line 2087 of file scriptforge.py.

References scriptforge.SFServices.ExecMethod(), sfx2::SfxNotebookBar.ExecMethod(), scriptforge.SFServices.flgArrayArg, and scriptforge.SFServices.vbMethod.

WriteLine()

def scriptforge.SFDialogs.SF_DialogControl.WriteLine	(		self,
			line = ''
	)

Definition at line 2091 of file scriptforge.py.

References scriptforge.SFServices.ExecMethod(), sfx2::SfxNotebookBar.ExecMethod(), and scriptforge.SFServices.vbMethod.

Member Data Documentation

serviceimplementation

string scriptforge.SFDialogs.SF_DialogControl.serviceimplementation = 'basic'

static

Definition at line 2043 of file scriptforge.py.

Referenced by scriptforge.SFServices.__repr__(), scriptforge.SFServices.__setattr__(), scriptforge.SFServices.basicmethods(), scriptforge.SFServices.basicproperties(), scriptforge.SFServices.Dispose(), scriptforge.SFServices.GetProperty(), and scriptforge.SFServices.SetProperty().

servicename

string scriptforge.SFDialogs.SF_DialogControl.servicename = 'SFDialogs.DialogControl'

static

Definition at line 2044 of file scriptforge.py.

Referenced by scriptforge.ScriptForge.__init__(), and scriptforge.SFServices.__repr__().

serviceproperties

scriptforge.SFDialogs.SF_DialogControl.serviceproperties

static

Initial value:

=  dict(Border = True, Cancel = True, Caption = True, ControlType = False, CurrentNode = True,
                                 Default = True, Enabled = True, Format = True, Height = True, ListCount = False,
                                 ListIndex = True, Locked = True, MultiSelect = True, Name = False,
                                 OnActionPerformed = True, OnAdjustmentValueChanged = True, OnFocusGained = True,
                                 OnFocusLost = True, OnItemStateChanged = True, OnKeyPressed = True,
                                 OnKeyReleased = True, OnMouseDragged = True, OnMouseEntered = True,
                                 OnMouseExited = True, OnMouseMoved = True, OnMousePressed = True,
                                 OnMouseReleased = True, OnNodeExpanded = True, OnNodeSelected = True,
                                 OnTextChanged = True, Page = True, Parent = False, Picture = True,
                                 RootNode = False, RowSource = True, TabIndex = True, Text = False, TipText = True,
                                 TripleState = True, URL = True, Value = True, Visible = True, Width = True,
                                 X = True, Y = True, XControlModel = False, XControlView = False,
                                 XGridColumnModel = False, XGridDataModel = False, XTreeDataModel = False)

Definition at line 2046 of file scriptforge.py.

Referenced by scriptforge.SFServices.__setattr__(), and scriptforge.SFServices.Properties().

servicesynonyms

tuple scriptforge.SFDialogs.SF_DialogControl.servicesynonyms = ()

static

Definition at line 2045 of file scriptforge.py.

---

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

• scriptforge.py