scriptforge.SFWidgets.SF_PopupMenu Class Reference

Inheritance diagram for scriptforge.SFWidgets.SF_PopupMenu:

Collaboration diagram for scriptforge.SFWidgets.SF_PopupMenu:

Public Member Functions
def	ReviewServiceArgs (cls, event=None, x=0, y=0, submenuchar='')
def	AddCheckBox (self, menuitem, name='', status=False, icon='', tooltip='')
def	AddItem (self, menuitem, name='', icon='', tooltip='')
def	AddRadioButton (self, menuitem, name='', status=False, icon='', tooltip='')
def	Execute (self, returnid=True)
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.PopupMenu'
tuple	servicesynonyms = ('popupmenu', 'sfwidgets.popupmenu')
	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 popup menu anywhere and any time.
    A popup menu is usually triggered by a mouse action (typically a right-click) on a dialog, a form
    or one of their controls. In this case the menu will be displayed below the clicked area.
    When triggered by other events, including in the normal flow of a user script, the script should
    provide the coordinates of the topleft edge of the menu versus the actual component.
    The menu is described from top to bottom. Each menu item receives a numeric and a string identifier.
    The execute() method returns the item selected by the user.

Definition at line 2708 of file scriptforge.py.

Member Function Documentation

AddCheckBox()

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

Definition at line 2731 of file scriptforge.py.

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

AddItem()

def scriptforge.SFWidgets.SF_PopupMenu.AddItem	(		self,
			menuitem,
			name = '',
			icon = '',
			tooltip = ''
	)

Definition at line 2734 of file scriptforge.py.

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

AddRadioButton()

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

Definition at line 2737 of file scriptforge.py.

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

Execute()

def scriptforge.SFWidgets.SF_PopupMenu.Execute	(		self,
			returnid = True
	)

Definition at line 2740 of file scriptforge.py.

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

ReviewServiceArgs()

def scriptforge.SFWidgets.SF_PopupMenu.ReviewServiceArgs	(		cls,
			event = None,
			x = 0,
			y = 0,
			submenuchar = ''
	)

    Transform positional and keyword arguments into positional only

Definition at line 2725 of file scriptforge.py.

Member Data Documentation

serviceimplementation

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

static

Definition at line 2719 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_PopupMenu.servicename = 'SFWidgets.PopupMenu'

static

Definition at line 2720 of file scriptforge.py.

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

serviceproperties

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

static

Definition at line 2722 of file scriptforge.py.

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

servicesynonyms

tuple scriptforge.SFWidgets.SF_PopupMenu.servicesynonyms = ('popupmenu', 'sfwidgets.popupmenu')

static

Definition at line 2721 of file scriptforge.py.

---

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

• scriptforge.py