scriptforge.SFWidgets.SF_Menu Class Reference

Inheritance diagram for scriptforge.SFWidgets.SF_Menu:

Collaboration diagram for scriptforge.SFWidgets.SF_Menu:

Public Member Functions
def	AddCheckBox (self, menuitem, name='', status=False, icon='', tooltip='', command='', script='')
def	AddItem (self, menuitem, name='', icon='', tooltip='', command='', script='')
def	AddRadioButton (self, menuitem, name='', status=False, icon='', tooltip='', command='', script='')
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 = 'SFWidgets.Menu'
tuple	servicesynonyms = ('menu', 'sfwidgets.menu')
	serviceproperties = dict(ShortcutCharacter = False, SubmenuCharacter = False)
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

    Display a menu in the menubar of a document or a form document.
    After use, the menu will not be saved neither in the application settings, nor in the document.
    The menu will be displayed, as usual, when its header in the menubar is clicked.
    When one of its items is selected, there are 3 alternative options:
    - a UNO command (like ".uno:About") is triggered
    - a user script is run receiving a standard argument defined in this service
    - one of above combined with a toggle of the status of the item
    The menu is described from top to bottom. Each menu item receives a numeric and a string identifier.

Definition at line 2675 of file scriptforge.py.

Member Function Documentation

AddCheckBox()

def scriptforge.SFWidgets.SF_Menu.AddCheckBox	(		self,
			menuitem,
			name = '',
			status = False,
			icon = '',
			tooltip = '',
			command = '',
			script = ''
	)

Definition at line 2692 of file scriptforge.py.

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

AddItem()

def scriptforge.SFWidgets.SF_Menu.AddItem	(		self,
			menuitem,
			name = '',
			icon = '',
			tooltip = '',
			command = '',
			script = ''
	)

Definition at line 2697 of file scriptforge.py.

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

AddRadioButton()

def scriptforge.SFWidgets.SF_Menu.AddRadioButton	(		self,
			menuitem,
			name = '',
			status = False,
			icon = '',
			tooltip = '',
			command = '',
			script = ''
	)

Definition at line 2700 of file scriptforge.py.

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

Member Data Documentation

serviceimplementation

string scriptforge.SFWidgets.SF_Menu.serviceimplementation = 'basic'

static

Definition at line 2687 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.SFWidgets.SF_Menu.servicename = 'SFWidgets.Menu'

static

Definition at line 2688 of file scriptforge.py.

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

serviceproperties

scriptforge.SFWidgets.SF_Menu.serviceproperties = dict(ShortcutCharacter = False, SubmenuCharacter = False)

static

Definition at line 2690 of file scriptforge.py.

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

servicesynonyms

tuple scriptforge.SFWidgets.SF_Menu.servicesynonyms = ('menu', 'sfwidgets.menu')

static

Definition at line 2689 of file scriptforge.py.

---

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

• scriptforge.py