Inheritance diagram for scriptforge.SFDialogs.SF_Dialog:

Collaboration diagram for scriptforge.SFDialogs.SF_Dialog:

Public Member Functions
def	ReviewServiceArgs (cls, container='', library='Standard', dialogname='')

def	Activate (self)

def	Center (self, parent=ScriptForge.cstSymMissing)

def	CloneControl (self, sourcename, controlname, left=1, top=1)

def	Controls (self, controlname='')

def	CreateButton (self, controlname, place, toggle=False, push='')

def	CreateCheckBox (self, controlname, place, multiline=False)

def	CreateComboBox (self, controlname, place, border='3D', dropdown=True, linecount=5)

def	CreateCurrencyField (self, controlname, place, border='3D', spinbutton=False, minvalue=-1000000, maxvalue=+1000000, increment=1, accuracy=2)

def	CreateDateField (self, controlname, place, border='3D', dropdown=True, mindate=datetime.datetime(1900, 1, 1, 0, 0, 0, 0), maxdate=datetime.datetime(2200, 12, 31, 0, 0, 0, 0))

def	CreateFileControl (self, controlname, place, border='3D')

def	CreateFixedLine (self, controlname, place, orientation)

def	CreateFixedText (self, controlname, place, border='NONE', multiline=False, align='LEFT', verticalalign='TOP')

def	CreateFormattedField (self, controlname, place, border='3D', spinbutton=False, minvalue=-1000000, maxvalue=+1000000)

def	CreateGroupBox (self, controlname, place)

def	CreateHyperlink (self, controlname, place, border='NONE', multiline=False, align='LEFT', verticalalign='TOP')

def	CreateImageControl (self, controlname, place, border='3D', scale='FITTOSIZE')

def	CreateListBox (self, controlname, place, border='3D', dropdown=True, linecount=5, multiselect=False)

def	CreateNumericField (self, controlname, place, border='3D', spinbutton=False, minvalue=-1000000, maxvalue=+1000000, increment=1, accuracy=2)

def	CreatePatternField (self, controlname, place, border='3D', editmask='', literalmask='')

def	CreateProgressBar (self, controlname, place, border='3D', minvalue=0, maxvalue=100)

def	CreateRadioButton (self, controlname, place, multiline=False)

def	CreateScrollBar (self, controlname, place, orientation, border='3D', minvalue=0, maxvalue=100)

def	CreateTableControl (self, controlname, place, border='3D', rowheaders=True, columnheaders=True, scrollbars='None', gridlines=False)

def	CreateTextField (self, controlname, place, border='3D', multiline=False, maximumlength=0, passwordcharacter='')

def	CreateTimeField (self, controlname, place, border='3D', mintime=datetime.datetime(1899, 12, 30, 0, 0, 0, 0), maxtime=datetime.datetime(1899, 12, 30, 23, 59, 59, 0))

def	CreateTreeControl (self, controlname, place, border='3D')

def	EndExecute (self, returnvalue)

def	Execute (self, modal=True)

def	GetTextsFromL10N (self, l10n)

def	OrderTabs (self, tabslist, start=1, increment=1)

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

def	SetPageManager (self, pilotcontrols='', tabcontrols='', wizardcontrols='', lastpage=0)

def	Terminate (self)

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.Dialog'

tuple	servicesynonyms = ('dialog', 'sfdialogs.dialog')

	serviceproperties

	OKBUTTON

	CANCELBUTTON

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 dialog box displayed to the user.
    The dialog box must have been designed and defined with the Basic IDE previously.
    From a Python script, a dialog box can be displayed in modal or in non-modal modes.

    In modal mode, the box is displayed and the execution of the macro process is suspended
    until one of the OK or Cancel buttons is pressed. In the meantime, other user actions
    executed on the box can trigger specific actions.

    In non-modal mode, the floating dialog remains displayed until the dialog is terminated
    by code (Terminate()) or until the LibreOffice application stops.

Definition at line 1835 of file scriptforge.py.

Member Function Documentation

◆ Activate()

def scriptforge.SFDialogs.SF_Dialog.Activate ( self )

Definition at line 1870 of file scriptforge.py.

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

◆ Center()

def scriptforge.SFDialogs.SF_Dialog.Center	(	self,
		parent = `ScriptForge.cstSymMissing`
	)

Definition at line 1873 of file scriptforge.py.

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

◆ CloneControl()

def scriptforge.SFDialogs.SF_Dialog.CloneControl	(	self,
		sourcename,
		controlname,
		left = `1`,
		top = `1`
	)

Definition at line 1879 of file scriptforge.py.

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

◆ Controls()

def scriptforge.SFDialogs.SF_Dialog.Controls	(	self,
		controlname = `''`
	)

Definition at line 1882 of file scriptforge.py.

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

◆ CreateButton()

def scriptforge.SFDialogs.SF_Dialog.CreateButton	(	self,
		controlname,
		place,
		toggle = `False`,
		push = `''`
	)

Definition at line 1885 of file scriptforge.py.

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

◆ CreateCheckBox()

def scriptforge.SFDialogs.SF_Dialog.CreateCheckBox	(	self,
		controlname,
		place,
		multiline = `False`
	)

Definition at line 1888 of file scriptforge.py.

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

◆ CreateComboBox()

def scriptforge.SFDialogs.SF_Dialog.CreateComboBox	(	self,
		controlname,
		place,
		border = `'3D'`,
		dropdown = `True`,
		linecount = `5`
	)

Definition at line 1891 of file scriptforge.py.

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

◆ CreateCurrencyField()

def scriptforge.SFDialogs.SF_Dialog.CreateCurrencyField	(	self,
		controlname,
		place,
		border = `'3D'`,
		spinbutton = `False`,
		minvalue = `-1000000`,
		maxvalue = `+1000000`,
		increment = `1`,
		accuracy = `2`
	)

Definition at line 1894 of file scriptforge.py.

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

◆ CreateDateField()

def scriptforge.SFDialogs.SF_Dialog.CreateDateField	(	self,
		controlname,
		place,
		border = `'3D'`,
		dropdown = `True`,
		mindate = `datetime.datetime(1900, 1, 1, 0, 0, 0, 0)`,
		maxdate = `datetime.datetime(2200, 12, 31, 0, 0, 0, 0)`
	)

Definition at line 1899 of file scriptforge.py.

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

◆ CreateFileControl()

def scriptforge.SFDialogs.SF_Dialog.CreateFileControl	(	self,
		controlname,
		place,
		border = `'3D'`
	)

Definition at line 1909 of file scriptforge.py.

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

◆ CreateFixedLine()

def scriptforge.SFDialogs.SF_Dialog.CreateFixedLine	(	self,
		controlname,
		place,
		orientation
	)

Definition at line 1912 of file scriptforge.py.

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

◆ CreateFixedText()

def scriptforge.SFDialogs.SF_Dialog.CreateFixedText	(	self,
		controlname,
		place,
		border = `'NONE'`,
		multiline = `False`,
		align = `'LEFT'`,
		verticalalign = `'TOP'`
	)

Definition at line 1915 of file scriptforge.py.

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

◆ CreateFormattedField()

def scriptforge.SFDialogs.SF_Dialog.CreateFormattedField	(	self,
		controlname,
		place,
		border = `'3D'`,
		spinbutton = `False`,
		minvalue = `-1000000`,
		maxvalue = `+1000000`
	)

Definition at line 1920 of file scriptforge.py.

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

◆ CreateGroupBox()

def scriptforge.SFDialogs.SF_Dialog.CreateGroupBox	(	self,
		controlname,
		place
	)

Definition at line 1925 of file scriptforge.py.

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

◆ CreateHyperlink()

def scriptforge.SFDialogs.SF_Dialog.CreateHyperlink	(	self,
		controlname,
		place,
		border = `'NONE'`,
		multiline = `False`,
		align = `'LEFT'`,
		verticalalign = `'TOP'`
	)

Definition at line 1928 of file scriptforge.py.

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

◆ CreateImageControl()

def scriptforge.SFDialogs.SF_Dialog.CreateImageControl	(	self,
		controlname,
		place,
		border = `'3D'`,
		scale = `'FITTOSIZE'`
	)

Definition at line 1933 of file scriptforge.py.

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

◆ CreateListBox()

def scriptforge.SFDialogs.SF_Dialog.CreateListBox	(	self,
		controlname,
		place,
		border = `'3D'`,
		dropdown = `True`,
		linecount = `5`,
		multiselect = `False`
	)

Definition at line 1936 of file scriptforge.py.

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

◆ CreateNumericField()

def scriptforge.SFDialogs.SF_Dialog.CreateNumericField	(	self,
		controlname,
		place,
		border = `'3D'`,
		spinbutton = `False`,
		minvalue = `-1000000`,
		maxvalue = `+1000000`,
		increment = `1`,
		accuracy = `2`
	)

Definition at line 1941 of file scriptforge.py.

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

◆ CreatePatternField()

def scriptforge.SFDialogs.SF_Dialog.CreatePatternField	(	self,
		controlname,
		place,
		border = `'3D'`,
		editmask = `''`,
		literalmask = `''`
	)

Definition at line 1946 of file scriptforge.py.

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

◆ CreateProgressBar()

def scriptforge.SFDialogs.SF_Dialog.CreateProgressBar	(	self,
		controlname,
		place,
		border = `'3D'`,
		minvalue = `0`,
		maxvalue = `100`
	)

Definition at line 1950 of file scriptforge.py.

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

◆ CreateRadioButton()

def scriptforge.SFDialogs.SF_Dialog.CreateRadioButton	(	self,
		controlname,
		place,
		multiline = `False`
	)

Definition at line 1953 of file scriptforge.py.

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

◆ CreateScrollBar()

def scriptforge.SFDialogs.SF_Dialog.CreateScrollBar	(	self,
		controlname,
		place,
		orientation,
		border = `'3D'`,
		minvalue = `0`,
		maxvalue = `100`
	)

Definition at line 1956 of file scriptforge.py.

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

◆ CreateTableControl()

def scriptforge.SFDialogs.SF_Dialog.CreateTableControl	(	self,
		controlname,
		place,
		border = `'3D'`,
		rowheaders = `True`,
		columnheaders = `True`,
		scrollbars = `'None'`,
		gridlines = `False`
	)

Definition at line 1960 of file scriptforge.py.

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

◆ CreateTextField()

def scriptforge.SFDialogs.SF_Dialog.CreateTextField	(	self,
		controlname,
		place,
		border = `'3D'`,
		multiline = `False`,
		maximumlength = `0`,
		passwordcharacter = `''`
	)

Definition at line 1965 of file scriptforge.py.

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

◆ CreateTimeField()

def scriptforge.SFDialogs.SF_Dialog.CreateTimeField	(	self,
		controlname,
		place,
		border = `'3D'`,
		mintime = `datetime.datetime(1899, 12, 30, 0, 0, 0, 0)`,
		maxtime = `datetime.datetime(1899, 12, 30, 23, 59, 59, 0)`
	)

Definition at line 1970 of file scriptforge.py.

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

◆ CreateTreeControl()

def scriptforge.SFDialogs.SF_Dialog.CreateTreeControl	(	self,
		controlname,
		place,
		border = `'3D'`
	)

Definition at line 1980 of file scriptforge.py.

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

◆ EndExecute()

def scriptforge.SFDialogs.SF_Dialog.EndExecute	(	self,
		returnvalue
	)

Definition at line 1983 of file scriptforge.py.

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

◆ Execute()

def scriptforge.SFDialogs.SF_Dialog.Execute	(	self,
		modal = `True`
	)

Definition at line 1986 of file scriptforge.py.

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

◆ GetTextsFromL10N()

def scriptforge.SFDialogs.SF_Dialog.GetTextsFromL10N	(	self,
		l10n
	)

Definition at line 1989 of file scriptforge.py.

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

◆ OrderTabs()

def scriptforge.SFDialogs.SF_Dialog.OrderTabs	(	self,
		tabslist,
		start = `1`,
		increment = `1`
	)

Definition at line 1993 of file scriptforge.py.

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

◆ Resize()

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

Definition at line 1996 of file scriptforge.py.

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

◆ ReviewServiceArgs()

def scriptforge.SFDialogs.SF_Dialog.ReviewServiceArgs	(	cls,
		container = `''`,
		library = `'Standard'`,
		dialogname = `''`
	)

    Transform positional and keyword arguments into positional only
    Add the XComponentContext as last argument

Definition at line 1862 of file scriptforge.py.

◆ SetPageManager()

def scriptforge.SFDialogs.SF_Dialog.SetPageManager	(	self,
		pilotcontrols = `''`,
		tabcontrols = `''`,
		wizardcontrols = `''`,
		lastpage = `0`
	)

Definition at line 1999 of file scriptforge.py.

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

◆ Terminate()

def scriptforge.SFDialogs.SF_Dialog.Terminate ( self )

Definition at line 2003 of file scriptforge.py.

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

Member Data Documentation

◆ CANCELBUTTON

scriptforge.SFDialogs.SF_Dialog.CANCELBUTTON

static

Definition at line 1859 of file scriptforge.py.

◆ OKBUTTON

scriptforge.SFDialogs.SF_Dialog.OKBUTTON

static

Definition at line 1859 of file scriptforge.py.

◆ serviceimplementation

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

static

Definition at line 1849 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_Dialog.servicename = 'SFDialogs.Dialog'

static

Definition at line 1850 of file scriptforge.py.

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

◆ serviceproperties

scriptforge.SFDialogs.SF_Dialog.serviceproperties

static

Initial value:

=  dict(Caption = True, Height = True, Modal = False, Name = False,
                                 OnFocusGained = True, OnFocusLost = True, OnKeyPressed = True,
                                 OnKeyReleased = True, OnMouseDragged = True, OnMouseEntered = True,
                                 OnMouseExited = True, OnMouseMoved = True, OnMousePressed = True,
                                 OnMouseReleased = True,
                                 Page = True, Visible = True, Width = True, XDialogModel = False, XDialogView = False)

Definition at line 1852 of file scriptforge.py.

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

◆ servicesynonyms

tuple scriptforge.SFDialogs.SF_Dialog.servicesynonyms = ('dialog', 'sfdialogs.dialog')

static

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

◆ Center()

◆ CloneControl()

◆ Controls()

◆ CreateButton()

◆ CreateCheckBox()

◆ CreateComboBox()

◆ CreateCurrencyField()

◆ CreateDateField()

◆ CreateFileControl()

◆ CreateFixedLine()

◆ CreateFixedText()

◆ CreateFormattedField()

◆ CreateGroupBox()

◆ CreateHyperlink()

◆ CreateImageControl()

◆ CreateListBox()

◆ CreateNumericField()

◆ CreatePatternField()

◆ CreateProgressBar()

◆ CreateRadioButton()

◆ CreateScrollBar()

◆ CreateTableControl()

◆ CreateTextField()

◆ CreateTimeField()

◆ CreateTreeControl()

◆ EndExecute()

◆ Execute()

◆ GetTextsFromL10N()

◆ OrderTabs()

◆ Resize()

◆ ReviewServiceArgs()

◆ SetPageManager()

◆ Terminate()

Member Data Documentation

◆ CANCELBUTTON

◆ OKBUTTON

◆ serviceimplementation

◆ servicename

◆ serviceproperties

◆ servicesynonyms