Inheritance diagram for scriptforge.SFServices:

Collaboration diagram for scriptforge.SFServices:

Public Member Functions
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)

Public Attributes
	objectreference

	objecttype

	classmodule

	name

	internal

	localProperties

	serviceimplementation

Static Public Attributes
	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

Detailed Description

    Generic implementation of a parent Service class
    Every service must subclass this class to be recognized as a valid service
    A service instance is created by the CreateScriptService method
    It can have a mirror in the Basic world or be totally defined in Python

    Every subclass must initialize 3 class properties:
        servicename (e.g. 'ScriptForge.FileSystem', 'ScriptForge.Basic')
        servicesynonyms (e.g. 'FileSystem', 'Basic')
        serviceimplementation: either 'python' or 'basic'
    This is sufficient to register the service in the Python world

    The communication with Basic is managed by 2 ScriptForge() methods:
        InvokeSimpleScript(): low level invocation of a Basic script. This script must be located
            in a usual Basic module. The result is passed as-is
        InvokeBasicService(): the result comes back encapsulated with additional info
            The result is interpreted in the method
            The invoked script can be a property or a method of a Basic class or usual module
    It is up to every service method to determine which method to use

    For Basic services only:
        Each instance is identified by its
            - object reference: the real Basic object embedded as a UNO wrapper object
            - object type ('SF_String', 'DICTIONARY', ...)
            - class module: 1 for usual modules, 2 for class modules
            - name (form, control, ... name) - may be blank

        The role of the SFServices() superclass is mainly to propose a generic properties management
        Properties are got and set following next strategy:
            1. Property names are controlled strictly ('Value' or 'value', not 'VALUE')
            2. Getting a property value for the first time is always done via a Basic call
            3. Next occurrences are fetched from the Python dictionary of the instance if the property
               is read-only, otherwise via a Basic call
            4. Read-only properties may be modified or deleted exceptionally by the class
               when self.internal == True. The latter must immediately be reset after use

        Each subclass must define its interface with the user scripts:
        1.  The properties
            Property names are proper-cased
            Conventionally, camel-cased and lower-cased synonyms are supported where relevant
                a dictionary named 'serviceproperties' with keys = (proper-cased) property names and value = boolean
                    True = editable, False = read-only
                a list named 'localProperties' reserved to properties for internal use
                    e.g. oDlg.Controls() is a method that uses '_Controls' to hold the list of available controls
            When
                forceGetProperty = False    # Standard behaviour
            read-only serviceproperties are buffered in Python after their 1st get request to Basic
            Otherwise set it to True to force a recomputation at each property getter invocation
            If there is a need to handle a specific property in a specific manner:
                @property
                def myProperty(self):
                    return self.GetProperty('myProperty')
        2   The methods
            a usual def: statement
                def myMethod(self, arg1, arg2 = ''):
                    return self.Execute(self.vbMethod, 'myMethod', arg1, arg2)
            Method names are proper-cased, arguments are lower-cased
            Conventionally, camel-cased and lower-cased homonyms are supported where relevant
            All arguments must be present and initialized before the call to Basic, if any

Definition at line 389 of file scriptforge.py.

Constructor & Destructor Documentation

◆ init()

def scriptforge.SFServices.__init__	(	self,
		reference = `-1`,
		objtype = `None`,
		classmodule = `0`,
		name = `''`
	)

    Trivial initialization of internal properties
    If the subclass has its own __init()__ method, a call to this one should be its first statement.
    Afterwards localProperties should be filled with the list of its own properties

Reimplemented in scriptforge.SFScriptForge.SF_Dictionary.

Definition at line 475 of file scriptforge.py.

Referenced by scriptforge.SFServices.__setattr__().

Member Function Documentation

◆ getattr()

def scriptforge.SFServices.__getattr__	(	self,
		name
	)

    Executed for EVERY property reference if name not yet in the instance dict
    At the 1st get, the property value is always got from Basic
    Due to the use of lower/camelcase synonyms, it is called for each variant of the same property
    The method manages itself the buffering in __dict__ based on the official ProperCase property name

Definition at line 488 of file scriptforge.py.

References scriptforge.SFServices.propertysynonyms.

◆ repr()

def scriptforge.SFServices.__repr__ ( self )

Definition at line 543 of file scriptforge.py.

Referenced by scriptforge.SFServices.__repr__().

◆ setattr()

def scriptforge.SFServices.__setattr__	(	self,
		name,
		value
	)

    Executed for EVERY property assignment, including in __init__() !!
    Setting a property requires for serviceproperties() to be executed in Basic
    Management of __dict__ is automatically done in the final usual object.__setattr__ method

Definition at line 515 of file scriptforge.py.

Referenced by access2base._BasicObject.setProperty().

◆ basicmethods()

def scriptforge.SFServices.basicmethods ( self )

Definition at line 575 of file scriptforge.py.

◆ basicproperties()

def scriptforge.SFServices.basicproperties ( self )

Definition at line 581 of file scriptforge.py.

◆ Dispose()

def scriptforge.SFServices.Dispose ( self )

Definition at line 547 of file scriptforge.py.

◆ ExecMethod()

def scriptforge.SFServices.ExecMethod	(		self,
			flags = `0`,
			methodname = `''`,
		*	args
	)

Definition at line 553 of file scriptforge.py.

References scriptforge.SFServices.EXEC, access2base._BasicObject.objectreference, scriptforge.SFServices.objectreference, and scriptforge.SFServices.vbMethod.

◆ GetProperty()

def scriptforge.SFServices.GetProperty	(	self,
		propertyname,
		arg = `None`
	)

    Get the given property from the Basic world

Definition at line 559 of file scriptforge.py.

◆ Properties()

def scriptforge.SFServices.Properties ( self )

Definition at line 572 of file scriptforge.py.

◆ SetProperty()

def scriptforge.SFServices.SetProperty	(	self,
		propertyname,
		value
	)

    Set the given property to a new value in the Basic world

Definition at line 587 of file scriptforge.py.

Referenced by scriptforge.SFServices.__setattr__().

Member Data Documentation

◆ classmodule

scriptforge.SFServices.classmodule

Definition at line 483 of file scriptforge.py.

◆ EXEC

scriptforge.SFServices.EXEC = ScriptForge.InvokeBasicService

static

Definition at line 473 of file scriptforge.py.

Referenced by scriptforge.SFDialogs.SF_DialogControl.CurrentNode(), scriptforge.SFServices.ExecMethod(), scriptforge.SFServices.GetProperty(), scriptforge.SFDialogs.SF_DialogControl.RootNode(), and scriptforge.SFServices.SetProperty().

◆ flgArrayArg

int scriptforge.SFServices.flgArrayArg = 512

static

Definition at line 455 of file scriptforge.py.

Referenced by scriptforge.SFDocuments.SF_Calc.SetArray(), scriptforge.SFDocuments.SF_Calc.SetFormula(), scriptforge.SFDialogs.SF_DialogControl.SetTableData(), and scriptforge.SFDocuments.SF_Calc.SetValue().

◆ flgArrayRet

int scriptforge.SFServices.flgArrayRet = 1024

static

Definition at line 456 of file scriptforge.py.

◆ flgDateArg

int scriptforge.SFServices.flgDateArg = 64

static

Definition at line 453 of file scriptforge.py.

Referenced by scriptforge.SFDialogs.SF_Dialog.CreateDateField(), scriptforge.SFDialogs.SF_Dialog.CreateTimeField(), scriptforge.SFScriptForge.SF_Region.DSTOffset(), scriptforge.SFScriptForge.SF_Region.LocalDateTime(), scriptforge.SFServices.SetProperty(), and scriptforge.SFScriptForge.SF_Region.UTCDateTime().

◆ flgDateRet

int scriptforge.SFServices.flgDateRet = 128

static

Definition at line 454 of file scriptforge.py.

Referenced by scriptforge.SFScriptForge.SF_FileSystem.GetFileModified(), scriptforge.SFScriptForge.SF_Region.LocalDateTime(), scriptforge.SFScriptForge.SF_Region.UTCDateTime(), and scriptforge.SFScriptForge.SF_Region.UTCNow().

◆ flgHardCode

int scriptforge.SFServices.flgHardCode = 4096

static

Definition at line 459 of file scriptforge.py.

Referenced by scriptforge.SFDialogs.SF_Dialog.Activate(), scriptforge.SFDialogs.SF_Dialog.Center(), scriptforge.SFDialogs.SF_Dialog.Controls(), scriptforge.SFDialogs.SF_Dialog.EndExecute(), scriptforge.SFDialogs.SF_Dialog.Execute(), and scriptforge.SFDialogs.SF_Dialog.Resize().

◆ flgObject

int scriptforge.SFServices.flgObject = 2048

static

Definition at line 458 of file scriptforge.py.

Referenced by scriptforge.SFScriptForge.SF_L10N.AddTextsFromDialog(), scriptforge.SFDialogs.SF_Dialog.Center(), scriptforge.SFDocuments.SF_Calc.CopySheet(), scriptforge.SFDocuments.SF_Calc.CopySheetFromFile(), scriptforge.SFDocuments.SF_Calc.CopyToCell(), scriptforge.SFDocuments.SF_Calc.CopyToRange(), and scriptforge.SFDialogs.SF_Dialog.GetTextsFromL10N().

◆ flgPost

int scriptforge.SFServices.flgPost = 32

static

Definition at line 452 of file scriptforge.py.

◆ flgUno

int scriptforge.SFServices.flgUno = 256

static

Definition at line 457 of file scriptforge.py.

Referenced by scriptforge.SFDialogs.SF_DialogControl.AddSubNode(), scriptforge.SFDialogs.SF_DialogControl.CreateRoot(), scriptforge.SFDialogs.SF_DialogControl.CurrentNode(), scriptforge.SFDialogs.SF_DialogControl.FindNode(), scriptforge.SFServices.GetProperty(), scriptforge.SFDialogs.SF_DialogControl.RootNode(), scriptforge.SFServices.SetProperty(), scriptforge.SFDocuments.SF_Calc.XCellRange(), scriptforge.SFDocuments.SF_Calc.XSheetCellCursor(), and scriptforge.SFDocuments.SF_Calc.XSpreadsheet().

◆ forceGetProperty

bool scriptforge.SFServices.forceGetProperty = False

static

Definition at line 464 of file scriptforge.py.

◆ internal

scriptforge.SFServices.internal

Definition at line 485 of file scriptforge.py.

Referenced by access2base._BasicObject.__setattr__(), scriptforge.SFServices.__setattr__(), and access2base._BasicObject._Reset().

◆ internal_attributes

tuple scriptforge.SFServices.internal_attributes

static

Initial value:

= ('objectreference', 'objecttype', 'name', 'internal', 'servicename',

'serviceimplementation', 'classmodule', 'EXEC', 'SIMPLEEXEC')

Definition at line 469 of file scriptforge.py.

Referenced by access2base._BasicObject.__setattr__(), and scriptforge.SFServices.__setattr__().

◆ localProperties

scriptforge.SFServices.localProperties

Definition at line 486 of file scriptforge.py.

Referenced by access2base._BasicObject.__setattr__(), and scriptforge.SFServices.__setattr__().

◆ moduleClass

scriptforge.SFServices.moduleClass

static

Definition at line 461 of file scriptforge.py.

◆ moduleStandard

scriptforge.SFServices.moduleStandard

static

Definition at line 461 of file scriptforge.py.

◆ name

scriptforge.SFServices.name

Definition at line 484 of file scriptforge.py.

Referenced by access2base._BasicObject.__repr__().

◆ objectreference

scriptforge.SFServices.objectreference

Definition at line 481 of file scriptforge.py.

◆ objecttype

scriptforge.SFServices.objecttype

Definition at line 482 of file scriptforge.py.

Referenced by access2base._BasicObject.__repr__(), access2base._BasicObject.__setattr__(), scriptforge.SFServices.__setattr__(), and access2base._BasicObject.setProperty().

◆ propertysynonyms

dictionary scriptforge.SFServices.propertysynonyms = {}

static

Definition at line 466 of file scriptforge.py.

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

◆ serviceimplementation

scriptforge.SFServices.serviceimplementation

Definition at line 497 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().

◆ SIMPLEEXEC

scriptforge.SFServices.SIMPLEEXEC = ScriptForge.InvokeSimpleScript

static

Definition at line 472 of file scriptforge.py.

◆ vbGet

scriptforge.SFServices.vbGet

static

Definition at line 451 of file scriptforge.py.

Referenced by scriptforge.SFDialogs.SF_DialogControl.CurrentNode(), scriptforge.SFServices.GetProperty(), scriptforge.SFDialogs.SF_DialogControl.RootNode(), scriptforge.SFDocuments.SF_Calc.XCellRange(), scriptforge.SFDocuments.SF_Calc.XSheetCellCursor(), and scriptforge.SFDocuments.SF_Calc.XSpreadsheet().

◆ vbLet

scriptforge.SFServices.vbLet

static

Definition at line 451 of file scriptforge.py.

Referenced by scriptforge.SFServices.SetProperty().

◆ vbMethod

scriptforge.SFServices.vbMethod

static

Definition at line 451 of file scriptforge.py.

◆ vbSet

scriptforge.SFServices.vbSet

static

Definition at line 451 of file scriptforge.py.

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

scriptforge.py

Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ __getattr__()

◆ __repr__()

◆ __setattr__()

◆ basicmethods()

◆ basicproperties()

◆ Dispose()

◆ ExecMethod()

◆ GetProperty()

◆ Properties()

◆ SetProperty()

Member Data Documentation

◆ classmodule

◆ EXEC

◆ flgArrayArg

◆ flgArrayRet

◆ flgDateArg

◆ flgDateRet

◆ flgHardCode

◆ flgObject

◆ flgPost

◆ flgUno

◆ forceGetProperty

◆ internal

◆ internal_attributes

◆ localProperties

◆ moduleClass

◆ moduleStandard

◆ name

◆ objectreference

◆ objecttype

◆ propertysynonyms

◆ serviceimplementation

◆ SIMPLEEXEC

◆ vbGet

◆ vbLet

◆ vbMethod

◆ vbSet

◆ init()

◆ getattr()

◆ repr()

◆ setattr()