Inheritance diagram for scriptforge.SFScriptForge.SF_UI:

Collaboration diagram for scriptforge.SFScriptForge.SF_UI:

Public Member Functions
def	ActiveWindow (self)

def	Activate (self, windowname='')

def	CreateBaseDocument (self, filename, embeddeddatabase='HSQLDB', registrationname='', calcfilename='')

def	CreateDocument (self, documenttype='', templatefile='', hidden=False)

def	Documents (self)

def	GetDocument (self, windowname='')

def	Maximize (self, windowname='')

def	Minimize (self, windowname='')

def	OpenBaseDocument (self, filename='', registrationname='', macroexecution=MACROEXECNORMAL)

def	OpenDocument (self, filename, password='', readonly=False, hidden=False, macroexecution=MACROEXECNORMAL, filtername='', filteroptions='')

def	Resize (self, left=-1, top=-1, width=-1, height=-1)

def	RunCommand (self, command, args, *kwargs)

def	SetStatusbar (self, text='', percentage=-1)

def	ShowProgressBar (self, title='', text='', percentage=-1)

def	WindowExists (self, windowname)

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)

Public Member Functions inherited from scriptforge._Singleton
def	__call__ (cls, args, *kwargs)

Static Public Attributes
string	serviceimplementation = 'basic'

string	servicename = 'ScriptForge.UI'

tuple	servicesynonyms = ('ui', 'scriptforge.ui')

	serviceproperties = dict(ActiveWindow = False, Height = False, Width = False, X = False, Y = False)

	MACROEXECALWAYS

	MACROEXECNEVER

	MACROEXECNORMAL

	BASEDOCUMENT

	CALCDOCUMENT

	DRAWDOCUMENT

	IMPRESSDOCUMENT

	MATHDOCUMENT

	WRITERDOCUMENT

	activeWindow

	activewindow

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

Static Public Attributes inherited from scriptforge._Singleton
dictionary	instances = {}

Additional Inherited Members
Public Attributes inherited from scriptforge.SFServices
	objectreference

	objecttype

	classmodule

	name

	internal

	localProperties

	serviceimplementation

Detailed Description

    Singleton class for the identification and the manipulation of the
    different windows composing the whole LibreOffice application:
        - Windows selection
        - Windows moving and resizing
        - Statusbar settings
        - Creation of new windows
        - Access to the underlying "documents"

Definition at line 1625 of file scriptforge.py.

Member Function Documentation

◆ Activate()

def scriptforge.SFScriptForge.SF_UI.Activate	(	self,
		windowname = `''`
	)

Definition at line 1652 of file scriptforge.py.

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

◆ ActiveWindow()

def scriptforge.SFScriptForge.SF_UI.ActiveWindow ( self )

Definition at line 1647 of file scriptforge.py.

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

◆ CreateBaseDocument()

def scriptforge.SFScriptForge.SF_UI.CreateBaseDocument	(	self,
		filename,
		embeddeddatabase = `'HSQLDB'`,
		registrationname = `''`,
		calcfilename = `''`
	)

Definition at line 1655 of file scriptforge.py.

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

◆ CreateDocument()

def scriptforge.SFScriptForge.SF_UI.CreateDocument	(	self,
		documenttype = `''`,
		templatefile = `''`,
		hidden = `False`
	)

Definition at line 1659 of file scriptforge.py.

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

◆ Documents()

def scriptforge.SFScriptForge.SF_UI.Documents ( self )

Definition at line 1662 of file scriptforge.py.

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

◆ GetDocument()

def scriptforge.SFScriptForge.SF_UI.GetDocument	(	self,
		windowname = `''`
	)

Definition at line 1665 of file scriptforge.py.

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

◆ Maximize()

def scriptforge.SFScriptForge.SF_UI.Maximize	(	self,
		windowname = `''`
	)

Definition at line 1668 of file scriptforge.py.

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

◆ Minimize()

def scriptforge.SFScriptForge.SF_UI.Minimize	(	self,
		windowname = `''`
	)

Definition at line 1671 of file scriptforge.py.

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

◆ OpenBaseDocument()

def scriptforge.SFScriptForge.SF_UI.OpenBaseDocument	(	self,
		filename = `''`,
		registrationname = `''`,
		macroexecution = `MACROEXECNORMAL`
	)

Definition at line 1674 of file scriptforge.py.

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

◆ OpenDocument()

def scriptforge.SFScriptForge.SF_UI.OpenDocument	(	self,
		filename,
		password = `''`,
		readonly = `False`,
		hidden = `False`,
		macroexecution = `MACROEXECNORMAL`,
		filtername = `''`,
		filteroptions = `''`
	)

Definition at line 1677 of file scriptforge.py.

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

◆ Resize()

def scriptforge.SFScriptForge.SF_UI.Resize	(	self,
		left = `-1`,
		top = `-1`,
		width = `-1`,
		height = `-1`
	)

Definition at line 1682 of file scriptforge.py.

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

◆ RunCommand()

def scriptforge.SFScriptForge.SF_UI.RunCommand	(		self,
			command,
		*	args,
		**	kwargs
	)

Definition at line 1685 of file scriptforge.py.

References scriptforge.SFServices.SIMPLEEXEC.

◆ SetStatusbar()

def scriptforge.SFScriptForge.SF_UI.SetStatusbar	(	self,
		text = `''`,
		percentage = `-1`
	)

Definition at line 1693 of file scriptforge.py.

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

◆ ShowProgressBar()

def scriptforge.SFScriptForge.SF_UI.ShowProgressBar	(	self,
		title = `''`,
		text = `''`,
		percentage = `-1`
	)

Definition at line 1696 of file scriptforge.py.

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

◆ WindowExists()

def scriptforge.SFScriptForge.SF_UI.WindowExists	(	self,
		windowname
	)

Definition at line 1701 of file scriptforge.py.

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

Member Data Documentation

◆ activeWindow

scriptforge.SFScriptForge.SF_UI.activeWindow

static

Definition at line 1650 of file scriptforge.py.

◆ activewindow

scriptforge.SFScriptForge.SF_UI.activewindow

static

Definition at line 1650 of file scriptforge.py.

◆ BASEDOCUMENT

scriptforge.SFScriptForge.SF_UI.BASEDOCUMENT

static

Definition at line 1643 of file scriptforge.py.

◆ CALCDOCUMENT

scriptforge.SFScriptForge.SF_UI.CALCDOCUMENT

static

Definition at line 1643 of file scriptforge.py.

◆ DRAWDOCUMENT

scriptforge.SFScriptForge.SF_UI.DRAWDOCUMENT

static

Definition at line 1643 of file scriptforge.py.

◆ IMPRESSDOCUMENT

scriptforge.SFScriptForge.SF_UI.IMPRESSDOCUMENT

static

Definition at line 1643 of file scriptforge.py.

◆ MACROEXECALWAYS

scriptforge.SFScriptForge.SF_UI.MACROEXECALWAYS

static

Definition at line 1642 of file scriptforge.py.

◆ MACROEXECNEVER

scriptforge.SFScriptForge.SF_UI.MACROEXECNEVER

static

Definition at line 1642 of file scriptforge.py.

◆ MACROEXECNORMAL

scriptforge.SFScriptForge.SF_UI.MACROEXECNORMAL

static

Definition at line 1642 of file scriptforge.py.

◆ MATHDOCUMENT

scriptforge.SFScriptForge.SF_UI.MATHDOCUMENT

static

Definition at line 1643 of file scriptforge.py.

◆ serviceimplementation

string scriptforge.SFScriptForge.SF_UI.serviceimplementation = 'basic'

static

Definition at line 1636 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.SFScriptForge.SF_UI.servicename = 'ScriptForge.UI'

static

Definition at line 1637 of file scriptforge.py.

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

◆ serviceproperties

scriptforge.SFScriptForge.SF_UI.serviceproperties = dict(ActiveWindow = False, Height = False, Width = False, X = False, Y = False)

static

Definition at line 1639 of file scriptforge.py.

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

◆ servicesynonyms

tuple scriptforge.SFScriptForge.SF_UI.servicesynonyms = ('ui', 'scriptforge.ui')

static

Definition at line 1638 of file scriptforge.py.

◆ WRITERDOCUMENT

scriptforge.SFScriptForge.SF_UI.WRITERDOCUMENT

static

Definition at line 1643 of file scriptforge.py.

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

scriptforge.py

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ Activate()

◆ ActiveWindow()

◆ CreateBaseDocument()

◆ CreateDocument()

◆ Documents()

◆ GetDocument()

◆ Maximize()

◆ Minimize()

◆ OpenBaseDocument()

◆ OpenDocument()

◆ Resize()

◆ RunCommand()

◆ SetStatusbar()

◆ ShowProgressBar()

◆ WindowExists()

Member Data Documentation

◆ activeWindow

◆ activewindow

◆ BASEDOCUMENT

◆ CALCDOCUMENT

◆ DRAWDOCUMENT

◆ IMPRESSDOCUMENT

◆ MACROEXECALWAYS

◆ MACROEXECNEVER

◆ MACROEXECNORMAL

◆ MATHDOCUMENT

◆ serviceimplementation

◆ servicename

◆ serviceproperties

◆ servicesynonyms

◆ WRITERDOCUMENT