Screens.LocationBox.LocationBox Class Reference

Inheritance diagram for Screens.LocationBox.LocationBox:

Public Member Functions
def	__init__ (self, session, text="", filename="", currDir=None, bookmarks=None, userMode=False, windowTitle=_("Select Location"), minFree=None, autoAdd=False, editDir=False, inhibitDirs=[], inhibitMounts=[])
def	switchToFileListOnStart (self)
def	disableTimer (self)
def	showHideRename (self)
def	switchToFileList (self)
def	switchToBookList (self)
def	addRemoveBookmark (self)
def	removeBookmark (self, name, ret)
def	createDir (self)
def	createDirCallback (self, res)
def	removeDir (self)
def	removeDirCallback (self, name, res)
def	up (self)
def	down (self)
def	left (self)
def	right (self)
def	ok (self)
def	cancel (self)
def	getPreferredFolder (self)
def	selectConfirmed (self, ret)
def	select (self)
def	changeName (self)
def	nameChanged (self, res)
def	updateTarget (self)
def	showMenu (self)
def	menuCallback (self, choice)
def	usermodeOn (self)
def	keyNumberGlobal (self, number)
def	selectByStart (self)
def	timeout (self, force=False)
def	__repr__ (self)
Public Member Functions inherited from Screens.Screen.Screen
def	__init__ (self, session, parent=None, windowTitle=None)
def	saveKeyboardMode (self)
def	setKeyboardModeAscii (self)
def	setKeyboardModeNone (self)
def	restoreKeyboardMode (self)
def	execBegin (self)
def	execEnd (self)
def	doClose (self, immediate=True)
def	doCloseInternal (self)
def	close (self, *retval)
def	setFocus (self, o)
def	show (self)
def	hide (self)
def	enable (self, do_show=True)
def	disable (self)
def	isEnabled (self)
def	getRelatedScreen (self, name)
def	setShowHideAnimation (self, animation_key)
def	neverAnimate (self)
def	canAnimate (self)
def	ignoreSource (self, name)
Public Member Functions inherited from Components.GUISkin.GUISkin
def	__init__ (self, windowTitle=None)
def	createGUIScreen (self, parent, desktop, updateonly=False)
def	deleteGUIScreen (self)
def	close (self)
def	createSummary (self)
def	addSummary (self, summary)
def	removeSummary (self, summary)
def	setTitle (self, title)
def	getTitle (self)
def	setDesktop (self, desktop)
def	applySkin (self)
def	setZPosition (self, z)
Public Member Functions inherited from Tools.NumericalTextInput.NumericalTextInput
def	__init__ (self, nextFunc=None, handleTimeout=True, search=False)
def	setUseableChars (self, useable)
def	getKey (self, num)
def	nextKey (self)
def	nextChar (self)
def	timeout (self)
Public Member Functions inherited from Screens.HelpMenu.HelpableScreen
def	__init__ (self)
def	showHelp (self)
def	callHelpAction (self, *args)

Public Attributes
	qs_timer
	qs_timer_conn
	qs_timer_type
	curr_pos
	quickselect
	text
	filename
	minFree
	realBookmarks
	bookmarks
	userMode
	autoAdd
	editDir
	inhibitDirs
	box
	currList
	lastKey
Public Attributes inherited from Screens.Screen.Screen
	skinName
	session
	parent
	onClose
	onFirstExecBegin
	onExecBegin
	onShown
	onShow
	onHide
	onExecEnd
	onHideFinished
	execing
	shown
	already_shown
	renderer
	helpList
	close_on_next_exec
	stand_alone
	keyboardMode
	active_components
	persisted_members
Public Attributes inherited from Components.GUISkin.GUISkin
	onLayoutFinish
	summaries
	instance
	desktop
	scale
Public Attributes inherited from Tools.NumericalTextInput.NumericalTextInput
	mapping
	lang
	useableChars
	nextFunction
	timer
	timer_conn
	lastKey
	pos

Static Public Attributes
string	skin
Static Public Attributes inherited from Screens.Screen.Screen
int	SUSPEND_NONE = 0
int	SUSPEND_STOPS = 1
int	SUSPEND_PAUSES = 2
int	ALLOW_SUSPEND = SUSPEND_NONE
Static Public Attributes inherited from Components.GUISkin.GUISkin
bool	IS_DIALOG = False

Additional Inherited Members
Properties inherited from Components.GUISkin.GUISkin
	title = property(getTitle, setTitle)

Detailed Description

Simple Class similar to MessageBox / ChoiceBox but used to choose a folder/pathname combination

Constructor & Destructor Documentation

__init__()

def Screens.LocationBox.LocationBox.__init__	(		self,
			session,
			text = "",
			filename = "",
			currDir = None,
			bookmarks = None,
			userMode = False,
			windowTitle = _("Select Location"),
			minFree = None,
			autoAdd = False,
			editDir = False,
			inhibitDirs = [],
			inhibitMounts = []
	)

Member Function Documentation

__repr__()

def Screens.LocationBox.LocationBox.__repr__

(

self

)

Reimplemented from Screens.Screen.Screen.

addRemoveBookmark()

def Screens.LocationBox.LocationBox.addRemoveBookmark

(

self

)

cancel()

def Screens.LocationBox.LocationBox.cancel

(

self

)

Reimplemented in Screens.LocationBox.TimeshiftLocationBox.

changeName()

def Screens.LocationBox.LocationBox.changeName

(

self

)

createDir()

def Screens.LocationBox.LocationBox.createDir

(

self

)

createDirCallback()

def Screens.LocationBox.LocationBox.createDirCallback	(		self,
			res
	)

disableTimer()

def Screens.LocationBox.LocationBox.disableTimer

(

self

)

down()

def Screens.LocationBox.LocationBox.down

(

self

)

getPreferredFolder()

def Screens.LocationBox.LocationBox.getPreferredFolder

(

self

)

keyNumberGlobal()

def Screens.LocationBox.LocationBox.keyNumberGlobal	(		self,
			number
	)

left()

def Screens.LocationBox.LocationBox.left

(

self

)

menuCallback()

def Screens.LocationBox.LocationBox.menuCallback	(		self,
			choice
	)

nameChanged()

def Screens.LocationBox.LocationBox.nameChanged	(		self,
			res
	)

ok()

def Screens.LocationBox.LocationBox.ok

(

self

)

removeBookmark()

def Screens.LocationBox.LocationBox.removeBookmark	(		self,
			name,
			ret
	)

removeDir()

def Screens.LocationBox.LocationBox.removeDir

(

self

)

removeDirCallback()

def Screens.LocationBox.LocationBox.removeDirCallback	(		self,
			name,
			res
	)

right()

def Screens.LocationBox.LocationBox.right

(

self

)

select()

def Screens.LocationBox.LocationBox.select

(

self

)

selectByStart()

def Screens.LocationBox.LocationBox.selectByStart

(

self

)

selectConfirmed()

def Screens.LocationBox.LocationBox.selectConfirmed	(		self,
			ret
	)

Reimplemented in Screens.LocationBox.TimeshiftLocationBox.

showHideRename()

def Screens.LocationBox.LocationBox.showHideRename

(

self

)

showMenu()

def Screens.LocationBox.LocationBox.showMenu

(

self

)

switchToBookList()

def Screens.LocationBox.LocationBox.switchToBookList

(

self

)

switchToFileList()

def Screens.LocationBox.LocationBox.switchToFileList

(

self

)

switchToFileListOnStart()

def Screens.LocationBox.LocationBox.switchToFileListOnStart

(

self

)

timeout()

def Screens.LocationBox.LocationBox.timeout	(		self,
			force = False
	)

up()

def Screens.LocationBox.LocationBox.up

(

self

)

updateTarget()

def Screens.LocationBox.LocationBox.updateTarget

(

self

)

usermodeOn()

def Screens.LocationBox.LocationBox.usermodeOn

(

self

)

Member Data Documentation

autoAdd

Screens.LocationBox.LocationBox.autoAdd

bookmarks

Screens.LocationBox.LocationBox.bookmarks

box

Screens.LocationBox.LocationBox.box

curr_pos

Screens.LocationBox.LocationBox.curr_pos

currList

Screens.LocationBox.LocationBox.currList

editDir

Screens.LocationBox.LocationBox.editDir

filename

Screens.LocationBox.LocationBox.filename

inhibitDirs

Screens.LocationBox.LocationBox.inhibitDirs

lastKey

Screens.LocationBox.LocationBox.lastKey

minFree

Screens.LocationBox.LocationBox.minFree

qs_timer

Screens.LocationBox.LocationBox.qs_timer

qs_timer_conn

Screens.LocationBox.LocationBox.qs_timer_conn

qs_timer_type

Screens.LocationBox.LocationBox.qs_timer_type

quickselect

Screens.LocationBox.LocationBox.quickselect

realBookmarks

Screens.LocationBox.LocationBox.realBookmarks

skin

string Screens.LocationBox.LocationBox.skin

static

Initial value:

=  """<screen name="LocationBox" position="100,75" size="540,460" >
                <widget name="text" position="0,2" size="540,22" font="Regular;22" />
                <widget name="target" position="0,23" size="540,22" valign="center" font="Regular;22" />
                <widget name="filelist" position="0,55" zPosition="1" size="540,210" scrollbarMode="showOnDemand" selectionDisabled="1" />
                <widget name="textbook" position="0,272" size="540,22" font="Regular;22" />
                <widget name="booklist" position="5,302" zPosition="2" size="535,100" scrollbarMode="showOnDemand" />
                <widget name="red" position="0,415" zPosition="1" size="135,40" pixmap="skin_default/buttons/red.png" transparent="1" alphatest="on" />
                <widget name="key_red" position="0,415" zPosition="2" size="135,40" halign="center" valign="center" font="Regular;22" transparent="1" shadowColor="black" shadowOffset="-1,-1" />   
                <widget name="green" position="135,415" zPosition="1" size="135,40" pixmap="skin_default/buttons/green.png" transparent="1" alphatest="on" />
                <widget name="key_green" position="135,415" zPosition="2" size="135,40" halign="center" valign="center" font="Regular;22" transparent="1" shadowColor="black" shadowOffset="-1,-1" />
                <widget name="yellow" position="270,415" zPosition="1" size="135,40" pixmap="skin_default/buttons/yellow.png" transparent="1" alphatest="on" />
                <widget name="key_yellow" position="270,415" zPosition="2" size="135,40" halign="center" valign="center" font="Regular;22" transparent="1" shadowColor="black" shadowOffset="-1,-1" />
                <widget name="blue" position="405,415" zPosition="1" size="135,40" pixmap="skin_default/buttons/blue.png" transparent="1" alphatest="on" />
                <widget name="key_blue" position="405,415" zPosition="2" size="135,40" halign="center" valign="center" font="Regular;22" transparent="1" shadowColor="black" shadowOffset="-1,-1" />            
        </screen>"""

text

Screens.LocationBox.LocationBox.text

userMode

Screens.LocationBox.LocationBox.userMode

---

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

• usr/lib/enigma2/python/Screens/LocationBox.py