xbmcgui (version 2.14.0, Thu Apr 17 08:03:55 BST 2014)
index
(built-in)

 
Classes
       
__builtin__.object
Action
Control
ControlButton
ControlCheckMark
ControlEdit
ControlFadeLabel
ControlGroup
ControlImage
ControlLabel
ControlList
ControlProgress
ControlRadioButton
ControlSlider
ControlSpin
ControlTextBox
Dialog
DialogProgress
DialogProgressBG
ListItem
Window
WindowDialog
WindowXML
WindowXMLDialog

 
class Action(__builtin__.object)
    Action class.
 
For backwards compatibility reasons the == operator is extended so that it
can compare an action with other actions and action.GetID() with numbers
    - example: (action == ACTION_MOVE_LEFT)
 
  Methods defined here:
__eq__(...)
x.__eq__(y) <==> x==y
__ge__(...)
x.__ge__(y) <==> x>=y
__gt__(...)
x.__gt__(y) <==> x>y
__le__(...)
x.__le__(y) <==> x<=y
__lt__(...)
x.__lt__(y) <==> x<y
__ne__(...)
x.__ne__(y) <==> x!=y
getAmount1(...)
getAmount1() --Returns the first amount of force applied to the thumbstick n.
getAmount2(...)
getAmount2() --Returns the second amount of force applied to the thumbstick n.
getButtonCode(...)
getButtonCode() --Returns the button code for this action.
getId(...)
getId() --Returns the action's current id as a long or 0 if no action is mapped in the xml's.

Data and other attributes defined here:
__new__ = <built-in method __new__ of type object>
T.__new__(S, ...) -> a new object with type S, a subtype of T

 
class Control(__builtin__.object)
    Control class.
 
Base class for all controls.
 
  Methods defined here:
__cmp__(...)
x.__cmp__(y) <==> cmp(x,y)
canAcceptMessages(...)
controlDown(...)
controlDown(control)--Set's the controls down navigation.
 
control : control object - control to navigate to on down.
 
*Note, You can also usesetNavigation() . Set to self to disable navigation.
 
Throws:
    - TypeError, if one of the supplied arguments is not a control type.
    - ReferenceError, if one of the controls is not added to a window.
 
 
example:
    - self.button.controlDown(self.button1)
controlLeft(...)
controlLeft(control)--Set's the controls left navigation.
 
control : control object - control to navigate to on left.
 
*Note, You can also usesetNavigation() . Set to self to disable navigation.
 
Throws:
    - TypeError, if one of the supplied arguments is not a control type.
    - ReferenceError, if one of the controls is not added to a window.
 
 
example:
    - self.button.controlLeft(self.button1)
controlRight(...)
controlRight(control)--Set's the controls right navigation.
 
control : control object - control to navigate to on right.
 
*Note, You can also usesetNavigation() . Set to self to disable navigation.
 
Throws:
    - TypeError, if one of the supplied arguments is not a control type.
    - ReferenceError, if one of the controls is not added to a window.
 
 
example:
    - self.button.controlRight(self.button1)
controlUp(...)
controlUp(control)--Set's the controls up navigation.
 
control : control object - control to navigate to on up.
 
*Note, You can also usesetNavigation() . Set to self to disable navigation.
 
Throws:
    - TypeError, if one of the supplied arguments is not a control type.
    - ReferenceError, if one of the controls is not added to a window.
 
 
example:
    - self.button.controlUp(self.button1)
getHeight(...)
getHeight() --Returns the control's current height as an integer.
 
example:
    - height = self.button.getHeight()
getId(...)
getId() --Returns the control's current id as an integer.
 
example:
    - id = self.button.getId()
getPosition(...)
getPosition() --Returns the control's current position as a x,y integer tuple.
 
example:
    - pos = self.button.getPosition()
getWidth(...)
getWidth() --Returns the control's current width as an integer.
 
example:
    - width = self.button.getWidth()
getX(...)
getY(...)
setAnimations(...)
setAnimations([(event, attr,)*])--Set's the control's animations.
 
[(event,attr,)*] : list - A list of tuples consisting of event and attributes pairs.
    - event : string - The event to animate.
    - attr : string - The whole attribute string separated by spaces.
 
 
Animating your skin -http://wiki.xbmc.org/?title=Animating_Your_Skin 
 
example:
    - self.button.setAnimations([('focus', 'effect=zoom end=90,247,220,56 time=0',)])
setEnableCondition(...)
setEnableCondition(enable)--Set's the control's enabled condition. Allows XBMC to control the enabled status of the control.
 
enable : string - Enable condition.
 
List of Conditions -http://wiki.xbmc.org/index.php?title=List_of_Boolean_Conditions 
 
example:
    - self.button.setEnableCondition('System.InternetState')
setEnabled(...)
setEnabled(enabled)--Set's the control's enabled/disabled state.
 
enabled : bool - True=enabled / False=disabled.
 
example:
    - self.button.setEnabled(False)n
setHeight(...)
setHeight(height)--Set's the controls height.
 
height : integer - height of control.
 
example:
    - self.image.setHeight(100)
setNavigation(...)
setNavigation(up, down, left, right)--Set's the controls navigation.
 
up : control object - control to navigate to on up.
down : control object - control to navigate to on down.
left : control object - control to navigate to on left.
right : control object - control to navigate to on right.
 
*Note, Same ascontrolUp() ,controlDown() ,controlLeft() ,controlRight() . Set to self to disable navigation for that direction.
 
Throws:
    - TypeError, if one of the supplied arguments is not a control type.
    - ReferenceError, if one of the controls is not added to a window.
 
 
example:
    - self.button.setNavigation(self.button1, self.button2, self.button3, self.button4)
setPosition(...)
setPosition(x, y)--Set's the controls position.
 
x : integer - x coordinate of control.
y : integer - y coordinate of control.
 
*Note, You may use negative integers. (e.g sliding a control into view)
 
example:
    - self.button.setPosition(100, 250)
setVisible(...)
setVisible(visible)--Set's the control's visible/hidden state.
 
visible : bool - True=visible / False=hidden.
 
example:
    - self.button.setVisible(False)
setVisibleCondition(...)
setVisibleCondition(visible[,allowHiddenFocus])--Set's the control's visible condition. Allows XBMC to control the visible status of the control.
 
visible : string - Visible condition.
allowHiddenFocus : bool - True=gains focus even if hidden.
 
List of Conditions -http://wiki.xbmc.org/index.php?title=List_of_Boolean_Conditions 
 
example:
    - self.button.setVisibleCondition('[Control.IsVisible(41) + !Control.IsVisible(12)]', True)
setWidth(...)
setWidth(width)--Set's the controls width.
 
width : integer - width of control.
 
example:
    - self.image.setWidth(100)

 
class ControlButton(Control)
    ControlButton class.
 
ControlButton (x, y, width, height, label[, focusTexture, noFocusTexture, textOffsetX, textOffsetY, alignment, font, textColor, disabledColor, angle, shadowColor, focusedColor])
 
x : integer - x coordinate of control.
y : integer - y coordinate of control.
width : integer - width of control.
height : integer - height of control.
label : string or unicode - text string.
focusTexture : [opt] string - filename for focus texture.
noFocusTexture : [opt] string - filename for no focus texture.
textOffsetX : [opt] integer - x offset of label.
textOffsetY : [opt] integer - y offset of label.
alignment : [opt] integer - alignment of label - *Note, see xbfont.h
font : [opt] string - font used for label text. (e.g. 'font13')
textColor : [opt] hexstring - color of enabled button's label. (e.g. '0xFFFFFFFF')
disabledColor : [opt] hexstring - color of disabled button's label. (e.g. '0xFFFF3300')
angle : [opt] integer - angle of control. (+ rotates CCW, - rotates CW)
shadowColor : [opt] hexstring - color of button's label's shadow. (e.g. '0xFF000000')
focusedColor : [opt] hexstring - color of focused button's label. (e.g. '0xFF00FFFF')
 
*Note, You can use the above as keywords for arguments and skip certain optional arguments.
Once you use a keyword, all following arguments require the keyword.
After you create the control, you need to add it to the window with addControl().
 
example:
    - self.button =xbmcgui.ControlButton (100, 250, 200, 50, 'Status', font='font14')
 
 
Method resolution order:
ControlButton
Control
__builtin__.object

Methods defined here:
getLabel(...)
getLabel() --Returns the buttons label as a unicode string.
 
example:
    - label = self.button.getLabel()
getLabel2(...)
getLabel2() --Returns the buttons label2 as a unicode string.
 
example:
    - label = self.button.getLabel2()
setDisabledColor(...)
setDisabledColor(disabledColor)--Set's this buttons disabled color.
 
disabledColor : hexstring - color of disabled button's label. (e.g. '0xFFFF3300')
 
example:
    - self.button.setDisabledColor('0xFFFF3300')
setLabel(...)
setLabel([label, font, textColor, disabledColor, shadowColor, focusedColor])--Set's this buttons text attributes.
 
label : [opt] string or unicode - text string.
font : [opt] string - font used for label text. (e.g. 'font13')
textColor : [opt] hexstring - color of enabled button's label. (e.g. '0xFFFFFFFF')
disabledColor : [opt] hexstring - color of disabled button's label. (e.g. '0xFFFF3300')
shadowColor : [opt] hexstring - color of button's label's shadow. (e.g. '0xFF000000')
focusedColor : [opt] hexstring - color of focused button's label. (e.g. '0xFFFFFF00')
label2 : [opt] string or unicode - text string.
 
*Note, You can use the above as keywords for arguments and skip certain optional arguments.
Once you use a keyword, all following arguments require the keyword.
 
example:
    - self.button.setLabel('Status', 'font14', '0xFFFFFFFF', '0xFFFF3300', '0xFF000000')

Data and other attributes defined here:
__new__ = <built-in method __new__ of type object>
T.__new__(S, ...) -> a new object with type S, a subtype of T

Methods inherited from Control:
__cmp__(...)
x.__cmp__(y) <==> cmp(x,y)
canAcceptMessages(...)
controlDown(...)
controlDown(control)--Set's the controls down navigation.
 
control : control object - control to navigate to on down.
 
*Note, You can also usesetNavigation() . Set to self to disable navigation.
 
Throws:
    - TypeError, if one of the supplied arguments is not a control type.
    - ReferenceError, if one of the controls is not added to a window.
 
 
example:
    - self.button.controlDown(self.button1)
controlLeft(...)
controlLeft(control)--Set's the controls left navigation.
 
control : control object - control to navigate to on left.
 
*Note, You can also usesetNavigation() . Set to self to disable navigation.
 
Throws:
    - TypeError, if one of the supplied arguments is not a control type.
    - ReferenceError, if one of the controls is not added to a window.
 
 
example:
    - self.button.controlLeft(self.button1)
controlRight(...)
controlRight(control)--Set's the controls right navigation.
 
control : control object - control to navigate to on right.
 
*Note, You can also usesetNavigation() . Set to self to disable navigation.
 
Throws:
    - TypeError, if one of the supplied arguments is not a control type.
    - ReferenceError, if one of the controls is not added to a window.
 
 
example:
    - self.button.controlRight(self.button1)
controlUp(...)
controlUp(control)--Set's the controls up navigation.
 
control : control object - control to navigate to on up.
 
*Note, You can also usesetNavigation() . Set to self to disable navigation.
 
Throws:
    - TypeError, if one of the supplied arguments is not a control type.
    - ReferenceError, if one of the controls is not added to a window.
 
 
example:
    - self.button.controlUp(self.button1)
getHeight(...)
getHeight() --Returns the control's current height as an integer.
 
example:
    - height = self.button.getHeight()
getId(...)
getId() --Returns the control's current id as an integer.
 
example:
    - id = self.button.getId()
getPosition(...)
getPosition() --Returns the control's current position as a x,y integer tuple.
 
example:
    - pos = self.button.getPosition()
getWidth(...)
getWidth() --Returns the control's current width as an integer.
 
example:
    - width = self.button.getWidth()
getX(...)
getY(...)
setAnimations(...)
setAnimations([(event, attr,)*])--Set's the control's animations.
 
[(event,attr,)*] : list - A list of tuples consisting of event and attributes pairs.
    - event : string - The event to animate.
    - attr : string - The whole attribute string separated by spaces.
 
 
Animating your skin -http://wiki.xbmc.org/?title=Animating_Your_Skin 
 
example:
    - self.button.setAnimations([('focus', 'effect=zoom end=90,247,220,56 time=0',)])
setEnableCondition(...)
setEnableCondition(enable)--Set's the control's enabled condition. Allows XBMC to control the enabled status of the control.
 
enable : string - Enable condition.
 
List of Conditions -http://wiki.xbmc.org/index.php?title=List_of_Boolean_Conditions 
 
example:
    - self.button.setEnableCondition('System.InternetState')
setEnabled(...)
setEnabled(enabled)--Set's the control's enabled/disabled state.
 
enabled : bool - True=enabled / False=disabled.
 
example:
    - self.button.setEnabled(False)n
setHeight(...)
setHeight(height)--Set's the controls height.
 
height : integer - height of control.
 
example:
    - self.image.setHeight(100)
setNavigation(...)
setNavigation(up, down, left, right)--Set's the controls navigation.
 
up : control object - control to navigate to on up.
down : control object - control to navigate to on down.
left : control object - control to navigate to on left.
right : control object - control to navigate to on right.
 
*Note, Same ascontrolUp() ,controlDown() ,controlLeft() ,controlRight() . Set to self to disable navigation for that direction.
 
Throws:
    - TypeError, if one of the supplied arguments is not a control type.
    - ReferenceError, if one of the controls is not added to a window.
 
 
example:
    - self.button.setNavigation(self.button1, self.button2, self.button3, self.button4)
setPosition(...)
setPosition(x, y)--Set's the controls position.
 
x : integer - x coordinate of control.
y : integer - y coordinate of control.
 
*Note, You may use negative integers. (e.g sliding a control into view)
 
example:
    - self.button.setPosition(100, 250)
setVisible(...)
setVisible(visible)--Set's the control's visible/hidden state.
 
visible : bool - True=visible / False=hidden.
 
example:
    - self.button.setVisible(False)
setVisibleCondition(...)
setVisibleCondition(visible[,allowHiddenFocus])--Set's the control's visible condition. Allows XBMC to control the visible status of the control.
 
visible : string - Visible condition.
allowHiddenFocus : bool - True=gains focus even if hidden.
 
List of Conditions -http://wiki.xbmc.org/index.php?title=List_of_Boolean_Conditions 
 
example:
    - self.button.setVisibleCondition('[Control.IsVisible(41) + !Control.IsVisible(12)]', True)
setWidth(...)
setWidth(width)--Set's the controls width.
 
width : integer - width of control.
 
example:
    - self.image.setWidth(100)

 
class ControlCheckMark(Control)
    ControlCheckMark class.
 
ControlCheckMark (x, y, width, height, label[, focusTexture, noFocusTexture, checkWidth, checkHeight, alignment, font, textColor, disabledColor])
 
x : integer - x coordinate of control.
y : integer - y coordinate of control.
width : integer - width of control.
height : integer - height of control.
label : string or unicode - text string.
focusTexture : [opt] string - filename for focus texture.
noFocusTexture : [opt] string - filename for no focus texture.
checkWidth : [opt] integer - width of checkmark.
checkHeight : [opt] integer - height of checkmark.
alignment : [opt] integer - alignment of label - *Note, see xbfont.h
font : [opt] string - font used for label text. (e.g. 'font13')
textColor : [opt] hexstring - color of enabled checkmark's label. (e.g. '0xFFFFFFFF')
disabledColor : [opt] hexstring - color of disabled checkmark's label. (e.g. '0xFFFF3300')
 
*Note, You can use the above as keywords for arguments and skip certain optional arguments.
Once you use a keyword, all following arguments require the keyword.
After you create the control, you need to add it to the window with addControl().
 
example:
    - self.checkmark =xbmcgui.ControlCheckMark (100, 250, 200, 50, 'Status', font='font14')
 
 
Method resolution order:
ControlCheckMark
Control
__builtin__.object

Methods defined here:
getSelected(...)
getSelected() --Returns the selected status for this checkmark as a bool.
 
example:
    - selected = self.checkmark.getSelected()
setDisabledColor(...)
setDisabledColor(disabledColor)--Set's this controls disabled color.
 
disabledColor : hexstring - color of disabled checkmark's label. (e.g. '0xFFFF3300')
 
example:
    - self.checkmark.setDisabledColor('0xFFFF3300')
setLabel(...)
setLabel(label[, font, textColor, disabledColor])--Set's this controls text attributes.
 
label : string or unicode - text string.
font : [opt] string - font used for label text. (e.g. 'font13')
textColor : [opt] hexstring - color of enabled checkmark's label. (e.g. '0xFFFFFFFF')
disabledColor : [opt] hexstring - color of disabled checkmark's label. (e.g. '0xFFFF3300')
 
example:
    - self.checkmark.setLabel('Status', 'font14', '0xFFFFFFFF', '0xFFFF3300')
setSelected(...)
setSelected(isOn)--Sets this checkmark status to on or off.
 
isOn : bool - True=selected (on) / False=not selected (off)
 
example:
    - self.checkmark.setSelected(True)

Data and other attributes defined here:
__new__ = <built-in method __new__ of type object>
T.__new__(S, ...) -> a new object with type S, a subtype of T

Methods inherited from Control:
__cmp__(...)
x.__cmp__(y) <==> cmp(x,y)
canAcceptMessages(...)
controlDown(...)
controlDown(control)--Set's the controls down navigation.
 
control : control object - control to navigate to on down.
 
*Note, You can also usesetNavigation() . Set to self to disable navigation.
 
Throws:
    - TypeError, if one of the supplied arguments is not a control type.
    - ReferenceError, if one of the controls is not added to a window.
 
 
example:
    - self.button.controlDown(self.button1)
controlLeft(...)
controlLeft(control)--Set's the controls left navigation.
 
control : control object - control to navigate to on left.
 
*Note, You can also usesetNavigation() . Set to self to disable navigation.
 
Throws:
    - TypeError, if one of the supplied arguments is not a control type.
    - ReferenceError, if one of the controls is not added to a window.
 
 
example:
    - self.button.controlLeft(self.button1)
controlRight(...)
controlRight(control)--Set's the controls right navigation.
 
control : control object - control to navigate to on right.
 
*Note, You can also usesetNavigation() . Set to self to disable navigation.
 
Throws:
    - TypeError, if one of the supplied arguments is not a control type.
    - ReferenceError, if one of the controls is not added to a window.
 
 
example:
    - self.button.controlRight(self.button1)
controlUp(...)
controlUp(control)--Set's the controls up navigation.
 
control : control object - control to navigate to on up.
 
*Note, You can also usesetNavigation() . Set to self to disable navigation.
 
Throws:
    - TypeError, if one of the supplied arguments is not a control type.
    - ReferenceError, if one of the controls is not added to a window.
 
 
example:
    - self.button.controlUp(self.button1)
getHeight(...)
getHeight() --Returns the control's current height as an integer.
 
example:
    - height = self.button.getHeight()
getId(...)
getId() --Returns the control's current id as an integer.
 
example:
    - id = self.button.getId()
getPosition(...)
getPosition() --Returns the control's current position as a x,y integer tuple.
 
example:
    - pos = self.button.getPosition()
getWidth(...)
getWidth() --Returns the control's current width as an integer.
 
example:
    - width = self.button.getWidth()
getX(...)
getY(...)
setAnimations(...)
setAnimations([(event, attr,)*])--Set's the control's animations.
 
[(event,attr,)*] : list - A list of tuples consisting of event and attributes pairs.
    - event : string - The event to animate.
    - attr : string - The whole attribute string separated by spaces.
 
 
Animating your skin -http://wiki.xbmc.org/?title=Animating_Your_Skin 
 
example:
    - self.button.setAnimations([('focus', 'effect=zoom end=90,247,220,56 time=0',)])
setEnableCondition(...)
setEnableCondition(enable)--Set's the control's enabled condition. Allows XBMC to control the enabled status of the control.
 
enable : string - Enable condition.
 
List of Conditions -http://wiki.xbmc.org/index.php?title=List_of_Boolean_Conditions 
 
example:
    - self.button.setEnableCondition('System.InternetState')
setEnabled(...)
setEnabled(enabled)--Set's the control's enabled/disabled state.
 
enabled : bool - True=enabled / False=disabled.
 
example:
    - self.button.setEnabled(False)n
setHeight(...)
setHeight(height)--Set's the controls height.
 
height : integer - height of control.
 
example:
    - self.image.setHeight(100)
setNavigation(...)
setNavigation(up, down, left, right)--Set's the controls navigation.
 
up : control object - control to navigate to on up.
down : control object - control to navigate to on down.
left : control object - control to navigate to on left.
right : control object - control to navigate to on right.
 
*Note, Same ascontrolUp() ,controlDown() ,controlLeft() ,controlRight() . Set to self to disable navigation for that direction.
 
Throws:
    - TypeError, if one of the supplied arguments is not a control type.
    - ReferenceError, if one of the controls is not added to a window.
 
 
example:
    - self.button.setNavigation(self.button1, self.button2, self.button3, self.button4)
setPosition(...)
setPosition(x, y)--Set's the controls position.
 
x : integer - x coordinate of control.
y : integer - y coordinate of control.
 
*Note, You may use negative integers. (e.g sliding a control into view)
 
example:
    - self.button.setPosition(100, 250)
setVisible(...)
setVisible(visible)--Set's the control's visible/hidden state.
 
visible : bool - True=visible / False=hidden.
 
example:
    - self.button.setVisible(False)
setVisibleCondition(...)
setVisibleCondition(visible[,allowHiddenFocus])--Set's the control's visible condition. Allows XBMC to control the visible status of the control.
 
visible : string - Visible condition.
allowHiddenFocus : bool - True=gains focus even if hidden.
 
List of Conditions -http://wiki.xbmc.org/index.php?title=List_of_Boolean_Conditions 
 
example:
    - self.button.setVisibleCondition('[Control.IsVisible(41) + !Control.IsVisible(12)]', True)
setWidth(...)
setWidth(width)--Set's the controls width.
 
width : integer - width of control.
 
example:
    - self.image.setWidth(100)

 
class ControlEdit(Control)
    ControlEdit class.
 
ControlEdit (x, y, width, height, label[, font, textColor, disabledColor, alignment, focusTexture, noFocusTexture])
 
x : integer - x coordinate of control.
y : integer - y coordinate of control.
width : integer - width of control.
height : integer - height of control.
label : string or unicode - text string.
font : [opt] string - font used for label text. (e.g. 'font13')
textColor : [opt] hexstring - color of enabled label's label. (e.g. '0xFFFFFFFF')
disabledColor : [opt] hexstring - color of disabled label's label. (e.g. '0xFFFF3300')
alignment : [opt] integer - alignment of label - *Note, see xbfont.h
focusTexture : [opt] string - filename for focus texture.
noFocusTexture : [opt] string - filename for no focus texture.
isPassword : [opt] bool - if true, mask text value.
 
*Note, You can use the above as keywords for arguments and skip certain optional arguments.
Once you use a keyword, all following arguments require the keyword.
After you create the control, you need to add it to the window with addControl().
 
 
example:
    - self.edit =xbmcgui.ControlEdit (100, 250, 125, 75, 'Status')
 
 
Method resolution order:
ControlEdit
Control
__builtin__.object

Methods defined here:
getLabel(...)
getLabel() --Returns the text heading for this edit control.
 
example:
    - label = self.edit.getLabel()
getText(...)
getText() --Returns the text value for this edit control.
 
example:
    - value = self.edit.getText()
setLabel(...)
setLabel(label)--Set's text heading for this edit control.
 
label : string or unicode - text string.
 
example:
    - self.edit.setLabel('Status')
setText(...)
setText(value)--Set's text value for this edit control.
 
value : string or unicode - text string.
 
example:
    - self.edit.setText('online')

Data and other attributes defined here:
__new__ = <built-in method __new__ of type object>
T.__new__(S, ...) -> a new object with type S, a subtype of T

Methods inherited from Control:
__cmp__(...)
x.__cmp__(y) <==> cmp(x,y)
canAcceptMessages(...)
controlDown(...)
controlDown(control)--Set's the controls down navigation.
 
control : control object - control to navigate to on down.
 
*Note, You can also usesetNavigation() . Set to self to disable navigation.
 
Throws:
    - TypeError, if one of the supplied arguments is not a control type.
    - ReferenceError, if one of the controls is not added to a window.
 
 
example:
    - self.button.controlDown(self.button1)
controlLeft(...)
controlLeft(control)--Set's the controls left navigation.
 
control : control object - control to navigate to on left.
 
*Note, You can also usesetNavigation() . Set to self to disable navigation.
 
Throws:
    - TypeError, if one of the supplied arguments is not a control type.
    - ReferenceError, if one of the controls is not added to a window.
 
 
example:
    - self.button.controlLeft(self.button1)
controlRight(...)
controlRight(control)--Set's the controls right navigation.
 
control : control object - control to navigate to on right.
 
*Note, You can also usesetNavigation() . Set to self to disable navigation.
 
Throws:
    - TypeError, if one of the supplied arguments is not a control type.
    - ReferenceError, if one of the controls is not added to a window.
 
 
example:
    - self.button.controlRight(self.button1)
controlUp(...)
controlUp(control)--Set's the controls up navigation.
 
control : control object - control to navigate to on up.
 
*Note, You can also usesetNavigation() . Set to self to disable navigation.
 
Throws:
    - TypeError, if one of the supplied arguments is not a control type.
    - ReferenceError, if one of the controls is not added to a window.
 
 
example:
    - self.button.controlUp(self.button1)
getHeight(...)
getHeight() --Returns the control's current height as an integer.
 
example:
    - height = self.button.getHeight()
getId(...)
getId() --Returns the control's current id as an integer.
 
example:
    - id = self.button.getId()
getPosition(...)
getPosition() --Returns the control's current position as a x,y integer tuple.
 
example:
    - pos = self.button.getPosition()
getWidth(...)
getWidth() --Returns the control's current width as an integer.
 
example:
    - width = self.button.getWidth()
getX(...)
getY(...)
setAnimations(...)
setAnimations([(event, attr,)*])--Set's the control's animations.
 
[(event,attr,)*] : list - A list of tuples consisting of event and attributes pairs.
    - event : string - The event to animate.
    - attr : string - The whole attribute string separated by spaces.
 
 
Animating your skin -http://wiki.xbmc.org/?title=Animating_Your_Skin 
 
example:
    - self.button.setAnimations([('focus', 'effect=zoom end=90,247,220,56 time=0',)])
setEnableCondition(...)
setEnableCondition(enable)--Set's the control's enabled condition. Allows XBMC to control the enabled status of the control.
 
enable : string - Enable condition.
 
List of Conditions -http://wiki.xbmc.org/index.php?title=List_of_Boolean_Conditions 
 
example:
    - self.button.setEnableCondition('System.InternetState')
setEnabled(...)
setEnabled(enabled)--Set's the control's enabled/disabled state.
 
enabled : bool - True=enabled / False=disabled.
 
example:
    - self.button.setEnabled(False)n
setHeight(...)
setHeight(height)--Set's the controls height.
 
height : integer - height of control.
 
example:
    - self.image.setHeight(100)
setNavigation(...)
setNavigation(up, down, left, right)--Set's the controls navigation.
 
up : control object - control to navigate to on up.
down : control object - control to navigate to on down.
left : control object - control to navigate to on left.
right : control object - control to navigate to on right.
 
*Note, Same ascontrolUp() ,controlDown() ,controlLeft() ,controlRight() . Set to self to disable navigation for that direction.
 
Throws:
    - TypeError, if one of the supplied arguments is not a control type.
    - ReferenceError, if one of the controls is not added to a window.
 
 
example:
    - self.button.setNavigation(self.button1, self.button2, self.button3, self.button4)
setPosition(...)
setPosition(x, y)--Set's the controls position.
 
x : integer - x coordinate of control.
y : integer - y coordinate of control.
 
*Note, You may use negative integers. (e.g sliding a control into view)
 
example:
    - self.button.setPosition(100, 250)
setVisible(...)
setVisible(visible)--Set's the control's visible/hidden state.
 
visible : bool - True=visible / False=hidden.
 
example:
    - self.button.setVisible(False)
setVisibleCondition(...)
setVisibleCondition(visible[,allowHiddenFocus])--Set's the control's visible condition. Allows XBMC to control the visible status of the control.
 
visible : string - Visible condition.
allowHiddenFocus : bool - True=gains focus even if hidden.
 
List of Conditions -http://wiki.xbmc.org/index.php?title=List_of_Boolean_Conditions 
 
example:
    - self.button.setVisibleCondition('[Control.IsVisible(41) + !Control.IsVisible(12)]', True)
setWidth(...)
setWidth(width)--Set's the controls width.
 
width : integer - width of control.
 
example:
    - self.image.setWidth(100)

 
class ControlFadeLabel(Control)
    ControlFadeLabel class.
Control that scroll's labl
 
ControlFadeLabel(x, y, width, height[, font, textColor, alignment])
 
x : integer - x coordinate of control.
y : integer - y coordinate of control.
width : integer - width of control.
height : integer - height of control.
font : [opt] string - font used for label text. (e.g. 'font13')
textColor : [opt] hexstring - color of fadelabel's labels. (e.g. '0xFFFFFFFF')
alignment : [opt] integer - alignment of label - *Note, see xbfont.h
 
*Note, You can use the above as keywords for arguments and skip certain optional arguments.
Once you use a keyword, all following arguments require the keyword.
After you create the control, you need to add it to the window with addControl().
 
example:
    - self.fadelabel =xbmcgui.ControlFadeLabel (100, 250, 200, 50, textColor='0xFFFFFFFF')
 
 
Method resolution order:
ControlFadeLabel
Control
__builtin__.object

Methods defined here:
addLabel(...)
addLabel(label)--Add a label to this control for scrolling.
 
label : string or unicode - text string.
 
example:
    - self.fadelabel.addLabel('This is a line of text that can scroll.')
reset(...)
reset() --Clear this fade label.
 
example:
    - self.fadelabel.reset()

Data and other attributes defined here:
__new__ = <built-in method __new__ of type object>
T.__new__(S, ...) -> a new object with type S, a subtype of T

Methods inherited from Control:
__cmp__(...)
x.__cmp__(y) <==> cmp(x,y)
canAcceptMessages(...)
controlDown(...)
controlDown(control)--Set's the controls down navigation.
 
control : control object - control to navigate to on down.
 
*Note, You can also usesetNavigation() . Set to self to disable navigation.
 
Throws:
    - TypeError, if one of the supplied arguments is not a control type.
    - ReferenceError, if one of the controls is not added to a window.
 
 
example:
    - self.button.controlDown(self.button1)
controlLeft(...)
controlLeft(control)--Set's the controls left navigation.
 
control : control object - control to navigate to on left.
 
*Note, You can also usesetNavigation() . Set to self to disable navigation.
 
Throws:
    - TypeError, if one of the supplied arguments is not a control type.
    - ReferenceError, if one of the controls is not added to a window.
 
 
example:
    - self.button.controlLeft(self.button1)
controlRight(...)
controlRight(control)--Set's the controls right navigation.
 
control : control object - control to navigate to on right.
 
*Note, You can also usesetNavigation() . Set to self to disable navigation.
 
Throws:
    - TypeError, if one of the supplied arguments is not a control type.
    - ReferenceError, if one of the controls is not added to a window.
 
 
example:
    - self.button.controlRight(self.button1)
controlUp(...)
controlUp(control)--Set's the controls up navigation.
 
control : control object - control to navigate to on up.
 
*Note, You can also usesetNavigation() . Set to self to disable navigation.
 
Throws:
    - TypeError, if one of the supplied arguments is not a control type.
    - ReferenceError, if one of the controls is not added to a window.
 
 
example:
    - self.button.controlUp(self.button1)
getHeight(...)
getHeight() --Returns the control's current height as an integer.
 
example:
    - height = self.button.getHeight()
getId(...)
getId() --Returns the control's current id as an integer.
 
example:
    - id = self.button.getId()
getPosition(...)
getPosition() --Returns the control's current position as a x,y integer tuple.
 
example:
    - pos = self.button.getPosition()
getWidth(...)
getWidth() --Returns the control's current width as an integer.
 
example:
    - width = self.button.getWidth()
getX(...)
getY(...)
setAnimations(...)
setAnimations([(event, attr,)*])--Set's the control's animations.
 
[(event,attr,)*] : list - A list of tuples consisting of event and attributes pairs.
    - event : string - The event to animate.
    - attr : string - The whole attribute string separated by spaces.
 
 
Animating your skin -http://wiki.xbmc.org/?title=Animating_Your_Skin 
 
example:
    - self.button.setAnimations([('focus', 'effect=zoom end=90,247,220,56 time=0',)])
setEnableCondition(...)
setEnableCondition(enable)--Set's the control's enabled condition. Allows XBMC to control the enabled status of the control.
 
enable : string - Enable condition.
 
List of Conditions -http://wiki.xbmc.org/index.php?title=List_of_Boolean_Conditions 
 
example:
    - self.button.setEnableCondition('System.InternetState')
setEnabled(...)
setEnabled(enabled)--Set's the control's enabled/disabled state.
 
enabled : bool - True=enabled / False=disabled.
 
example:
    - self.button.setEnabled(False)n
setHeight(...)
setHeight(height)--Set's the controls height.
 
height : integer - height of control.
 
example:
    - self.image.setHeight(100)
setNavigation(...)
setNavigation(up, down, left, right)--Set's the controls navigation.
 
up : control object - control to navigate to on up.
down : control object - control to navigate to on down.
left : control object - control to navigate to on left.
right : control object - control to navigate to on right.
 
*Note, Same ascontrolUp() ,controlDown() ,controlLeft() ,controlRight() . Set to self to disable navigation for that direction.
 
Throws:
    - TypeError, if one of the supplied arguments is not a control type.
    - ReferenceError, if one of the controls is not added to a window.
 
 
example:
    - self.button.setNavigation(self.button1, self.button2, self.button3, self.button4)
setPosition(...)
setPosition(x, y)--Set's the controls position.
 
x : integer - x coordinate of control.
y : integer - y coordinate of control.
 
*Note, You may use negative integers. (e.g sliding a control into view)
 
example:
    - self.button.setPosition(100, 250)
setVisible(...)
setVisible(visible)--Set's the control's visible/hidden state.
 
visible : bool - True=visible / False=hidden.
 
example:
    - self.button.setVisible(False)
setVisibleCondition(...)
setVisibleCondition(visible[,allowHiddenFocus])--Set's the control's visible condition. Allows XBMC to control the visible status of the control.
 
visible : string - Visible condition.
allowHiddenFocus : bool - True=gains focus even if hidden.
 
List of Conditions -http://wiki.xbmc.org/index.php?title=List_of_Boolean_Conditions 
 
example:
    - self.button.setVisibleCondition('[Control.IsVisible(41) + !Control.IsVisible(12)]', True)
setWidth(...)
setWidth(width)--Set's the controls width.
 
width : integer - width of control.
 
example:
    - self.image.setWidth(100)

 
class ControlGroup(Control)
    ControlGroup class.
 
ControlGroup (x, y, width, height
 
x : integer - x coordinate of control.
y : integer - y coordinate of control.
width : integer - width of control.
height : integer - height of control. example:
    - self.group = xbmcgui.ControlGroup(100, 250, 125, 75)
 
 
Method resolution order:
ControlGroup
Control
__builtin__.object

Data and other attributes defined here:
__new__ = <built-in method __new__ of type object>
T.__new__(S, ...) -> a new object with type S, a subtype of T

Methods inherited from Control:
__cmp__(...)
x.__cmp__(y) <==> cmp(x,y)
canAcceptMessages(...)
controlDown(...)
controlDown(control)--Set's the controls down navigation.
 
control : control object - control to navigate to on down.
 
*Note, You can also usesetNavigation() . Set to self to disable navigation.
 
Throws:
    - TypeError, if one of the supplied arguments is not a control type.
    - ReferenceError, if one of the controls is not added to a window.
 
 
example:
    - self.button.controlDown(self.button1)
controlLeft(...)
controlLeft(control)--Set's the controls left navigation.
 
control : control object - control to navigate to on left.
 
*Note, You can also usesetNavigation() . Set to self to disable navigation.
 
Throws:
    - TypeError, if one of the supplied arguments is not a control type.
    - ReferenceError, if one of the controls is not added to a window.
 
 
example:
    - self.button.controlLeft(self.button1)
controlRight(...)
controlRight(control)--Set's the controls right navigation.
 
control : control object - control to navigate to on right.
 
*Note, You can also usesetNavigation() . Set to self to disable navigation.
 
Throws:
    - TypeError, if one of the supplied arguments is not a control type.
    - ReferenceError, if one of the controls is not added to a window.
 
 
example:
    - self.button.controlRight(self.button1)
controlUp(...)
controlUp(control)--Set's the controls up navigation.
 
control : control object - control to navigate to on up.
 
*Note, You can also usesetNavigation() . Set to self to disable navigation.
 
Throws:
    - TypeError, if one of the supplied arguments is not a control type.
    - ReferenceError, if one of the controls is not added to a window.
 
 
example:
    - self.button.controlUp(self.button1)
getHeight(...)
getHeight() --Returns the control's current height as an integer.
 
example:
    - height = self.button.getHeight()
getId(...)
getId() --Returns the control's current id as an integer.
 
example:
    - id = self.button.getId()
getPosition(...)
getPosition() --Returns the control's current position as a x,y integer tuple.
 
example:
    - pos = self.button.getPosition()
getWidth(...)
getWidth() --Returns the control's current width as an integer.
 
example:
    - width = self.button.getWidth()
getX(...)
getY(...)
setAnimations(...)
setAnimations([(event, attr,)*])--Set's the control's animations.
 
[(event,attr,)*] : list - A list of tuples consisting of event and attributes pairs.
    - event : string - The event to animate.
    - attr : string - The whole attribute string separated by spaces.
 
 
Animating your skin -http://wiki.xbmc.org/?title=Animating_Your_Skin 
 
example:
    - self.button.setAnimations([('focus', 'effect=zoom end=90,247,220,56 time=0',)])
setEnableCondition(...)
setEnableCondition(enable)--Set's the control's enabled condition. Allows XBMC to control the enabled status of the control.
 
enable : string - Enable condition.
 
List of Conditions -http://wiki.xbmc.org/index.php?title=List_of_Boolean_Conditions 
 
example:
    - self.button.setEnableCondition('System.InternetState')
setEnabled(...)
setEnabled(enabled)--Set's the control's enabled/disabled state.
 
enabled : bool - True=enabled / False=disabled.
 
example:
    - self.button.setEnabled(False)n
setHeight(...)
setHeight(height)--Set's the controls height.
 
height : integer - height of control.
 
example:
    - self.image.setHeight(100)
setNavigation(...)
setNavigation(up, down, left, right)--Set's the controls navigation.
 
up : control object - control to navigate to on up.
down : control object - control to navigate to on down.
left : control object - control to navigate to on left.
right : control object - control to navigate to on right.
 
*Note, Same ascontrolUp() ,controlDown() ,controlLeft() ,controlRight() . Set to self to disable navigation for that direction.
 
Throws:
    - TypeError, if one of the supplied arguments is not a control type.
    - ReferenceError, if one of the controls is not added to a window.
 
 
example:
    - self.button.setNavigation(self.button1, self.button2, self.button3, self.button4)
setPosition(...)
setPosition(x, y)--Set's the controls position.
 
x : integer - x coordinate of control.
y : integer - y coordinate of control.
 
*Note, You may use negative integers. (e.g sliding a control into view)
 
example:
    - self.button.setPosition(100, 250)
setVisible(...)
setVisible(visible)--Set's the control's visible/hidden state.
 
visible : bool - True=visible / False=hidden.
 
example:
    - self.button.setVisible(False)
setVisibleCondition(...)
setVisibleCondition(visible[,allowHiddenFocus])--Set's the control's visible condition. Allows XBMC to control the visible status of the control.
 
visible : string - Visible condition.
allowHiddenFocus : bool - True=gains focus even if hidden.
 
List of Conditions -http://wiki.xbmc.org/index.php?title=List_of_Boolean_Conditions 
 
example:
    - self.button.setVisibleCondition('[Control.IsVisible(41) + !Control.IsVisible(12)]', True)
setWidth(...)
setWidth(width)--Set's the controls width.
 
width : integer - width of control.
 
example:
    - self.image.setWidth(100)

 
class ControlImage(Control)
    ControlImage class.
 
ControlImage(x, y, width, height, filename[, aspectRatio, colorDiffuse])
 
x : integer - x coordinate of control.
y : integer - y coordinate of control.
width : integer - width of control.
height : integer - height of control.
filename : string - image filename.
aspectRatio : [opt] integer - (values 0 = stretch (default), 1 = scale up (crops), 2 = scale down (black bar
colorDiffuse : hexString - (example, '0xC0FF0000' (red tint))
 
*Note, You can use the above as keywords for arguments and skip certain optional arguments.
Once you use a keyword, all following arguments require the keyword.
After you create the control, you need to add it to the window with addControl().
 
example:
    - self.image =xbmcgui.ControlImage (100, 250, 125, 75, aspectRatio=2)
 
 
Method resolution order:
ControlImage
Control
__builtin__.object

Methods defined here:
setColorDiffuse(...)
setColorDiffuse(colorDiffuse)--Changes the images color.
 
colorDiffuse : hexString - (example, '0xC0FF0000' (red tint))
 
example:
    - self.image.setColorDiffuse('0xC0FF0000')
setImage(...)
setImage(filename, useCache)--Changes the image.
 
filename : string - image filename. useCache : [opt] bool - true/use cache, false/don't use cache
 
example:
    - self.image.setImage('special://home/scripts/test.png')

Data and other attributes defined here:
__new__ = <built-in method __new__ of type object>
T.__new__(S, ...) -> a new object with type S, a subtype of T

Methods inherited from Control:
__cmp__(...)
x.__cmp__(y) <==> cmp(x,y)
canAcceptMessages(...)
controlDown(...)
controlDown(control)--Set's the controls down navigation.
 
control : control object - control to navigate to on down.
 
*Note, You can also usesetNavigation() . Set to self to disable navigation.
 
Throws:
    - TypeError, if one of the supplied arguments is not a control type.
    - ReferenceError, if one of the controls is not added to a window.
 
 
example:
    - self.button.controlDown(self.button1)
controlLeft(...)
controlLeft(control)--Set's the controls left navigation.
 
control : control object - control to navigate to on left.
 
*Note, You can also usesetNavigation() . Set to self to disable navigation.
 
Throws:
    - TypeError, if one of the supplied arguments is not a control type.
    - ReferenceError, if one of the controls is not added to a window.
 
 
example:
    - self.button.controlLeft(self.button1)
controlRight(...)
controlRight(control)--Set's the controls right navigation.
 
control : control object - control to navigate to on right.
 
*Note, You can also usesetNavigation() . Set to self to disable navigation.
 
Throws:
    - TypeError, if one of the supplied arguments is not a control type.
    - ReferenceError, if one of the controls is not added to a window.
 
 
example:
    - self.button.controlRight(self.button1)
controlUp(...)
controlUp(control)--Set's the controls up navigation.
 
control : control object - control to navigate to on up.
 
*Note, You can also usesetNavigation() . Set to self to disable navigation.
 
Throws:
    - TypeError, if one of the supplied arguments is not a control type.
    - ReferenceError, if one of the controls is not added to a window.
 
 
example:
    - self.button.controlUp(self.button1)
getHeight(...)
getHeight() --Returns the control's current height as an integer.
 
example:
    - height = self.button.getHeight()
getId(...)
getId() --Returns the control's current id as an integer.
 
example:
    - id = self.button.getId()
getPosition(...)
getPosition() --Returns the control's current position as a x,y integer tuple.
 
example:
    - pos = self.button.getPosition()
getWidth(...)
getWidth() --Returns the control's current width as an integer.
 
example:
    - width = self.button.getWidth()
getX(...)
getY(...)
setAnimations(...)
setAnimations([(event, attr,)*])--Set's the control's animations.
 
[(event,attr,)*] : list - A list of tuples consisting of event and attributes pairs.
    - event : string - The event to animate.
    - attr : string - The whole attribute string separated by spaces.
 
 
Animating your skin -http://wiki.xbmc.org/?title=Animating_Your_Skin 
 
example:
    - self.button.setAnimations([('focus', 'effect=zoom end=90,247,220,56 time=0',)])
setEnableCondition(...)
setEnableCondition(enable)--Set's the control's enabled condition. Allows XBMC to control the enabled status of the control.
 
enable : string - Enable condition.
 
List of Conditions -http://wiki.xbmc.org/index.php?title=List_of_Boolean_Conditions 
 
example:
    - self.button.setEnableCondition('System.InternetState')
setEnabled(...)
setEnabled(enabled)--Set's the control's enabled/disabled state.
 
enabled : bool - True=enabled / False=disabled.
 
example:
    - self.button.setEnabled(False)n
setHeight(...)
setHeight(height)--Set's the controls height.
 
height : integer - height of control.
 
example:
    - self.image.setHeight(100)
setNavigation(...)
setNavigation(up, down, left, right)--Set's the controls navigation.
 
up : control object - control to navigate to on up.
down : control object - control to navigate to on down.
left : control object - control to navigate to on left.
right : control object - control to navigate to on right.
 
*Note, Same ascontrolUp() ,controlDown() ,controlLeft() ,controlRight() . Set to self to disable navigation for that direction.
 
Throws:
    - TypeError, if one of the supplied arguments is not a control type.
    - ReferenceError, if one of the controls is not added to a window.
 
 
example:
    - self.button.setNavigation(self.button1, self.button2, self.button3, self.button4)
setPosition(...)
setPosition(x, y)--Set's the controls position.
 
x : integer - x coordinate of control.
y : integer - y coordinate of control.
 
*Note, You may use negative integers. (e.g sliding a control into view)
 
example:
    - self.button.setPosition(100, 250)
setVisible(...)
setVisible(visible)--Set's the control's visible/hidden state.
 
visible : bool - True=visible / False=hidden.
 
example:
    - self.button.setVisible(False)
setVisibleCondition(...)
setVisibleCondition(visible[,allowHiddenFocus])--Set's the control's visible condition. Allows XBMC to control the visible status of the control.
 
visible : string - Visible condition.
allowHiddenFocus : bool - True=gains focus even if hidden.
 
List of Conditions -http://wiki.xbmc.org/index.php?title=List_of_Boolean_Conditions 
 
example:
    - self.button.setVisibleCondition('[Control.IsVisible(41) + !Control.IsVisible(12)]', True)
setWidth(...)
setWidth(width)--Set's the controls width.
 
width : integer - width of control.
 
example:
    - self.image.setWidth(100)

 
class ControlLabel(Control)
    ControlLabel class.
 
ControlLabel (x, y, width, height, label[, font, textColor, disabledColor, alignment, hasPath, angle])
 
x : integer - x coordinate of control.
y : integer - y coordinate of control.
width : integer - width of control.
height : integer - height of control.
label : string or unicode - text string.
font : [opt] string - font used for label text. (e.g. 'font13')
textColor : [opt] hexstring - color of enabled label's label. (e.g. '0xFFFFFFFF')
disabledColor : [opt] hexstring - color of disabled label's label. (e.g. '0xFFFF3300')
alignment : [opt] integer - alignment of label - *Note, see xbfont.h
hasPath : [opt] bool - True=stores a path / False=no path.
angle : [opt] integer - angle of control. (+ rotates CCW, - rotates C
 
 
example:
    - self.label =xbmcgui.ControlLabel (100, 250, 125, 75, 'Status', angle=45)
 
 
Method resolution order:
ControlLabel
Control
__builtin__.object

Methods defined here:
getLabel(...)
getLabel() --Returns the text value for this label.
 
example:
    - label = self.label.getLabel()
setLabel(...)
setLabel(label)--Set's text for this label.
 
label : string or unicode - text string.
 
example:
    - self.label.setLabel('Status')

Data and other attributes defined here:
__new__ = <built-in method __new__ of type object>
T.__new__(S, ...) -> a new object with type S, a subtype of T

Methods inherited from Control:
__cmp__(...)
x.__cmp__(y) <==> cmp(x,y)
canAcceptMessages(...)
controlDown(...)
controlDown(control)--Set's the controls down navigation.
 
control : control object - control to navigate to on down.
 
*Note, You can also usesetNavigation() . Set to self to disable navigation.
 
Throws:
    - TypeError, if one of the supplied arguments is not a control type.
    - ReferenceError, if one of the controls is not added to a window.
 
 
example:
    - self.button.controlDown(self.button1)
controlLeft(...)
controlLeft(control)--Set's the controls left navigation.
 
control : control object - control to navigate to on left.
 
*Note, You can also usesetNavigation() . Set to self to disable navigation.
 
Throws:
    - TypeError, if one of the supplied arguments is not a control type.
    - ReferenceError, if one of the controls is not added to a window.
 
 
example:
    - self.button.controlLeft(self.button1)
controlRight(...)
controlRight(control)--Set's the controls right navigation.
 
control : control object - control to navigate to on right.
 
*Note, You can also usesetNavigation() . Set to self to disable navigation.
 
Throws:
    - TypeError, if one of the supplied arguments is not a control type.
    - ReferenceError, if one of the controls is not added to a window.
 
 
example:
    - self.button.controlRight(self.button1)
controlUp(...)
controlUp(control)--Set's the controls up navigation.
 
control : control object - control to navigate to on up.
 
*Note, You can also usesetNavigation() . Set to self to disable navigation.
 
Throws:
    - TypeError, if one of the supplied arguments is not a control type.
    - ReferenceError, if one of the controls is not added to a window.
 
 
example:
    - self.button.controlUp(self.button1)
getHeight(...)
getHeight() --Returns the control's current height as an integer.
 
example:
    - height = self.button.getHeight()
getId(...)
getId() --Returns the control's current id as an integer.
 
example:
    - id = self.button.getId()
getPosition(...)
getPosition() --Returns the control's current position as a x,y integer tuple.
 
example:
    - pos = self.button.getPosition()
getWidth(...)
getWidth() --Returns the control's current width as an integer.
 
example:
    - width = self.button.getWidth()
getX(...)
getY(...)
setAnimations(...)
setAnimations([(event, attr,)*])--Set's the control's animations.
 
[(event,attr,)*] : list - A list of tuples consisting of event and attributes pairs.
    - event : string - The event to animate.
    - attr : string - The whole attribute string separated by spaces.
 
 
Animating your skin -http://wiki.xbmc.org/?title=Animating_Your_Skin 
 
example:
    - self.button.setAnimations([('focus', 'effect=zoom end=90,247,220,56 time=0',)])
setEnableCondition(...)
setEnableCondition(enable)--Set's the control's enabled condition. Allows XBMC to control the enabled status of the control.
 
enable : string - Enable condition.
 
List of Conditions -http://wiki.xbmc.org/index.php?title=List_of_Boolean_Conditions 
 
example:
    - self.button.setEnableCondition('System.InternetState')
setEnabled(...)
setEnabled(enabled)--Set's the control's enabled/disabled state.
 
enabled : bool - True=enabled / False=disabled.
 
example:
    - self.button.setEnabled(False)n
setHeight(...)
setHeight(height)--Set's the controls height.
 
height : integer - height of control.
 
example:
    - self.image.setHeight(100)
setNavigation(...)
setNavigation(up, down, left, right)--Set's the controls navigation.
 
up : control object - control to navigate to on up.
down : control object - control to navigate to on down.
left : control object - control to navigate to on left.
right : control object - control to navigate to on right.
 
*Note, Same ascontrolUp() ,controlDown() ,controlLeft() ,controlRight() . Set to self to disable navigation for that direction.
 
Throws:
    - TypeError, if one of the supplied arguments is not a control type.
    - ReferenceError, if one of the controls is not added to a window.
 
 
example:
    - self.button.setNavigation(self.button1, self.button2, self.button3, self.button4)
setPosition(...)
setPosition(x, y)--Set's the controls position.
 
x : integer - x coordinate of control.
y : integer - y coordinate of control.
 
*Note, You may use negative integers. (e.g sliding a control into view)
 
example:
    - self.button.setPosition(100, 250)
setVisible(...)
setVisible(visible)--Set's the control's visible/hidden state.
 
visible : bool - True=visible / False=hidden.
 
example:
    - self.button.setVisible(False)
setVisibleCondition(...)
setVisibleCondition(visible[,allowHiddenFocus])--Set's the control's visible condition. Allows XBMC to control the visible status of the control.
 
visible : string - Visible condition.
allowHiddenFocus : bool - True=gains focus even if hidden.
 
List of Conditions -http://wiki.xbmc.org/index.php?title=List_of_Boolean_Conditions 
 
example:
    - self.button.setVisibleCondition('[Control.IsVisible(41) + !Control.IsVisible(12)]', True)
setWidth(...)
setWidth(width)--Set's the controls width.
 
width : integer - width of control.
 
example:
    - self.image.setWidth(100)

 
class ControlList(Control)
    ControlList class.
 
ControlList (x, y, width, height[, font, textColor, buttonTexture, buttonFocusTexture, selectedColor, imageWidth, imageHeight, itemTextXOffset, itemTextYOffset, itemHeight, space, alignmentY])n"//, shadowColor])
 
x : integer - x coordinate of control.
y : integer - y coordinate of control.
width : integer - width of control.
height : integer - height of control.
font : [opt] string - font used for items label. (e.g. 'font13')
textColor : [opt] hexstring - color of items label. (e.g. '0xFFFFFFFF')
buttonTexture : [opt] string - filename for focus texture.
buttonFocusTexture : [opt] string - filename for no focus texture.
selectedColor : [opt] integer - x offset of label.
imageWidth : [opt] integer - width of items icon or thumbnail.
imageHeight : [opt] integer - height of items icon or thumbnail.
itemTextXOffset : [opt] integer - x offset of items label.
itemTextYOffset : [opt] integer - y offset of items label.
itemHeight : [opt] integer - height of items.
space : [opt] integer - space between items.
alignmentY : [opt] integer - Y-axis alignment of items label - *Note, see xbfont.h
//"shadowColor : [opt] hexstring - color of items label's shadow. (e.g. '0xFF000000')
 
*Note, You can use the above as keywords for arguments and skip certain optional arguments.
Once you use a keyword, all following arguments require the keyword.
After you create the control, you need to add it to the window with addControl().
 
 
example:
    - self.cList =xbmcgui.ControlList (100, 250, 200, 250, 'font14', space=5)
 
 
Method resolution order:
ControlList
Control
__builtin__.object

Methods defined here:
addItem(...)
addItem(item)--Add a new item to this list control.
 
item : string, unicode orListItem - item to add.
 
example:
    - cList.addItem('Reboot XBMC')
addItems(...)
addItems(items)--Adds a list of listitems or strings to this list control.
 
items :List - list of strings, unicode objects or ListItems to add.
 
*Note, You can use the above as keywords for arguments.
 
Large lists benefit considerably, than using the standardaddItem() 
 
example:
    - cList.addItems(items=listitems)
getItemHeight(...)
getItemHeight() --Returns the control's current item height as an integer.
 
example:
    - item_height = self.cList.getItemHeight()
getListItem(...)
getListItem(index)--Returns a givenListItem in thisList .
 
index : integer - index number of item to return.
 
*Note, throws a ValueError if index is out of range.
 
example:
    - listitem = cList.getListItem(6)
getSelectedItem(...)
getSelectedItem() --Returns the selected item as aListItem object.
 
*Note, Same asgetSelectedPosition() , but instead of an integer aListItem object
is returned. Returns None for empty lists.
See windowexample.py on how to use this.
 
example:
    - item = cList.getSelectedItem()
getSelectedPosition(...)
getSelectedPosition() --Returns the position of the selected item as an integer.
 
*Note, Returns -1 for empty lists.
 
example:
    - pos = cList.getSelectedPosition()
getSpace(...)
getSpace() --Returns the control's space between items as an integer.
 
example:
    - gap = self.cList.getSpace()
getSpinControl(...)
getSpinControl() --returns the associatedControlSpin object.
 
*Note, Not working completely yet -
After adding this control list to a window it is not possible to change
the settings of this spin control.
 
example:
    - ctl = cList.getSpinControl()
removeItem(...)
removeItem(index)--Remove an item by index number.
 
index : integer - index number of the item to remove.
 
example:
    - cList.removeItem(12)
reset(...)
reset() --Clear all ListItems in this control list.
 
example:
    - cList.reset()
selectItem(...)
selectItem(item)--Select an item by index number.
 
item : integer - index number of the item to select.
 
example:
    - cList.selectItem(12)
setImageDimensions(...)
setImageDimensions(imageWidth, imageHeight)--Sets the width/height of items icon or thumbnail.
 
imageWidth : [opt] integer - width of items icon or thumbnail.
imageHeight : [opt] integer - height of items icon or thumbnail.
 
example:
    - cList.setImageDimensions(18, 18)
setItemHeight(...)
setItemHeight(itemHeight)--Sets the height of items.
 
itemHeight : integer - height of items.
 
example:
    - cList.setItemHeight(25)
setPageControlVisible(...)
setPageControlVisible(visible)--Sets the spin control's visible/hidden state.
 
visible : boolean - True=visible / False=hidden.
 
example:
    - cList.setPageControlVisible(True)
setSpace(...)
setSpace(space)--Set's the space between items.
 
space : [opt] integer - space between items.
 
example:
    - cList.setSpace(5)
setStaticContent(...)
setStaticContent(items)--Fills a static list with a list of listitems.
 
items :List - list of listitems to add.
 
*Note, You can use the above as keywords for arguments.
 
example:
    - cList.setStaticContent(items=listitems)
size(...)
size() --Returns the total number of items in this list control as an integer.
 
example:
    - cnt = cList.size()

Data and other attributes defined here:
__new__ = <built-in method __new__ of type object>
T.__new__(S, ...) -> a new object with type S, a subtype of T

Methods inherited from Control:
__cmp__(...)
x.__cmp__(y) <==> cmp(x,y)
canAcceptMessages(...)
controlDown(...)
controlDown(control)--Set's the controls down navigation.
 
control : control object - control to navigate to on down.
 
*Note, You can also usesetNavigation() . Set to self to disable navigation.
 
Throws:
    - TypeError, if one of the supplied arguments is not a control type.
    - ReferenceError, if one of the controls is not added to a window.
 
 
example:
    - self.button.controlDown(self.button1)
controlLeft(...)
controlLeft(control)--Set's the controls left navigation.
 
control : control object - control to navigate to on left.
 
*Note, You can also usesetNavigation() . Set to self to disable navigation.
 
Throws:
    - TypeError, if one of the supplied arguments is not a control type.
    - ReferenceError, if one of the controls is not added to a window.
 
 
example:
    - self.button.controlLeft(self.button1)
controlRight(...)
controlRight(control)--Set's the controls right navigation.
 
control : control object - control to navigate to on right.
 
*Note, You can also usesetNavigation() . Set to self to disable navigation.
 
Throws:
    - TypeError, if one of the supplied arguments is not a control type.
    - ReferenceError, if one of the controls is not added to a window.
 
 
example:
    - self.button.controlRight(self.button1)
controlUp(...)
controlUp(control)--Set's the controls up navigation.
 
control : control object - control to navigate to on up.
 
*Note, You can also usesetNavigation() . Set to self to disable navigation.
 
Throws:
    - TypeError, if one of the supplied arguments is not a control type.
    - ReferenceError, if one of the controls is not added to a window.
 
 
example:
    - self.button.controlUp(self.button1)
getHeight(...)
getHeight() --Returns the control's current height as an integer.
 
example:
    - height = self.button.getHeight()
getId(...)
getId() --Returns the control's current id as an integer.
 
example:
    - id = self.button.getId()
getPosition(...)
getPosition() --Returns the control's current position as a x,y integer tuple.
 
example:
    - pos = self.button.getPosition()
getWidth(...)
getWidth() --Returns the control's current width as an integer.
 
example:
    - width = self.button.getWidth()
getX(...)
getY(...)
setAnimations(...)
setAnimations([(event, attr,)*])--Set's the control's animations.
 
[(event,attr,)*] : list - A list of tuples consisting of event and attributes pairs.
    - event : string - The event to animate.
    - attr : string - The whole attribute string separated by spaces.
 
 
Animating your skin -http://wiki.xbmc.org/?title=Animating_Your_Skin 
 
example:
    - self.button.setAnimations([('focus', 'effect=zoom end=90,247,220,56 time=0',)])
setEnableCondition(...)
setEnableCondition(enable)--Set's the control's enabled condition. Allows XBMC to control the enabled status of the control.
 
enable : string - Enable condition.
 
List of Conditions -http://wiki.xbmc.org/index.php?title=List_of_Boolean_Conditions 
 
example:
    - self.button.setEnableCondition('System.InternetState')
setEnabled(...)
setEnabled(enabled)--Set's the control's enabled/disabled state.
 
enabled : bool - True=enabled / False=disabled.
 
example:
    - self.button.setEnabled(False)n
setHeight(...)
setHeight(height)--Set's the controls height.
 
height : integer - height of control.
 
example:
    - self.image.setHeight(100)
setNavigation(...)
setNavigation(up, down, left, right)--Set's the controls navigation.
 
up : control object - control to navigate to on up.
down : control object - control to navigate to on down.
left : control object - control to navigate to on left.
right : control object - control to navigate to on right.
 
*Note, Same ascontrolUp() ,controlDown() ,controlLeft() ,controlRight() . Set to self to disable navigation for that direction.
 
Throws:
    - TypeError, if one of the supplied arguments is not a control type.
    - ReferenceError, if one of the controls is not added to a window.
 
 
example:
    - self.button.setNavigation(self.button1, self.button2, self.button3, self.button4)
setPosition(...)
setPosition(x, y)--Set's the controls position.
 
x : integer - x coordinate of control.
y : integer - y coordinate of control.
 
*Note, You may use negative integers. (e.g sliding a control into view)
 
example:
    - self.button.setPosition(100, 250)
setVisible(...)
setVisible(visible)--Set's the control's visible/hidden state.
 
visible : bool - True=visible / False=hidden.
 
example:
    - self.button.setVisible(False)
setVisibleCondition(...)
setVisibleCondition(visible[,allowHiddenFocus])--Set's the control's visible condition. Allows XBMC to control the visible status of the control.
 
visible : string - Visible condition.
allowHiddenFocus : bool - True=gains focus even if hidden.
 
List of Conditions -http://wiki.xbmc.org/index.php?title=List_of_Boolean_Conditions 
 
example:
    - self.button.setVisibleCondition('[Control.IsVisible(41) + !Control.IsVisible(12)]', True)
setWidth(...)
setWidth(width)--Set's the controls width.
 
width : integer - width of control.
 
example:
    - self.image.setWidth(100)

 
class ControlProgress(Control)
    
Method resolution order:
ControlProgress
Control
__builtin__.object

Methods defined here:
getPercent(...)
getPercent() --Returns a float of the percent of the progress.
 
example:
    - print self.progress.getValue()
setPercent(...)
setPercent(percent)--Sets the percentage of the progressbar to show.
 
percent : float - percentage of the bar to show.
 
*Note, valid range for percent is 0-100
 
example:
    - self.progress.setPercent(60)

Data and other attributes defined here:
__new__ = <built-in method __new__ of type object>
T.__new__(S, ...) -> a new object with type S, a subtype of T

Methods inherited from Control:
__cmp__(...)
x.__cmp__(y) <==> cmp(x,y)
canAcceptMessages(...)
controlDown(...)
controlDown(control)--Set's the controls down navigation.
 
control : control object - control to navigate to on down.
 
*Note, You can also usesetNavigation() . Set to self to disable navigation.
 
Throws:
    - TypeError, if one of the supplied arguments is not a control type.
    - ReferenceError, if one of the controls is not added to a window.
 
 
example:
    - self.button.controlDown(self.button1)
controlLeft(...)
controlLeft(control)--Set's the controls left navigation.
 
control : control object - control to navigate to on left.
 
*Note, You can also usesetNavigation() . Set to self to disable navigation.
 
Throws:
    - TypeError, if one of the supplied arguments is not a control type.
    - ReferenceError, if one of the controls is not added to a window.
 
 
example:
    - self.button.controlLeft(self.button1)
controlRight(...)
controlRight(control)--Set's the controls right navigation.
 
control : control object - control to navigate to on right.
 
*Note, You can also usesetNavigation() . Set to self to disable navigation.
 
Throws:
    - TypeError, if one of the supplied arguments is not a control type.
    - ReferenceError, if one of the controls is not added to a window.
 
 
example:
    - self.button.controlRight(self.button1)
controlUp(...)
controlUp(control)--Set's the controls up navigation.
 
control : control object - control to navigate to on up.
 
*Note, You can also usesetNavigation() . Set to self to disable navigation.
 
Throws:
    - TypeError, if one of the supplied arguments is not a control type.
    - ReferenceError, if one of the controls is not added to a window.
 
 
example:
    - self.button.controlUp(self.button1)
getHeight(...)
getHeight() --Returns the control's current height as an integer.
 
example:
    - height = self.button.getHeight()
getId(...)
getId() --Returns the control's current id as an integer.
 
example:
    - id = self.button.getId()
getPosition(...)
getPosition() --Returns the control's current position as a x,y integer tuple.
 
example:
    - pos = self.button.getPosition()
getWidth(...)
getWidth() --Returns the control's current width as an integer.
 
example:
    - width = self.button.getWidth()
getX(...)
getY(...)
setAnimations(...)
setAnimations([(event, attr,)*])--Set's the control's animations.
 
[(event,attr,)*] : list - A list of tuples consisting of event and attributes pairs.
    - event : string - The event to animate.
    - attr : string - The whole attribute string separated by spaces.
 
 
Animating your skin -http://wiki.xbmc.org/?title=Animating_Your_Skin 
 
example:
    - self.button.setAnimations([('focus', 'effect=zoom end=90,247,220,56 time=0',)])
setEnableCondition(...)
setEnableCondition(enable)--Set's the control's enabled condition. Allows XBMC to control the enabled status of the control.
 
enable : string - Enable condition.
 
List of Conditions -http://wiki.xbmc.org/index.php?title=List_of_Boolean_Conditions 
 
example:
    - self.button.setEnableCondition('System.InternetState')
setEnabled(...)
setEnabled(enabled)--Set's the control's enabled/disabled state.
 
enabled : bool - True=enabled / False=disabled.
 
example:
    - self.button.setEnabled(False)n
setHeight(...)
setHeight(height)--Set's the controls height.
 
height : integer - height of control.
 
example:
    - self.image.setHeight(100)
setNavigation(...)
setNavigation(up, down, left, right)--Set's the controls navigation.
 
up : control object - control to navigate to on up.
down : control object - control to navigate to on down.
left : control object - control to navigate to on left.
right : control object - control to navigate to on right.
 
*Note, Same ascontrolUp() ,controlDown() ,controlLeft() ,controlRight() . Set to self to disable navigation for that direction.
 
Throws:
    - TypeError, if one of the supplied arguments is not a control type.
    - ReferenceError, if one of the controls is not added to a window.
 
 
example:
    - self.button.setNavigation(self.button1, self.button2, self.button3, self.button4)
setPosition(...)
setPosition(x, y)--Set's the controls position.
 
x : integer - x coordinate of control.
y : integer - y coordinate of control.
 
*Note, You may use negative integers. (e.g sliding a control into view)
 
example:
    - self.button.setPosition(100, 250)
setVisible(...)
setVisible(visible)--Set's the control's visible/hidden state.
 
visible : bool - True=visible / False=hidden.
 
example:
    - self.button.setVisible(False)
setVisibleCondition(...)
setVisibleCondition(visible[,allowHiddenFocus])--Set's the control's visible condition. Allows XBMC to control the visible status of the control.
 
visible : string - Visible condition.
allowHiddenFocus : bool - True=gains focus even if hidden.
 
List of Conditions -http://wiki.xbmc.org/index.php?title=List_of_Boolean_Conditions 
 
example:
    - self.button.setVisibleCondition('[Control.IsVisible(41) + !Control.IsVisible(12)]', True)
setWidth(...)
setWidth(width)--Set's the controls width.
 
width : integer - width of control.
 
example:
    - self.image.setWidth(100)

 
class ControlRadioButton(Control)
    ControlRadioButton class.
 
ControlRadioButton (x, y, width, height, label[, focusOnTexture, noFocusOnTexture,
focusOffTexture, noFocusOffTexture, focusTexture, noFocusTexture,
textOffsetX, textOffsetY, alignment, font, textColor, disabledColor])
 
x : integer - x coordinate of control.
y : integer - y coordinate of control.
width : integer - width of control.
height : integer - height of control.
label : string or unicode - text string.
focusOnTexture : [opt] string - filename for radio ON focused texture.
noFocusOnTexture : [opt] string - filename for radio ON not focused texture.
focusOfTexture : [opt] string - filename for radio OFF focused texture.
noFocusOffTexture : [opt] string - filename for radio OFF not focused texture.
focusTexture : [opt] string - filename for radio ON texture (deprecated, use focusOnTexture and noFocusOnTexture).
noFocusTexture : [opt] string - filename for radio OFF texture (deprecated, use focusOffTexture and noFocusOffTexture).
textOffsetX : [opt] integer - horizontal text offset
textOffsetY : [opt] integer - vertical text offset
alignment : [opt] integer - alignment of label - *Note, see xbfont.h
font : [opt] string - font used for label text. (e.g. 'font13')
textColor : [opt] hexstring - color of enabled checkmark's label. (e.g. '0xFFFFFFFF')
disabledColor : [opt] hexstring - color of disabled checkmark's label. (e.g. '0xFFFF3300')
 
*Note, You can use the above as keywords for arguments and skip certain optional arguments.
Once you use a keyword, all following arguments require the keyword.
After you create the control, you need to add it to the window with addControl().
 
example:
    - self.radiobutton =xbmcgui.ControlRadioButton (100, 250, 200, 50, 'Enable', font='font14')
 
 
Method resolution order:
ControlRadioButton
Control
__builtin__.object

Methods defined here:
isSelected(...)
isSelected() --Returns the radio buttons's selected status.
 
example:
    - is = self.radiobutton.isSelected()
setLabel(...)
setLabel(label[, font, textColor, disabledColor, shadowColor, focusedColor])--Set's the radio buttons text attributes.
 
label : string or unicode - text string.
font : [opt] string - font used for label text. (e.g. 'font13')
textColor : [opt] hexstring - color of enabled radio button's label. (e.g. '0xFFFFFFFF')
disabledColor : [opt] hexstring - color of disabled radio button's label. (e.g. '0xFFFF3300')
shadowColor : [opt] hexstring - color of radio button's label's shadow. (e.g. '0xFF000000')
focusedColor : [opt] hexstring - color of focused radio button's label. (e.g. '0xFFFFFF00')
 
*Note, You can use the above as keywords for arguments and skip certain optional arguments.
Once you use a keyword, all following arguments require the keyword.
 
example:
    - self.radiobutton.setLabel('Status', 'font14', '0xFFFFFFFF', '0xFFFF3300', '0xFF000000')
setRadioDimension(...)
setRadioDimension(x, y, width, height)--Sets the radio buttons's radio texture's position and size.
 
x : integer - x coordinate of radio texture.
y : integer - y coordinate of radio texture.
width : integer - width of radio texture.
height : integer - height of radio texture.
 
*Note, You can use the above as keywords for arguments and skip certain optional arguments.
Once you use a keyword, all following arguments require the keyword.
 
example:
    - self.radiobutton.setRadioDimension(x=100, y=5, width=20, height=20)
setSelected(...)
setSelected(selected)--Sets the radio buttons's selected status.
 
selected : bool - True=selected (on) / False=not selected (off)
 
*Note, You can use the above as keywords for arguments and skip certain optional arguments.
Once you use a keyword, all following arguments require the keyword.
 
example:
    - self.radiobutton.setSelected(True)

Data and other attributes defined here:
__new__ = <built-in method __new__ of type object>
T.__new__(S, ...) -> a new object with type S, a subtype of T

Methods inherited from Control:
__cmp__(...)
x.__cmp__(y) <==> cmp(x,y)
canAcceptMessages(...)
controlDown(...)
controlDown(control)--Set's the controls down navigation.
 
control : control object - control to navigate to on down.
 
*Note, You can also usesetNavigation() . Set to self to disable navigation.
 
Throws:
    - TypeError, if one of the supplied arguments is not a control type.
    - ReferenceError, if one of the controls is not added to a window.
 
 
example:
    - self.button.controlDown(self.button1)
controlLeft(...)
controlLeft(control)--Set's the controls left navigation.
 
control : control object - control to navigate to on left.
 
*Note, You can also usesetNavigation() . Set to self to disable navigation.
 
Throws:
    - TypeError, if one of the supplied arguments is not a control type.
    - ReferenceError, if one of the controls is not added to a window.
 
 
example:
    - self.button.controlLeft(self.button1)
controlRight(...)
controlRight(control)--Set's the controls right navigation.
 
control : control object - control to navigate to on right.
 
*Note, You can also usesetNavigation() . Set to self to disable navigation.
 
Throws:
    - TypeError, if one of the supplied arguments is not a control type.
    - ReferenceError, if one of the controls is not added to a window.
 
 
example:
    - self.button.controlRight(self.button1)
controlUp(...)
controlUp(control)--Set's the controls up navigation.
 
control : control object - control to navigate to on up.
 
*Note, You can also usesetNavigation() . Set to self to disable navigation.
 
Throws:
    - TypeError, if one of the supplied arguments is not a control type.
    - ReferenceError, if one of the controls is not added to a window.
 
 
example:
    - self.button.controlUp(self.button1)
getHeight(...)
getHeight() --Returns the control's current height as an integer.
 
example:
    - height = self.button.getHeight()
getId(...)
getId() --Returns the control's current id as an integer.
 
example:
    - id = self.button.getId()
getPosition(...)
getPosition() --Returns the control's current position as a x,y integer tuple.
 
example:
    - pos = self.button.getPosition()
getWidth(...)
getWidth() --Returns the control's current width as an integer.
 
example:
    - width = self.button.getWidth()
getX(...)
getY(...)
setAnimations(...)
setAnimations([(event, attr,)*])--Set's the control's animations.
 
[(event,attr,)*] : list - A list of tuples consisting of event and attributes pairs.
    - event : string - The event to animate.
    - attr : string - The whole attribute string separated by spaces.
 
 
Animating your skin -http://wiki.xbmc.org/?title=Animating_Your_Skin 
 
example:
    - self.button.setAnimations([('focus', 'effect=zoom end=90,247,220,56 time=0',)])
setEnableCondition(...)
setEnableCondition(enable)--Set's the control's enabled condition. Allows XBMC to control the enabled status of the control.
 
enable : string - Enable condition.
 
List of Conditions -http://wiki.xbmc.org/index.php?title=List_of_Boolean_Conditions 
 
example:
    - self.button.setEnableCondition('System.InternetState')
setEnabled(...)
setEnabled(enabled)--Set's the control's enabled/disabled state.
 
enabled : bool - True=enabled / False=disabled.
 
example:
    - self.button.setEnabled(False)n
setHeight(...)
setHeight(height)--Set's the controls height.
 
height : integer - height of control.
 
example:
    - self.image.setHeight(100)
setNavigation(...)
setNavigation(up, down, left, right)--Set's the controls navigation.
 
up : control object - control to navigate to on up.
down : control object - control to navigate to on down.
left : control object - control to navigate to on left.
right : control object - control to navigate to on right.
 
*Note, Same ascontrolUp() ,controlDown() ,controlLeft() ,controlRight() . Set to self to disable navigation for that direction.
 
Throws:
    - TypeError, if one of the supplied arguments is not a control type.
    - ReferenceError, if one of the controls is not added to a window.
 
 
example:
    - self.button.setNavigation(self.button1, self.button2, self.button3, self.button4)
setPosition(...)
setPosition(x, y)--Set's the controls position.
 
x : integer - x coordinate of control.
y : integer - y coordinate of control.
 
*Note, You may use negative integers. (e.g sliding a control into view)
 
example:
    - self.button.setPosition(100, 250)
setVisible(...)
setVisible(visible)--Set's the control's visible/hidden state.
 
visible : bool - True=visible / False=hidden.
 
example:
    - self.button.setVisible(False)
setVisibleCondition(...)
setVisibleCondition(visible[,allowHiddenFocus])--Set's the control's visible condition. Allows XBMC to control the visible status of the control.
 
visible : string - Visible condition.
allowHiddenFocus : bool - True=gains focus even if hidden.
 
List of Conditions -http://wiki.xbmc.org/index.php?title=List_of_Boolean_Conditions 
 
example:
    - self.button.setVisibleCondition('[Control.IsVisible(41) + !Control.IsVisible(12)]', True)
setWidth(...)
setWidth(width)--Set's the controls width.
 
width : integer - width of control.
 
example:
    - self.image.setWidth(100)

 
class ControlSlider(Control)
    ControlSlider class.
 
ControlSlider(x, y, width, height[, textureback, texture, texturefocus])
 
x : integer - x coordinate of control.
y : integer - y coordinate of control.
width : integer - width of control.
height : integer - height of control.
textureback : [opt] string - image filename.
texture : [opt] string - image filename.
texturefocus : [opt] string - image filename.n"
 
*Note, You can use the above as keywords for arguments and skip certain optional arguments.
Once you use a keyword, all following arguments require the keyword.
After you create the control, you need to add it to the window with addControl().
 
example:
    - self.slider = xbmcgui.ControlSlider(100, 250, 350, 40)
 
 
Method resolution order:
ControlSlider
Control
__builtin__.object

Methods defined here:
getPercent(...)
getPercent() --Returns a float of the percent of the slider.
 
example:
    - print self.slider.getPercent()
setPercent(...)
setPercent(50)--Sets the percent of the slider.
 
example:
    - self.slider.setPercent(50)

Data and other attributes defined here:
__new__ = <built-in method __new__ of type object>
T.__new__(S, ...) -> a new object with type S, a subtype of T

Methods inherited from Control:
__cmp__(...)
x.__cmp__(y) <==> cmp(x,y)
canAcceptMessages(...)
controlDown(...)
controlDown(control)--Set's the controls down navigation.
 
control : control object - control to navigate to on down.
 
*Note, You can also usesetNavigation() . Set to self to disable navigation.
 
Throws:
    - TypeError, if one of the supplied arguments is not a control type.
    - ReferenceError, if one of the controls is not added to a window.
 
 
example:
    - self.button.controlDown(self.button1)
controlLeft(...)
controlLeft(control)--Set's the controls left navigation.
 
control : control object - control to navigate to on left.
 
*Note, You can also usesetNavigation() . Set to self to disable navigation.
 
Throws:
    - TypeError, if one of the supplied arguments is not a control type.
    - ReferenceError, if one of the controls is not added to a window.
 
 
example:
    - self.button.controlLeft(self.button1)
controlRight(...)
controlRight(control)--Set's the controls right navigation.
 
control : control object - control to navigate to on right.
 
*Note, You can also usesetNavigation() . Set to self to disable navigation.
 
Throws:
    - TypeError, if one of the supplied arguments is not a control type.
    - ReferenceError, if one of the controls is not added to a window.
 
 
example:
    - self.button.controlRight(self.button1)
controlUp(...)
controlUp(control)--Set's the controls up navigation.
 
control : control object - control to navigate to on up.
 
*Note, You can also usesetNavigation() . Set to self to disable navigation.
 
Throws:
    - TypeError, if one of the supplied arguments is not a control type.
    - ReferenceError, if one of the controls is not added to a window.
 
 
example:
    - self.button.controlUp(self.button1)
getHeight(...)
getHeight() --Returns the control's current height as an integer.
 
example:
    - height = self.button.getHeight()
getId(...)
getId() --Returns the control's current id as an integer.
 
example:
    - id = self.button.getId()
getPosition(...)
getPosition() --Returns the control's current position as a x,y integer tuple.
 
example:
    - pos = self.button.getPosition()
getWidth(...)
getWidth() --Returns the control's current width as an integer.
 
example:
    - width = self.button.getWidth()
getX(...)
getY(...)
setAnimations(...)
setAnimations([(event, attr,)*])--Set's the control's animations.
 
[(event,attr,)*] : list - A list of tuples consisting of event and attributes pairs.
    - event : string - The event to animate.
    - attr : string - The whole attribute string separated by spaces.
 
 
Animating your skin -http://wiki.xbmc.org/?title=Animating_Your_Skin 
 
example:
    - self.button.setAnimations([('focus', 'effect=zoom end=90,247,220,56 time=0',)])
setEnableCondition(...)
setEnableCondition(enable)--Set's the control's enabled condition. Allows XBMC to control the enabled status of the control.
 
enable : string - Enable condition.
 
List of Conditions -http://wiki.xbmc.org/index.php?title=List_of_Boolean_Conditions 
 
example:
    - self.button.setEnableCondition('System.InternetState')
setEnabled(...)
setEnabled(enabled)--Set's the control's enabled/disabled state.
 
enabled : bool - True=enabled / False=disabled.
 
example:
    - self.button.setEnabled(False)n
setHeight(...)
setHeight(height)--Set's the controls height.
 
height : integer - height of control.
 
example:
    - self.image.setHeight(100)
setNavigation(...)
setNavigation(up, down, left, right)--Set's the controls navigation.
 
up : control object - control to navigate to on up.
down : control object - control to navigate to on down.
left : control object - control to navigate to on left.
right : control object - control to navigate to on right.
 
*Note, Same ascontrolUp() ,controlDown() ,controlLeft() ,controlRight() . Set to self to disable navigation for that direction.
 
Throws:
    - TypeError, if one of the supplied arguments is not a control type.
    - ReferenceError, if one of the controls is not added to a window.
 
 
example:
    - self.button.setNavigation(self.button1, self.button2, self.button3, self.button4)
setPosition(...)
setPosition(x, y)--Set's the controls position.
 
x : integer - x coordinate of control.
y : integer - y coordinate of control.
 
*Note, You may use negative integers. (e.g sliding a control into view)
 
example:
    - self.button.setPosition(100, 250)
setVisible(...)
setVisible(visible)--Set's the control's visible/hidden state.
 
visible : bool - True=visible / False=hidden.
 
example:
    - self.button.setVisible(False)
setVisibleCondition(...)
setVisibleCondition(visible[,allowHiddenFocus])--Set's the control's visible condition. Allows XBMC to control the visible status of the control.
 
visible : string - Visible condition.
allowHiddenFocus : bool - True=gains focus even if hidden.
 
List of Conditions -http://wiki.xbmc.org/index.php?title=List_of_Boolean_Conditions 
 
example:
    - self.button.setVisibleCondition('[Control.IsVisible(41) + !Control.IsVisible(12)]', True)
setWidth(...)
setWidth(width)--Set's the controls width.
 
width : integer - width of control.
 
example:
    - self.image.setWidth(100)

 
class ControlSpin(Control)
    ControlSpin class.
 
 
    - Not working yet -.
 
 
you can't create this object, it is returned by objects likeControlTextBox andControlList .
 
 
Method resolution order:
ControlSpin
Control
__builtin__.object

Methods defined here:
setTextures(...)
setTextures(up, down, upFocus, downFocus)--Set's textures for this control.
 
texture are image files that are used for example in the skin

Methods inherited from Control:
__cmp__(...)
x.__cmp__(y) <==> cmp(x,y)
canAcceptMessages(...)
controlDown(...)
controlDown(control)--Set's the controls down navigation.
 
control : control object - control to navigate to on down.
 
*Note, You can also usesetNavigation() . Set to self to disable navigation.
 
Throws:
    - TypeError, if one of the supplied arguments is not a control type.
    - ReferenceError, if one of the controls is not added to a window.
 
 
example:
    - self.button.controlDown(self.button1)
controlLeft(...)
controlLeft(control)--Set's the controls left navigation.
 
control : control object - control to navigate to on left.
 
*Note, You can also usesetNavigation() . Set to self to disable navigation.
 
Throws:
    - TypeError, if one of the supplied arguments is not a control type.
    - ReferenceError, if one of the controls is not added to a window.
 
 
example:
    - self.button.controlLeft(self.button1)
controlRight(...)
controlRight(control)--Set's the controls right navigation.
 
control : control object - control to navigate to on right.
 
*Note, You can also usesetNavigation() . Set to self to disable navigation.
 
Throws:
    - TypeError, if one of the supplied arguments is not a control type.
    - ReferenceError, if one of the controls is not added to a window.
 
 
example:
    - self.button.controlRight(self.button1)
controlUp(...)
controlUp(control)--Set's the controls up navigation.
 
control : control object - control to navigate to on up.
 
*Note, You can also usesetNavigation() . Set to self to disable navigation.
 
Throws:
    - TypeError, if one of the supplied arguments is not a control type.
    - ReferenceError, if one of the controls is not added to a window.
 
 
example:
    - self.button.controlUp(self.button1)
getHeight(...)
getHeight() --Returns the control's current height as an integer.
 
example:
    - height = self.button.getHeight()
getId(...)
getId() --Returns the control's current id as an integer.
 
example:
    - id = self.button.getId()
getPosition(...)
getPosition() --Returns the control's current position as a x,y integer tuple.
 
example:
    - pos = self.button.getPosition()
getWidth(...)
getWidth() --Returns the control's current width as an integer.
 
example:
    - width = self.button.getWidth()
getX(...)
getY(...)
setAnimations(...)
setAnimations([(event, attr,)*])--Set's the control's animations.
 
[(event,attr,)*] : list - A list of tuples consisting of event and attributes pairs.
    - event : string - The event to animate.
    - attr : string - The whole attribute string separated by spaces.
 
 
Animating your skin -http://wiki.xbmc.org/?title=Animating_Your_Skin 
 
example:
    - self.button.setAnimations([('focus', 'effect=zoom end=90,247,220,56 time=0',)])
setEnableCondition(...)
setEnableCondition(enable)--Set's the control's enabled condition. Allows XBMC to control the enabled status of the control.
 
enable : string - Enable condition.
 
List of Conditions -http://wiki.xbmc.org/index.php?title=List_of_Boolean_Conditions 
 
example:
    - self.button.setEnableCondition('System.InternetState')
setEnabled(...)
setEnabled(enabled)--Set's the control's enabled/disabled state.
 
enabled : bool - True=enabled / False=disabled.
 
example:
    - self.button.setEnabled(False)n
setHeight(...)
setHeight(height)--Set's the controls height.
 
height : integer - height of control.
 
example:
    - self.image.setHeight(100)
setNavigation(...)
setNavigation(up, down, left, right)--Set's the controls navigation.
 
up : control object - control to navigate to on up.
down : control object - control to navigate to on down.
left : control object - control to navigate to on left.
right : control object - control to navigate to on right.
 
*Note, Same ascontrolUp() ,controlDown() ,controlLeft() ,controlRight() . Set to self to disable navigation for that direction.
 
Throws:
    - TypeError, if one of the supplied arguments is not a control type.
    - ReferenceError, if one of the controls is not added to a window.
 
 
example:
    - self.button.setNavigation(self.button1, self.button2, self.button3, self.button4)
setPosition(...)
setPosition(x, y)--Set's the controls position.
 
x : integer - x coordinate of control.
y : integer - y coordinate of control.
 
*Note, You may use negative integers. (e.g sliding a control into view)
 
example:
    - self.button.setPosition(100, 250)
setVisible(...)
setVisible(visible)--Set's the control's visible/hidden state.
 
visible : bool - True=visible / False=hidden.
 
example:
    - self.button.setVisible(False)
setVisibleCondition(...)
setVisibleCondition(visible[,allowHiddenFocus])--Set's the control's visible condition. Allows XBMC to control the visible status of the control.
 
visible : string - Visible condition.
allowHiddenFocus : bool - True=gains focus even if hidden.
 
List of Conditions -http://wiki.xbmc.org/index.php?title=List_of_Boolean_Conditions 
 
example:
    - self.button.setVisibleCondition('[Control.IsVisible(41) + !Control.IsVisible(12)]', True)
setWidth(...)
setWidth(width)--Set's the controls width.
 
width : integer - width of control.
 
example:
    - self.image.setWidth(100)

 
class ControlTextBox(Control)
    ControlTextBox class.
 
ControlTextBox(x, y, width, height[, font, textColor])
 
x : integer - x coordinate of control.
y : integer - y coordinate of control.
width : integer - width of control.
height : integer - height of control.
font : [opt] string - font used for text. (e.g. 'font13')
textColor : [opt] hexstring - color of textbox's text. (e.g. '0xFFFFFFFF')
 
*Note, You can use the above as keywords for arguments and skip certain optional arguments.
Once you use a keyword, all following arguments require the keyword.
After you create the control, you need to add it to the window with addControl().
 
example:
    - self.textbox =xbmcgui.ControlTextBox (100, 250, 300, 300, textColor='0xFFFFFFFF')
 
 
Method resolution order:
ControlTextBox
Control
__builtin__.object

Methods defined here:
reset(...)
reset() --Clear's this textbox.
 
example:
    - self.textbox.reset()
scroll(...)
scroll(position)--Scrolls to the given position.
 
id : integer - position to scroll to.
 
example:
    - self.textbox.scroll(10)
setText(...)
setText(text)--Set's the text for this textbox.
 
text : string or unicode - text string.
 
example:
    - self.textbox.setText('This is a line of text that can wrap.')

Data and other attributes defined here:
__new__ = <built-in method __new__ of type object>
T.__new__(S, ...) -> a new object with type S, a subtype of T

Methods inherited from Control:
__cmp__(...)
x.__cmp__(y) <==> cmp(x,y)
canAcceptMessages(...)
controlDown(...)
controlDown(control)--Set's the controls down navigation.
 
control : control object - control to navigate to on down.
 
*Note, You can also usesetNavigation() . Set to self to disable navigation.
 
Throws:
    - TypeError, if one of the supplied arguments is not a control type.
    - ReferenceError, if one of the controls is not added to a window.
 
 
example:
    - self.button.controlDown(self.button1)
controlLeft(...)
controlLeft(control)--Set's the controls left navigation.
 
control : control object - control to navigate to on left.
 
*Note, You can also usesetNavigation() . Set to self to disable navigation.
 
Throws:
    - TypeError, if one of the supplied arguments is not a control type.
    - ReferenceError, if one of the controls is not added to a window.
 
 
example:
    - self.button.controlLeft(self.button1)
controlRight(...)
controlRight(control)--Set's the controls right navigation.
 
control : control object - control to navigate to on right.
 
*Note, You can also usesetNavigation() . Set to self to disable navigation.
 
Throws:
    - TypeError, if one of the supplied arguments is not a control type.
    - ReferenceError, if one of the controls is not added to a window.
 
 
example:
    - self.button.controlRight(self.button1)
controlUp(...)
controlUp(control)--Set's the controls up navigation.
 
control : control object - control to navigate to on up.
 
*Note, You can also usesetNavigation() . Set to self to disable navigation.
 
Throws:
    - TypeError, if one of the supplied arguments is not a control type.
    - ReferenceError, if one of the controls is not added to a window.
 
 
example:
    - self.button.controlUp(self.button1)
getHeight(...)
getHeight() --Returns the control's current height as an integer.
 
example:
    - height = self.button.getHeight()
getId(...)
getId() --Returns the control's current id as an integer.
 
example:
    - id = self.button.getId()
getPosition(...)
getPosition() --Returns the control's current position as a x,y integer tuple.
 
example:
    - pos = self.button.getPosition()
getWidth(...)
getWidth() --Returns the control's current width as an integer.
 
example:
    - width = self.button.getWidth()
getX(...)
getY(...)
setAnimations(...)
setAnimations([(event, attr,)*])--Set's the control's animations.
 
[(event,attr,)*] : list - A list of tuples consisting of event and attributes pairs.
    - event : string - The event to animate.
    - attr : string - The whole attribute string separated by spaces.
 
 
Animating your skin -http://wiki.xbmc.org/?title=Animating_Your_Skin 
 
example:
    - self.button.setAnimations([('focus', 'effect=zoom end=90,247,220,56 time=0',)])
setEnableCondition(...)
setEnableCondition(enable)--Set's the control's enabled condition. Allows XBMC to control the enabled status of the control.
 
enable : string - Enable condition.
 
List of Conditions -http://wiki.xbmc.org/index.php?title=List_of_Boolean_Conditions 
 
example:
    - self.button.setEnableCondition('System.InternetState')
setEnabled(...)
setEnabled(enabled)--Set's the control's enabled/disabled state.
 
enabled : bool - True=enabled / False=disabled.
 
example:
    - self.button.setEnabled(False)n
setHeight(...)
setHeight(height)--Set's the controls height.
 
height : integer - height of control.
 
example:
    - self.image.setHeight(100)
setNavigation(...)
setNavigation(up, down, left, right)--Set's the controls navigation.
 
up : control object - control to navigate to on up.
down : control object - control to navigate to on down.
left : control object - control to navigate to on left.
right : control object - control to navigate to on right.
 
*Note, Same ascontrolUp() ,controlDown() ,controlLeft() ,controlRight() . Set to self to disable navigation for that direction.
 
Throws:
    - TypeError, if one of the supplied arguments is not a control type.
    - ReferenceError, if one of the controls is not added to a window.
 
 
example:
    - self.button.setNavigation(self.button1, self.button2, self.button3, self.button4)
setPosition(...)
setPosition(x, y)--Set's the controls position.
 
x : integer - x coordinate of control.
y : integer - y coordinate of control.
 
*Note, You may use negative integers. (e.g sliding a control into view)
 
example:
    - self.button.setPosition(100, 250)
setVisible(...)
setVisible(visible)--Set's the control's visible/hidden state.
 
visible : bool - True=visible / False=hidden.
 
example:
    - self.button.setVisible(False)
setVisibleCondition(...)
setVisibleCondition(visible[,allowHiddenFocus])--Set's the control's visible condition. Allows XBMC to control the visible status of the control.
 
visible : string - Visible condition.
allowHiddenFocus : bool - True=gains focus even if hidden.
 
List of Conditions -http://wiki.xbmc.org/index.php?title=List_of_Boolean_Conditions 
 
example:
    - self.button.setVisibleCondition('[Control.IsVisible(41) + !Control.IsVisible(12)]', True)
setWidth(...)
setWidth(width)--Set's the controls width.
 
width : integer - width of control.
 
example:
    - self.image.setWidth(100)

 
class Dialog(__builtin__.object)
    Dialog class (Duh!)
 
  Methods defined here:
browse(...)
browse(type, heading, shares[, mask, useThumbs, treatAsFolder, default, enableMultiple])--Show a 'Browse' dialog.
 
type : integer - the type of browse dialog.
heading : string or unicode - dialog heading.
shares : string or unicode - from sources.xml. (i.e. 'myprograms')
mask : [opt] string or unicode - '|' separated file mask. (i.e. '.jpg|.png')
useThumbs : [opt] boolean - if True autoswitch to Thumb view if files exist.
treatAsFolder : [opt] boolean - if True playlists and archives act as folders.
default : [opt] string - default path or file.
 
 
enableMultiple : [opt] boolean - if True multiple file selection is enabled.
 
Types:
    - 0 : ShowAndGetDirectory
    - 1 : ShowAndGetFile
    - 2 : ShowAndGetImage
    - 3 : ShowAndGetWriteableDirectory
 
 
*Note, If enableMultiple is False (default): returns filename and/or path as a string
to the location of the highlighted item, if user pressed 'Ok' or a masked item
was selected. Returns the default value if dialog was canceled.
If enableMultiple is True: returns tuple of marked filenames as a strin
if user pressed 'Ok' or a masked item was selected. Returns empty tuple if dialog was canceled.
 
If type is 0 or 3 the enableMultiple parameter is ignore
 
example:
 
    - dialog = xbmcgui.Dialog()
 
    - fn = dialog.browse(3, 'XBMC', 'files', '', False, False, False, 'special://masterprofile/script_data/XBMC Lyrics')
browseMultiple(...)
browse(type, heading, shares[, mask, useThumbs, treatAsFolder, default])--Show a 'Browse' dialog.
 
type : integer - the type of browse dialog.
heading : string or unicode - dialog heading.
shares : string or unicode - from sources.xml. (i.e. 'myprograms')
mask : [opt] string or unicode - '|' separated file mask. (i.e. '.jpg|.png')
useThumbs : [opt] boolean - if True autoswitch to Thumb view if files exist (default=false).
treatAsFolder : [opt] boolean - if True playlists and archives act as folders (default=false).
default : [opt] string - default path or file.
 
Types:
    - 1 : ShowAndGetFile
    - 2 : ShowAndGetImage
 
 
*Note,
returns tuple of marked filenames as a string,"
if user pressed 'Ok' or a masked item was selected. Returns empty tuple if dialog was canceled.
 
example:
 
    - dialog = xbmcgui.Dialog()
    - fn = dialog.browseMultiple(2, 'XBMC', 'files', '', False, False, 'special://masterprofile/script_data/XBMC Lyrics')
browseSingle(...)
browse(type, heading, shares[, mask, useThumbs, treatAsFolder, default])--Show a 'Browse' dialog.
 
type : integer - the type of browse dialog.
heading : string or unicode - dialog heading.
shares : string or unicode - from sources.xml. (i.e. 'myprograms')
mask : [opt] string or unicode - '|' separated file mask. (i.e. '.jpg|.png')
useThumbs : [opt] boolean - if True autoswitch to Thumb view if files exist (default=false).
treatAsFolder : [opt] boolean - if True playlists and archives act as folders (default=false).
default : [opt] string - default path or file.
 
Types:
 
    - 0 : ShowAndGetDirectory
    - 1 : ShowAndGetFile
    - 2 : ShowAndGetImage
    - 3 : ShowAndGetWriteableDirectory
*Note, Returns filename and/or path as a string to the location of the highlighted item,
if user pressed 'Ok' or a masked item was selected.
Returns the default value if dialog was canceled.
 
example:
 
    - dialog = xbmcgui.Dialog()
    - fn = dialog.browse(3, 'XBMC', 'files', '', False, False, 'special://masterprofile/script_data/XBMC Lyrics')
input(...)
input(heading[, default, type, option, autoclose])--Show an Input dialog.
 
heading : string - dialog heading.
default : [opt] string - default value. (default=empty string)
type : [opt] integer - the type of keyboard dialog. (default=xbmcgui.INPUT_ALPHANUM)
option : [opt] integer - option for the dialog. (see Options below)
autoclose : [opt] integer - milliseconds to autoclose dialog. (default=do not autoclose)
 
Types:
    - xbmcgui.INPUT_ALPHANUM (standard keyboard)
    - xbmcgui.INPUT_NUMERIC (format: #)
    - xbmcgui.INPUT_DATE (format: DD/MM/YYYY)
    - xbmcgui.INPUT_TIME (format: HH:MM)
    - xbmcgui.INPUT_IPADDRESS (format: #.#.#.#)
    - xbmcgui.INPUT_PASSWORD (return md5 hash of input, input is masked)
 
 
Options PasswordDialog :
 
    - xbmcgui.PASSWORD_VERIFY (verifies an existing (default) md5 hashed password)
Options AlphanumDialog :
 
    - xbmcgui.ALPHANUM_HIDE_INPUT (masks input)
*Note, Returns the entered data as a string.
Returns an empty string if dialog was canceled.
 
example:
    - dialog = xbmcgui.Dialog()
    - d = dialog.input('Enter secret code', type=xbmcgui.INPUT_ALPHANUM, option=xbmcgui.ALPHANUM_HIDE_INPUT)n
notification(...)
notification(heading, message[, icon, time, sound])--Show a Notification alert.
 
heading : string - dialog heading.
message : string - dialog message.
icon : [opt] string - icon to use. (default xbmcgui.NOTIFICATION_INFO)
time : [opt] integer - time in milliseconds (default 5000)
sound : [opt] bool - play notification sound (default True)
 
Builtin Icons:
 
    - xbmcgui.NOTIFICATION_INFO
    - xbmcgui.NOTIFICATION_WARNING
    - xbmcgui.NOTIFICATION_ERROR
example:
    - dialog = xbmcgui.Dialog()
    - dialog.notification('Movie Trailers', 'Finding Nemo download finished.', xbmcgui.NOTIFICATION_INFO, 5000)
numeric(...)
numeric(type, heading[, default])--Show a 'Numeric' dialog.
 
type : integer - the type of numeric dialog.
heading : string or unicode - dialog heading.
default : [opt] string - default value.
 
Types:
    - 0 : ShowAndGetNumber (default format: #)
    - 1 : ShowAndGetDate (default format: DD/MM/YYYY)
    - 2 : ShowAndGetTime (default format: HH:MM)
    - 3 : ShowAndGetIPAddress (default format: #.#.#.#)
 
 
*Note, Returns the entered data as a string.
Returns the default value if dialog was canceled.
 
example:
 
    - dialog = xbmcgui.Dialog()
    - d = dialog.numeric(1, 'Enter date of birth')
ok(...)
ok(heading, line1[, line2, line3])--Show a dialog 'OK'.
 
heading : string or unicode - dialog heading.
line1 : string or unicode - line #1 text.
line2 : [opt] string or unicode - line #2 text.
line3 : [opt] string or unicode - line #3 text.
 
*Note, Returns True if 'Ok' was pressed, else False.
*Note: Optionally line1 can be sent as multi-line text. In this case line2 and line3 must be omitted.
 
example:
 
    - dialog = xbmcgui.Dialog()
 
    - ok = dialog.ok('XBMC', 'There was an error.')n
select(...)
select(heading, list)--Show a select dialog.
 
heading : string or unicode - dialog heading.
list : string list - list of items.
autoclose : [opt] integer - milliseconds to autoclose dialog. (default=do not autoclose)
 
*Note, Returns the position of the highlighted item as an integer.
 
example:
 
    - dialog = xbmcgui.Dialog()
 
    - ret = dialog.select('Choose a playlist', ['Playlist #1', 'Playlist #2, 'Playlist #3'])n
yesno(...)
yesno(heading, line1[, line2, line3])--Show a dialog 'YES/NO'.
 
heading : string or unicode - dialog heading.
line1 : string or unicode - line #1 text.
line2 : [opt] string or unicode - line #2 text.
line3 : [opt] string or unicode - line #3 text.
nolabel : [opt] label to put on the no button.
yeslabel : [opt] label to put on the yes button.
autoclose : [opt] integer - milliseconds to autoclose dialog. (default=do not autoclose)
 
*Note, Returns True if 'Yes' was pressed, else False.
*Note, Optionally line1 can be sent as multi-line text. In this case line2 and line3 must be omitted.
 
example:
 
    - dialog = xbmcgui.Dialog()
 
    - ret = dialog.yesno('XBMC', 'Do you want to exit this script?')n

Data and other attributes defined here:
__new__ = <built-in method __new__ of type object>
T.__new__(S, ...) -> a new object with type S, a subtype of T

 
class DialogProgress(__builtin__.object)
    DialogProgress class (Duh!)
 
  Methods defined here:
close(...)
close() --Close the progress dialog.
 
example:
    - pDialog.close()
create(...)
create(heading[, line1, line2, line3])--Create and show a progress dialog.
 
heading : string or unicode - dialog heading.
line1 : [opt] string or unicode - line #1 text.
line2 : [opt] string or unicode - line #2 text.
line3 : [opt] string or unicode - line #3 text.
 
*Note, Optionally line1 can be sent as multi-line text. In this case line2 and line3 must be omitted.
*Note, Useupdate() to update lines and progressbar.
 
example:
    - pDialog = xbmcgui.DialogProgress()
    - pDialog.create('XBMC', 'Initializing script...')
iscanceled(...)
iscanceled() --Returns True if the user pressed cancel.
 
example:
    - if (pDialog.iscanceled()): return
update(...)
update(percent[, line1, line2, line3])--Updates the progress dialog.
 
percent : integer - percent complete. (0:100)
line1 : [opt] string or unicode - line #1 text.
line2 : [opt] string or unicode - line #2 text.
line3 : [opt] string or unicode - line #3 text.
 
*Note, Optionally line1 can be sent as multi-line text. In this case line2 and line3 must be omitted.
*Note, If percent == 0, the progressbar will be hidden.
 
example:
    - pDialog.update(25, 'Importing modules...')

Data and other attributes defined here:
__new__ = <built-in method __new__ of type object>
T.__new__(S, ...) -> a new object with type S, a subtype of T

 
class DialogProgressBG(__builtin__.object)
    DialogProgressBG class
 
  Methods defined here:
close(...)
close() --Close the background progress dialog
 
example:
    - pDialog.close()
create(...)
create(heading[, message])--Create and show a background progress dialog.
 
 
heading : string or unicode - dialog heading.
message : [opt] string or unicode - message text.
 
 
*Note, 'heading' is used for the dialog's id. Use a unique heading.
Useupdate() to update heading, message and progressbar.
 
 
example:
    - pDialog = xbmcgui.DialogProgressBG()
    - pDialog.create('Movie Trailers', 'Downloading Monsters Inc. ...')
isFinished(...)
isFinished() --Returns True if the background dialog is active.
 
example:
    - if (pDialog.isFinished()): return
update(...)
update([percent, heading, message])--Updates the background progress dialog.
 
percent : [opt] integer - percent complete. (0:100)
heading : [opt] string or unicode - dialog heading.
message : [opt] string or unicode - message text.
 
 
*Note, To clear heading or message, you must pass a blank character.
 
 
example:
    - pDialog.update(25, message='Downloading Finding Nemo ...')

Data and other attributes defined here:
__new__ = <built-in method __new__ of type object>
T.__new__(S, ...) -> a new object with type S, a subtype of T

 
class ListItem(__builtin__.object)
     Methods defined here:
addContextMenuItems(...)
addContextMenuItems([(label, action,)*], replaceItems)--Adds item(s) to the context menu for media lists.
 
items : list - [(label, action,)*] A list of tuples consisting of label and action pairs.
    - label : string or unicode - item's label.
    - action : string or unicode - any built-in function to perform. replaceItems : [opt] bool - True=only your items will show/False=your items will be added to context menu(Default).
List of functions -http://wiki.xbmc.org/?title=List_of_Built_In_Functions 
 
*Note, You can use the above as keywords for arguments and skip certain optional arguments.
Once you use a keyword, all following arguments require the keyword.
 
example:
    - listitem.addContextMenuItems([('Theater Showtimes', 'XBMC.RunScript(special://home/scripts/showtimes/default.py,Iron Man)',)])n
addStreamInfo(...)
addStreamInfo(type, values)--Add a stream with details.
 
type : string - type of stream(video/audio/subtitle).
values : dictionary - pairs of { label: value }.
 
 
 
    - Video Values:
        - codec : string (h264)
        - aspect : float (1.78)
        - width : integer (1280)
        - height : integer (720)
        - duration : integer (seconds)
 
    - Audio Values:
        - codec : string (dts)
        - language : string (en)
        - channels : integer (2)
 
    - Subtitle Values:
        - language : string (en)
 
 
 
example:
        - self.list.getSelectedItem().addStreamInfo('video', { 'Codec': 'h264', 'Width' : 1280 })
getLabel(...)
getLabel() --Returns the listitem label.
 
example:
    - label = self.list.getSelectedItem().getLabel()
getLabel2(...)
getLabel2() --Returns the listitem label.
 
example:
    - label = self.list.getSelectedItem().getLabel2()
getProperty(...)
getProperty(key)--Returns a listitem property as a string, similar to an infolabel.
 
key : string - property name.
 
*Note, Key is NOT case sensitive.
You can use the above as keywords for arguments and skip certain optional arguments.
Once you use a keyword, all following arguments require the keyword.
 
 
example:
    - AspectRatio = self.list.getSelectedItem().getProperty('AspectRatio')
getdescription(...)
getdescription() --Returns the description of this PlayListItem.
getduration(...)
getduration() --Returns the duration of this PlayListItem
getfilename(...)
getfilename() --Returns the filename of this PlayListItem.
isSelected(...)
isSelected() --Returns the listitem's selected status.
 
example:
    - is = self.list.getSelectedItem().isSelected()
select(...)
select(selected)--Sets the listitem's selected status.
 
selected : bool - True=selected/False=not selected
 
example:
    - self.list.getSelectedItem().select(True)
setArt(...)
setArt(values)--Sets the listitem's art
values : dictionary - pairs of { label: value }.
 
 
 
    - Some default art values (any string possible):
        - thumb : string - image filename
        - poster : string - image filename
        - banner : string - image filename
        - fanart : string - image filename
        - clearart : string - image filename
        - clearlogo : string - image filename
        - landscape : string - image filename
 
 
 
example:
        - self.list.getSelectedItem().setArt({ 'poster': 'poster.png', 'banner' : 'banner.png' })
setIconImage(...)
setIconImage(icon)--Sets the listitem's icon image.
 
icon : string - image filename.
 
example:
    - self.list.getSelectedItem().setIconImage('emailread.png')
setInfo(...)
setInfo(type, infoLabels)--Sets the listitem's infoLabels.
 
type : string - type of media(video/music/pictures).
infoLabels : dictionary - pairs of { label: value }.
 
*Note, To set pictures exif info, prepend 'exif:' to the label. Exif values must be passed
as strings, separate value pairs with a comma. (eg. {'exif:resolution': '720,480'}
See CPictureInfoTag::TranslateString in PictureInfoTag.cpp for valid strings.
 
You can use the above as keywords for arguments and skip certain optional arguments.
Once you use a keyword, all following arguments require the keyword.
 
 
    - General Values that apply to all types:
        - count : integer (12) - can be used to store an id for later, or for sorting purposes
        - size : long (1024) - size in bytes
        - date : string (d.m.Y / 01.01.2009) - file date
 
    - Video Values:
        - genre : string (Comedy)
        - year : integer (2009)
        - episode : integer (4)
        - season : integer (1)
        - top250 : integer (192)
        - tracknumber : integer (3)
        - rating : float (6.4) - range is 0..10
        - watched : depreciated - use playcount instead
        - playcount : integer (2) - number of times this item has been played
        - overlay : integer (2) - range is 0..8. See GUIListItem.h for values
        - cast : list (Michal C. Hall)
        - castandrole : list (Michael C. Hall|Dexter)
        - director : string (Dagur Kari)
        - mpaa : string (PG-13)
        - plot : string (Long Description)
        - plotoutline : string (Short Description)
        - title : string (Big Fan)
        - originaltitle : string (Big Fan)
        - sorttitle : string (Big Fan)
        - duration : string (3:18)
        - studio : string (Warner Bros.)
        - tagline : string (An awesome movie) - short description of movie
        - writer : string (Robert D. Siegel)
        - tvshowtitle : string (Heroes)
        - premiered : string (2005-03-04)
        - status : string (Continuing) - status of a TVshow
        - code : string (tt0110293) - IMDb code
        - aired : string (2008-12-07)
        - credits : string (Andy Kaufman) - writing credits
        - lastplayed : string (Y-m-d h:m:s = 2009-04-05 23:16:04)
        - album : string (The Joshua Tree)
        - artist : list (['U2'])
        - votes : string (12345 votes)
        - trailer : string (/home/user/trailer.avi)
        - dateadded : string (Y-m-d h:m:s = 2009-04-05 23:16:04)
 
    - Music Values:
        - tracknumber : integer (8)
        - duration : integer (245) - duration in seconds
        - year : integer (1998)
        - genre : string (Rock)
        - album : string (Pulse)
        - artist : string (Muse)
        - title : string (American Pie)
        - rating : string (3) - single character between 0 and 5
        - lyrics : string (On a dark desert highway...)
        - playcount : integer (2) - number of times this item has been played
        - lastplayed : string (Y-m-d h:m:s = 2009-04-05 23:16:04)
 
    - Picture Values:
        - title : string (In the last summer-1)
        - picturepath : string (/home/username/pictures/img001.jpg)
        - exif : string (See CPictureInfoTag::TranslateString in PictureInfoTag.cpp for valid strings)
 
 
 
*example:
 
        - self.list.getSelectedItem().setInfo('video', { 'Genre': 'Comedy' })n
setLabel(...)
setLabel(label)--Sets the listitem's label.
 
label : string or unicode - text string.
 
example:
    - self.list.getSelectedItem().setLabel('Casino Royale')
setLabel2(...)
setLabel2(label)--Sets the listitem's label2.
 
label : string or unicode - text string.
 
example:
    - self.list.getSelectedItem().setLabel2('Casino Royale')
setMimeType(...)
setMimeType(mimetype)--Sets the listitem's mimetype if known.
 
mimetype : string or unicode - mimetype.
 
*If known prehand, this can avoid xbmc doing HEAD requests to http servers to figure out file type.
setPath(...)
addContextMenuItems([(label, action,)*], replaceItems)--Adds item(s) to the context menu for media lists.
 
items : list - [(label, action,)*] A list of tuples consisting of label and action pairs.
    - label : string or unicode - item's label.
    - action : string or unicode - any built-in function to perform. replaceItems : [opt] bool - True=only your items will show/False=your items will be added to context menu(Default).
List of functions -http://wiki.xbmc.org/?title=List_of_Built_In_Functions 
 
*Note, You can use the above as keywords for arguments and skip certain optional arguments.
Once you use a keyword, all following arguments require the keyword.
 
example:
    - listitem.addContextMenuItems([('Theater Showtimes', 'XBMC.RunScript(special://home/scripts/showtimes/default.py,Iron Man)',)]) setPath(path)--Sets the listitem's path.
 
path : string or unicode - path, activated when item is clicked.
 
*Note, You can use the above as keywords for arguments.
 
 
 
example:
    - self.list.getSelectedItem().setPath(path='ActivateWindow(Weather)')
setProperty(...)
setProperty(key, value)--Sets a listitem property, similar to an infolabel.
 
key : string - property name.
value : string or unicode - value of property.
 
*Note, Key is NOT case sensitive.
You can use the above as keywords for arguments and skip certain optional arguments.
Once you use a keyword, all following arguments require the keyword.
 
Some of these are treated internally by XBMC, such as the 'StartOffset' property, which is
the offset in seconds at which to start playback of an item. Others may be used in the skin
to add extra information, such as 'WatchedCount' for tvshow items
 
 
example:
    - self.list.getSelectedItem().setProperty('AspectRatio', '1.85 : 1')
    - self.list.getSelectedItem().setProperty('StartOffset', '256.4')
setThumbnailImage(...)
setThumbnailImage(thumbFilename)--Sets the listitem's thumbnail image.
 
thumb : string - image filename.
 
example:
    - self.list.getSelectedItem().setThumbnailImage('emailread.png')

Data and other attributes defined here:
__new__ = <built-in method __new__ of type object>
T.__new__(S, ...) -> a new object with type S, a subtype of T

 
class Window(__builtin__.object)
    Window class.
 
Window(self[, int windowId):
    - Create a newWindow to draw on.
    - Specify an id to use an existing window.
 
 
Throws:
    - ValueError, if supplied window Id does not exist.
    - Exception, if more then 200 windows are created.
 
 
Deleting this window will activate the old window that was active
and resets (not delete) all controls that are associated with this window.
 
  Methods defined here:
addControl(...)
addControl(self, Control)--Add aControl to this window.
 
Throws:
    - TypeError, if supplied argument is not aControl type
    - ReferenceError, if control is already used in another window
    - RuntimeError, should not happen :-)
 
 
The next controls can be added to a window atm
 
-ControlLabel -ControlFadeLabel -ControlTextBox -ControlButton -ControlCheckMark -ControlList -ControlGroup -ControlImage -ControlRadioButton -ControlProgressn
addControls(...)
addControls(self, List)--Add a list of Controls to this window.
 
*Throws:
    - TypeError, if supplied argument is not ofList type, or a control is not ofControl type
    - ReferenceError, if control is already used in another window
    - RuntimeError, should not happen :-)
clearProperties(...)
clearProperties() --Clears all window properties.
 
example:
    - win =xbmcgui.Window (xbmcgui.getCurrentWindowId())
    - win.clearProperties()n
clearProperty(...)
clearProperty(key)--Clears the specific window property.
 
key : string - property name.
 
*Note, key is NOT case sensitive. Equivalent to setProperty(key,'') You can use the above as keywords for arguments and skip certain optional arguments. Once you use a keyword, all following arguments require the keyword.
 
example:
    - win =xbmcgui.Window (xbmcgui.getCurrentWindowId())
    - win.clearProperty('Category')n
close(...)
close(self)--Closes this window.
 
Closes this window by activating the old window. The window is not deleted with this method.
doModal(...)
doModal(self)--Display this window untilclose() is called.
getControl(...)
getControl(self, int controlId)--Get's the control from this window.
 
Throws: Exception, ifControl doesn't exist
 
controlId doesn't have to be a python control, it can be a control id from a xbmc window too (you can find id's in the xml files
 
Note, not python controls are not completely usable yet You can only use theControl functions
getFocus(...)
getFocus(self, Control)--returns the control which is focused.
 
Throws:
    - SystemError, on Internal error
    - RuntimeError, if no control has focus
getFocusId(...)
getFocusId(self, int)--returns the id of the control which is focused. Throws:
- SystemError, on Internal error
- RuntimeError, if no control has focus
getHeight(...)
getHeight(self)--Returns the height of this screen.
getProperty(...)
getProperty(key)--Returns a window property as a string, similar to an infolabel.
 
key : string - property name.
 
*Note, key is NOT case sensitive. You can use the above as keywords for arguments and skip certain optional arguments. Once you use a keyword, all following arguments require the keyword.
 
example:
    - win =xbmcgui.Window (xbmcgui.getCurrentWindowId())
    - category = win.getProperty('Category')
getResolution(...)
getResolution(self)--Returns the resolution of the scree The returned value is one of the following:
- 0 - 1080i (1920x1080)
- 1 - 720p (1280x720)
- 2 - 480p 4:3 (720x480)
- 3 - 480p 16:9 (720x480)
- 4 - NTSC 4:3 (720x480)
- 5 - NTSC 16:9 (720x480)
- 6 - PAL 4:3 (720x576)
- 7 - PAL 16:9 (720x576)
- 8 - PAL60 4:3 (720x480)
- 9 - PAL60 16:9 (720x480)n
getWidth(...)
getWidth(self)--Returns the width of this screen.
onAction(...)
onAction(self, Action action)--onAction method.
 
This method will recieve all actions that the main program will send to this window.
 
Notes:
    - By default, only the PREVIOUS_MENU and NAV_BACK actions are handled.
    - Overwrite this method to let your script handle all actions.
    - Don't forget to capture ACTION_PREVIOUS_MENU or ACTION_NAV_BACK, else the user can't close this window.
onClick(...)
onClick(self, int controlId)--onClick method.
 
This method will recieve all click events that the main program will send
to this window.
onControl(...)
onControl(self, Control control)--onClick method.
 
This method will recieve all click events on owned and selected controls when
the control itself doesn't handle the message.
onDoubleClick(...)
onDoubleClick(self, int controlId)--onClick method.
 
This method will recieve all double click events that the main program will send
to this window.
onFocus(...)
onFocus(self, int controlId)--onFocus method.
 
This method will recieve all focus events that the main program will send
to this window.
onInit(...)
onInit(self)--onInit method.
 
This method will be called to initialize the window
removeControl(...)
removeControl(self, Control)--Removes the control from this window.
 
Throws:
    - TypeError, if supplied argument is not aControl type
    - RuntimeError, if control is not added to this window
 
 
This will not delete the control. It is only removed from the window.
removeControls(...)
removeControls(self, List)--Removes a list of controls from this window.
 
Throws:
    - TypeError, if supplied argument is not aControl type
    - RuntimeError, if control is not added to this window
 
 
This will not delete the controls. They are only removed from the window.
setCoordinateResolution(...)
setCoordinateResolution(self, int resolution)--Sets the resolution that the coordinates of all controls are defined in. Allows XBMC to scale control positions and width/heights to whatever resolution XBMC is currently using.
 
resolution is one of the following:
    - 0 - 1080i (1920x1080)
    - 1 - 720p (1280x720)
    - 2 - 480p 4:3 (720x480)
    - 3 - 480p 16:9 (720x480)
    - 4 - NTSC 4:3 (720x480)
    - 5 - NTSC 16:9 (720x480)
    - 6 - PAL 4:3 (720x576)
    - 7 - PAL 16:9 (720x576)
    - 8 - PAL60 4:3 (720x480)
    - 9 - PAL60 16:9 (720x480)n
setFocus(...)
setFocus(self, Control)--Give the supplied control focus.
 
Throws:
    - TypeError, if supplied argument is not aControl type
    - SystemError, on Internal error
    - RuntimeError, if control is not added to a window
setFocusId(...)
setFocusId(self, int)--Gives the control with the supplied focus.
 
Throws:
    - SystemError, on Internal error
    - RuntimeError, if control is not added to a window
setProperty(...)
setProperty(key, value)--Sets a window property, similar to an infolabel.
 
key : string - property name.
value : string or unicode - value of property.
 
*Note, key is NOT case sensitive. Setting value to an empty string is equivalent to clearProperty(key) You can use the above as keywords for arguments and skip certain optional arguments. Once you use a keyword, all following arguments require the keyword.
 
example:
    - win =xbmcgui.Window (xbmcgui.getCurrentWindowId())
    - win.setProperty('Category', 'Newest')
show(...)
show(self)--Show this window.
 
Shows this window by activating it, callingclose() after it wil activate the current window again.
 
Note, if your script ends this window will be closed to. To show it forever, make a loop at the end of your script ar usedoModal() instead

Data and other attributes defined here:
__new__ = <built-in method __new__ of type object>
T.__new__(S, ...) -> a new object with type S, a subtype of T

 
class WindowDialog(Window)
    WindowDialog class
 
 
Method resolution order:
WindowDialog
Window
__builtin__.object

Data and other attributes defined here:
__new__ = <built-in method __new__ of type object>
T.__new__(S, ...) -> a new object with type S, a subtype of T

Methods inherited from Window:
addControl(...)
addControl(self, Control)--Add aControl to this window.
 
Throws:
    - TypeError, if supplied argument is not aControl type
    - ReferenceError, if control is already used in another window
    - RuntimeError, should not happen :-)
 
 
The next controls can be added to a window atm
 
-ControlLabel -ControlFadeLabel -ControlTextBox -ControlButton -ControlCheckMark -ControlList -ControlGroup -ControlImage -ControlRadioButton -ControlProgressn
addControls(...)
addControls(self, List)--Add a list of Controls to this window.
 
*Throws:
    - TypeError, if supplied argument is not ofList type, or a control is not ofControl type
    - ReferenceError, if control is already used in another window
    - RuntimeError, should not happen :-)
clearProperties(...)
clearProperties() --Clears all window properties.
 
example:
    - win =xbmcgui.Window (xbmcgui.getCurrentWindowId())
    - win.clearProperties()n
clearProperty(...)
clearProperty(key)--Clears the specific window property.
 
key : string - property name.
 
*Note, key is NOT case sensitive. Equivalent to setProperty(key,'') You can use the above as keywords for arguments and skip certain optional arguments. Once you use a keyword, all following arguments require the keyword.
 
example:
    - win =xbmcgui.Window (xbmcgui.getCurrentWindowId())
    - win.clearProperty('Category')n
close(...)
close(self)--Closes this window.
 
Closes this window by activating the old window. The window is not deleted with this method.
doModal(...)
doModal(self)--Display this window untilclose() is called.
getControl(...)
getControl(self, int controlId)--Get's the control from this window.
 
Throws: Exception, ifControl doesn't exist
 
controlId doesn't have to be a python control, it can be a control id from a xbmc window too (you can find id's in the xml files
 
Note, not python controls are not completely usable yet You can only use theControl functions
getFocus(...)
getFocus(self, Control)--returns the control which is focused.
 
Throws:
    - SystemError, on Internal error
    - RuntimeError, if no control has focus
getFocusId(...)
getFocusId(self, int)--returns the id of the control which is focused. Throws:
- SystemError, on Internal error
- RuntimeError, if no control has focus
getHeight(...)
getHeight(self)--Returns the height of this screen.
getProperty(...)
getProperty(key)--Returns a window property as a string, similar to an infolabel.
 
key : string - property name.
 
*Note, key is NOT case sensitive. You can use the above as keywords for arguments and skip certain optional arguments. Once you use a keyword, all following arguments require the keyword.
 
example:
    - win =xbmcgui.Window (xbmcgui.getCurrentWindowId())
    - category = win.getProperty('Category')
getResolution(...)
getResolution(self)--Returns the resolution of the scree The returned value is one of the following:
- 0 - 1080i (1920x1080)
- 1 - 720p (1280x720)
- 2 - 480p 4:3 (720x480)
- 3 - 480p 16:9 (720x480)
- 4 - NTSC 4:3 (720x480)
- 5 - NTSC 16:9 (720x480)
- 6 - PAL 4:3 (720x576)
- 7 - PAL 16:9 (720x576)
- 8 - PAL60 4:3 (720x480)
- 9 - PAL60 16:9 (720x480)n
getWidth(...)
getWidth(self)--Returns the width of this screen.
onAction(...)
onAction(self, Action action)--onAction method.
 
This method will recieve all actions that the main program will send to this window.
 
Notes:
    - By default, only the PREVIOUS_MENU and NAV_BACK actions are handled.
    - Overwrite this method to let your script handle all actions.
    - Don't forget to capture ACTION_PREVIOUS_MENU or ACTION_NAV_BACK, else the user can't close this window.
onClick(...)
onClick(self, int controlId)--onClick method.
 
This method will recieve all click events that the main program will send
to this window.
onControl(...)
onControl(self, Control control)--onClick method.
 
This method will recieve all click events on owned and selected controls when
the control itself doesn't handle the message.
onDoubleClick(...)
onDoubleClick(self, int controlId)--onClick method.
 
This method will recieve all double click events that the main program will send
to this window.
onFocus(...)
onFocus(self, int controlId)--onFocus method.
 
This method will recieve all focus events that the main program will send
to this window.
onInit(...)
onInit(self)--onInit method.
 
This method will be called to initialize the window
removeControl(...)
removeControl(self, Control)--Removes the control from this window.
 
Throws:
    - TypeError, if supplied argument is not aControl type
    - RuntimeError, if control is not added to this window
 
 
This will not delete the control. It is only removed from the window.
removeControls(...)
removeControls(self, List)--Removes a list of controls from this window.
 
Throws:
    - TypeError, if supplied argument is not aControl type
    - RuntimeError, if control is not added to this window
 
 
This will not delete the controls. They are only removed from the window.
setCoordinateResolution(...)
setCoordinateResolution(self, int resolution)--Sets the resolution that the coordinates of all controls are defined in. Allows XBMC to scale control positions and width/heights to whatever resolution XBMC is currently using.
 
resolution is one of the following:
    - 0 - 1080i (1920x1080)
    - 1 - 720p (1280x720)
    - 2 - 480p 4:3 (720x480)
    - 3 - 480p 16:9 (720x480)
    - 4 - NTSC 4:3 (720x480)
    - 5 - NTSC 16:9 (720x480)
    - 6 - PAL 4:3 (720x576)
    - 7 - PAL 16:9 (720x576)
    - 8 - PAL60 4:3 (720x480)
    - 9 - PAL60 16:9 (720x480)n
setFocus(...)
setFocus(self, Control)--Give the supplied control focus.
 
Throws:
    - TypeError, if supplied argument is not aControl type
    - SystemError, on Internal error
    - RuntimeError, if control is not added to a window
setFocusId(...)
setFocusId(self, int)--Gives the control with the supplied focus.
 
Throws:
    - SystemError, on Internal error
    - RuntimeError, if control is not added to a window
setProperty(...)
setProperty(key, value)--Sets a window property, similar to an infolabel.
 
key : string - property name.
value : string or unicode - value of property.
 
*Note, key is NOT case sensitive. Setting value to an empty string is equivalent to clearProperty(key) You can use the above as keywords for arguments and skip certain optional arguments. Once you use a keyword, all following arguments require the keyword.
 
example:
    - win =xbmcgui.Window (xbmcgui.getCurrentWindowId())
    - win.setProperty('Category', 'Newest')
show(...)
show(self)--Show this window.
 
Shows this window by activating it, callingclose() after it wil activate the current window again.
 
Note, if your script ends this window will be closed to. To show it forever, make a loop at the end of your script ar usedoModal() instead

 
class WindowXML(Window)
    WindowXML class.
 
WindowXML(self, xmlFilename, scriptPath[, defaultSkin, defaultRes])--Create a newWindowXML script.
 
xmlFilename : string - the name of the xml file to look for.
scriptPath : string - path to script. used to fallback to if the xml doesn't exist in the current skin. (eg os.getcwd())
defaultSkin : [opt] string - name of the folder in the skins path to look in for the xml. (default='Default')
defaultRes : [opt] string - default skins resolution. (default='720p')
 
*Note, skin folder structure is eg(resources/skins/Default/720p)
 
example:
 
    - ui = GUI('script-Lyrics-main.xml', os.getcwd(), 'LCARS', 'PAL')
ui.doModal()
del ui
 
 
Method resolution order:
WindowXML
Window
__builtin__.object

Methods defined here:
addItem(...)
addItem(item[, position])--Add a new item to thisWindow List .
 
 
    - item : string, unicode orListItem - item to add.
    - position : [opt] integer - position of item to add. (NO Int = Adds to bottom,0 adds to top, 1 adds to one below from top,-1 adds to one above from bottom etc etc )
        - If integer positions are greater than list size, negative positions will add to top of list, positive positions will add to bottom of list
 
 
 
example:
        - addItem('Reboot XBMC', 0)
clearList(...)
clearList() --Clear theWindow List .
 
example:
 
    - clearList()
getCurrentListPosition(...)
getCurrentListPosition() --Gets the current position in theWindow List .
 
example:
 
    - pos = getCurrentListPosition()
getListItem(...)
getListItem(position)--Returns a givenListItem in thisWindow List .
 
position : integer - position of item to return.
 
example:
 
    - listitem = getListItem(6)
getListSize(...)
getListSize() --Returns the number of items in thisWindow List .
 
example:
 
    - listSize = getListSize()
removeItem(...)
removeItem(position)--Removes a specified item based on position, from theWindow List .
 
position : integer - position of item to remove.
 
example:
 
    - removeItem(5)
setCurrentListPosition(...)
setCurrentListPosition(position)--Set the current position in theWindow List .
 
position : integer - position of item to set.
 
example:
 
    - setCurrentListPosition(5)
setProperty(...)
setProperty(key, value)--Sets a container property, similar to an infolabel.
 
key : string - property name.
value : string or unicode - value of property.
 
*Note, Key is NOT case sensitive. You can use the above as keywords for arguments and skip certain optional arguments.
Once you use a keyword, all following arguments require the keyword.
 
example:
 
    - setProperty('Category', 'Newest')

Data and other attributes defined here:
__new__ = <built-in method __new__ of type object>
T.__new__(S, ...) -> a new object with type S, a subtype of T

Methods inherited from Window:
addControl(...)
addControl(self, Control)--Add aControl to this window.
 
Throws:
    - TypeError, if supplied argument is not aControl type
    - ReferenceError, if control is already used in another window
    - RuntimeError, should not happen :-)
 
 
The next controls can be added to a window atm
 
-ControlLabel -ControlFadeLabel -ControlTextBox -ControlButton -ControlCheckMark -ControlList -ControlGroup -ControlImage -ControlRadioButton -ControlProgressn
addControls(...)
addControls(self, List)--Add a list of Controls to this window.
 
*Throws:
    - TypeError, if supplied argument is not ofList type, or a control is not ofControl type
    - ReferenceError, if control is already used in another window
    - RuntimeError, should not happen :-)
clearProperties(...)
clearProperties() --Clears all window properties.
 
example:
    - win =xbmcgui.Window (xbmcgui.getCurrentWindowId())
    - win.clearProperties()n
clearProperty(...)
clearProperty(key)--Clears the specific window property.
 
key : string - property name.
 
*Note, key is NOT case sensitive. Equivalent to setProperty(key,'') You can use the above as keywords for arguments and skip certain optional arguments. Once you use a keyword, all following arguments require the keyword.
 
example:
    - win =xbmcgui.Window (xbmcgui.getCurrentWindowId())
    - win.clearProperty('Category')n
close(...)
close(self)--Closes this window.
 
Closes this window by activating the old window. The window is not deleted with this method.
doModal(...)
doModal(self)--Display this window untilclose() is called.
getControl(...)
getControl(self, int controlId)--Get's the control from this window.
 
Throws: Exception, ifControl doesn't exist
 
controlId doesn't have to be a python control, it can be a control id from a xbmc window too (you can find id's in the xml files
 
Note, not python controls are not completely usable yet You can only use theControl functions
getFocus(...)
getFocus(self, Control)--returns the control which is focused.
 
Throws:
    - SystemError, on Internal error
    - RuntimeError, if no control has focus
getFocusId(...)
getFocusId(self, int)--returns the id of the control which is focused. Throws:
- SystemError, on Internal error
- RuntimeError, if no control has focus
getHeight(...)
getHeight(self)--Returns the height of this screen.
getProperty(...)
getProperty(key)--Returns a window property as a string, similar to an infolabel.
 
key : string - property name.
 
*Note, key is NOT case sensitive. You can use the above as keywords for arguments and skip certain optional arguments. Once you use a keyword, all following arguments require the keyword.
 
example:
    - win =xbmcgui.Window (xbmcgui.getCurrentWindowId())
    - category = win.getProperty('Category')
getResolution(...)
getResolution(self)--Returns the resolution of the scree The returned value is one of the following:
- 0 - 1080i (1920x1080)
- 1 - 720p (1280x720)
- 2 - 480p 4:3 (720x480)
- 3 - 480p 16:9 (720x480)
- 4 - NTSC 4:3 (720x480)
- 5 - NTSC 16:9 (720x480)
- 6 - PAL 4:3 (720x576)
- 7 - PAL 16:9 (720x576)
- 8 - PAL60 4:3 (720x480)
- 9 - PAL60 16:9 (720x480)n
getWidth(...)
getWidth(self)--Returns the width of this screen.
onAction(...)
onAction(self, Action action)--onAction method.
 
This method will recieve all actions that the main program will send to this window.
 
Notes:
    - By default, only the PREVIOUS_MENU and NAV_BACK actions are handled.
    - Overwrite this method to let your script handle all actions.
    - Don't forget to capture ACTION_PREVIOUS_MENU or ACTION_NAV_BACK, else the user can't close this window.
onClick(...)
onClick(self, int controlId)--onClick method.
 
This method will recieve all click events that the main program will send
to this window.
onControl(...)
onControl(self, Control control)--onClick method.
 
This method will recieve all click events on owned and selected controls when
the control itself doesn't handle the message.
onDoubleClick(...)
onDoubleClick(self, int controlId)--onClick method.
 
This method will recieve all double click events that the main program will send
to this window.
onFocus(...)
onFocus(self, int controlId)--onFocus method.
 
This method will recieve all focus events that the main program will send
to this window.
onInit(...)
onInit(self)--onInit method.
 
This method will be called to initialize the window
removeControl(...)
removeControl(self, Control)--Removes the control from this window.
 
Throws:
    - TypeError, if supplied argument is not aControl type
    - RuntimeError, if control is not added to this window
 
 
This will not delete the control. It is only removed from the window.
removeControls(...)
removeControls(self, List)--Removes a list of controls from this window.
 
Throws:
    - TypeError, if supplied argument is not aControl type
    - RuntimeError, if control is not added to this window
 
 
This will not delete the controls. They are only removed from the window.
setCoordinateResolution(...)
setCoordinateResolution(self, int resolution)--Sets the resolution that the coordinates of all controls are defined in. Allows XBMC to scale control positions and width/heights to whatever resolution XBMC is currently using.
 
resolution is one of the following:
    - 0 - 1080i (1920x1080)
    - 1 - 720p (1280x720)
    - 2 - 480p 4:3 (720x480)
    - 3 - 480p 16:9 (720x480)
    - 4 - NTSC 4:3 (720x480)
    - 5 - NTSC 16:9 (720x480)
    - 6 - PAL 4:3 (720x576)
    - 7 - PAL 16:9 (720x576)
    - 8 - PAL60 4:3 (720x480)
    - 9 - PAL60 16:9 (720x480)n
setFocus(...)
setFocus(self, Control)--Give the supplied control focus.
 
Throws:
    - TypeError, if supplied argument is not aControl type
    - SystemError, on Internal error
    - RuntimeError, if control is not added to a window
setFocusId(...)
setFocusId(self, int)--Gives the control with the supplied focus.
 
Throws:
    - SystemError, on Internal error
    - RuntimeError, if control is not added to a window
show(...)
show(self)--Show this window.
 
Shows this window by activating it, callingclose() after it wil activate the current window again.
 
Note, if your script ends this window will be closed to. To show it forever, make a loop at the end of your script ar usedoModal() instead

 
class WindowXMLDialog(WindowXML)
    WindowXMLDialog class.
 
WindowXMLDialog(self, xmlFilename, scriptPath[, defaultSkin, defaultRes])--Create a newWindowXMLDialog script.
 
xmlFilename : string - the name of the xml file to look for.
scriptPath : string - path to script. used to fallback to if the xml doesn't exist in the current skin. (eg os.getcwd())
defaultSkin : [opt] string - name of the folder in the skins path to look in for the xml. (default='Default')
defaultRes : [opt] string - default skins resolution. (default='720p')
 
*Note, skin folder structure is eg(resources/skins/Default/720p)
 
example:
    - ui = GUI('script-Lyrics-main.xml', os.getcwd(), 'LCARS', 'PAL')
    - ui.doModal()
    - del ui
 
 
Method resolution order:
WindowXMLDialog
WindowXML
Window
__builtin__.object

Data and other attributes defined here:
__new__ = <built-in method __new__ of type object>
T.__new__(S, ...) -> a new object with type S, a subtype of T

Methods inherited from WindowXML:
addItem(...)
addItem(item[, position])--Add a new item to thisWindow List .
 
 
    - item : string, unicode orListItem - item to add.
    - position : [opt] integer - position of item to add. (NO Int = Adds to bottom,0 adds to top, 1 adds to one below from top,-1 adds to one above from bottom etc etc )
        - If integer positions are greater than list size, negative positions will add to top of list, positive positions will add to bottom of list
 
 
 
example:
        - addItem('Reboot XBMC', 0)
clearList(...)
clearList() --Clear theWindow List .
 
example:
 
    - clearList()
getCurrentListPosition(...)
getCurrentListPosition() --Gets the current position in theWindow List .
 
example:
 
    - pos = getCurrentListPosition()
getListItem(...)
getListItem(position)--Returns a givenListItem in thisWindow List .
 
position : integer - position of item to return.
 
example:
 
    - listitem = getListItem(6)
getListSize(...)
getListSize() --Returns the number of items in thisWindow List .
 
example:
 
    - listSize = getListSize()
removeItem(...)
removeItem(position)--Removes a specified item based on position, from theWindow List .
 
position : integer - position of item to remove.
 
example:
 
    - removeItem(5)
setCurrentListPosition(...)
setCurrentListPosition(position)--Set the current position in theWindow List .
 
position : integer - position of item to set.
 
example:
 
    - setCurrentListPosition(5)
setProperty(...)
setProperty(key, value)--Sets a container property, similar to an infolabel.
 
key : string - property name.
value : string or unicode - value of property.
 
*Note, Key is NOT case sensitive. You can use the above as keywords for arguments and skip certain optional arguments.
Once you use a keyword, all following arguments require the keyword.
 
example:
 
    - setProperty('Category', 'Newest')

Methods inherited from Window:
addControl(...)
addControl(self, Control)--Add aControl to this window.
 
Throws:
    - TypeError, if supplied argument is not aControl type
    - ReferenceError, if control is already used in another window
    - RuntimeError, should not happen :-)
 
 
The next controls can be added to a window atm
 
-ControlLabel -ControlFadeLabel -ControlTextBox -ControlButton -ControlCheckMark -ControlList -ControlGroup -ControlImage -ControlRadioButton -ControlProgressn
addControls(...)
addControls(self, List)--Add a list of Controls to this window.
 
*Throws:
    - TypeError, if supplied argument is not ofList type, or a control is not ofControl type
    - ReferenceError, if control is already used in another window
    - RuntimeError, should not happen :-)
clearProperties(...)
clearProperties() --Clears all window properties.
 
example:
    - win =xbmcgui.Window (xbmcgui.getCurrentWindowId())
    - win.clearProperties()n
clearProperty(...)
clearProperty(key)--Clears the specific window property.
 
key : string - property name.
 
*Note, key is NOT case sensitive. Equivalent to setProperty(key,'') You can use the above as keywords for arguments and skip certain optional arguments. Once you use a keyword, all following arguments require the keyword.
 
example:
    - win =xbmcgui.Window (xbmcgui.getCurrentWindowId())
    - win.clearProperty('Category')n
close(...)
close(self)--Closes this window.
 
Closes this window by activating the old window. The window is not deleted with this method.
doModal(...)
doModal(self)--Display this window untilclose() is called.
getControl(...)
getControl(self, int controlId)--Get's the control from this window.
 
Throws: Exception, ifControl doesn't exist
 
controlId doesn't have to be a python control, it can be a control id from a xbmc window too (you can find id's in the xml files
 
Note, not python controls are not completely usable yet You can only use theControl functions
getFocus(...)
getFocus(self, Control)--returns the control which is focused.
 
Throws:
    - SystemError, on Internal error
    - RuntimeError, if no control has focus
getFocusId(...)
getFocusId(self, int)--returns the id of the control which is focused. Throws:
- SystemError, on Internal error
- RuntimeError, if no control has focus
getHeight(...)
getHeight(self)--Returns the height of this screen.
getProperty(...)
getProperty(key)--Returns a window property as a string, similar to an infolabel.
 
key : string - property name.
 
*Note, key is NOT case sensitive. You can use the above as keywords for arguments and skip certain optional arguments. Once you use a keyword, all following arguments require the keyword.
 
example:
    - win =xbmcgui.Window (xbmcgui.getCurrentWindowId())
    - category = win.getProperty('Category')
getResolution(...)
getResolution(self)--Returns the resolution of the scree The returned value is one of the following:
- 0 - 1080i (1920x1080)
- 1 - 720p (1280x720)
- 2 - 480p 4:3 (720x480)
- 3 - 480p 16:9 (720x480)
- 4 - NTSC 4:3 (720x480)
- 5 - NTSC 16:9 (720x480)
- 6 - PAL 4:3 (720x576)
- 7 - PAL 16:9 (720x576)
- 8 - PAL60 4:3 (720x480)
- 9 - PAL60 16:9 (720x480)n
getWidth(...)
getWidth(self)--Returns the width of this screen.
onAction(...)
onAction(self, Action action)--onAction method.
 
This method will recieve all actions that the main program will send to this window.
 
Notes:
    - By default, only the PREVIOUS_MENU and NAV_BACK actions are handled.
    - Overwrite this method to let your script handle all actions.
    - Don't forget to capture ACTION_PREVIOUS_MENU or ACTION_NAV_BACK, else the user can't close this window.
onClick(...)
onClick(self, int controlId)--onClick method.
 
This method will recieve all click events that the main program will send
to this window.
onControl(...)
onControl(self, Control control)--onClick method.
 
This method will recieve all click events on owned and selected controls when
the control itself doesn't handle the message.
onDoubleClick(...)
onDoubleClick(self, int controlId)--onClick method.
 
This method will recieve all double click events that the main program will send
to this window.
onFocus(...)
onFocus(self, int controlId)--onFocus method.
 
This method will recieve all focus events that the main program will send
to this window.
onInit(...)
onInit(self)--onInit method.
 
This method will be called to initialize the window
removeControl(...)
removeControl(self, Control)--Removes the control from this window.
 
Throws:
    - TypeError, if supplied argument is not aControl type
    - RuntimeError, if control is not added to this window
 
 
This will not delete the control. It is only removed from the window.
removeControls(...)
removeControls(self, List)--Removes a list of controls from this window.
 
Throws:
    - TypeError, if supplied argument is not aControl type
    - RuntimeError, if control is not added to this window
 
 
This will not delete the controls. They are only removed from the window.
setCoordinateResolution(...)
setCoordinateResolution(self, int resolution)--Sets the resolution that the coordinates of all controls are defined in. Allows XBMC to scale control positions and width/heights to whatever resolution XBMC is currently using.
 
resolution is one of the following:
    - 0 - 1080i (1920x1080)
    - 1 - 720p (1280x720)
    - 2 - 480p 4:3 (720x480)
    - 3 - 480p 16:9 (720x480)
    - 4 - NTSC 4:3 (720x480)
    - 5 - NTSC 16:9 (720x480)
    - 6 - PAL 4:3 (720x576)
    - 7 - PAL 16:9 (720x576)
    - 8 - PAL60 4:3 (720x480)
    - 9 - PAL60 16:9 (720x480)n
setFocus(...)
setFocus(self, Control)--Give the supplied control focus.
 
Throws:
    - TypeError, if supplied argument is not aControl type
    - SystemError, on Internal error
    - RuntimeError, if control is not added to a window
setFocusId(...)
setFocusId(self, int)--Gives the control with the supplied focus.
 
Throws:
    - SystemError, on Internal error
    - RuntimeError, if control is not added to a window
show(...)
show(self)--Show this window.
 
Shows this window by activating it, callingclose() after it wil activate the current window again.
 
Note, if your script ends this window will be closed to. To show it forever, make a loop at the end of your script ar usedoModal() instead

 
Functions
       
getCurrentWindowDialogId(...)
getCurrentWindowDialogId()--Returns the id for the current 'active' dialog as an integer.
 
example:
    - wid = xbmcgui.getCurrentWindowDialogId()
getCurrentWindowId(...)
getCurrentWindowId()--Returns the id for the current 'active' window as an integer.
 
example:
    - wid = xbmcgui.getCurrentWindowId()
lock(...)
lock()--Lock the gui until xbmcgui.unlock() is called.
 
*Note, This will improve performance when doing a lot of gui manipulation at once.
The main program (xbmc itself) will freeze until xbmcgui.unlock() is called.
 
 
example:
    - xbmcgui.lock()
unlock(...)
unlock()--Unlock the gui from a lock() call.
 
example:
    - xbmcgui.unlock()

 
Data
        ACTION_ANALOG_FORWARD = 113
ACTION_ANALOG_MOVE = 49
ACTION_ANALOG_REWIND = 114
ACTION_ANALOG_SEEK_BACK = 125
ACTION_ANALOG_SEEK_FORWARD = 124
ACTION_ASPECT_RATIO = 19
ACTION_AUDIO_DELAY = 161
ACTION_AUDIO_DELAY_MIN = 54
ACTION_AUDIO_DELAY_PLUS = 55
ACTION_AUDIO_NEXT_LANGUAGE = 56
ACTION_BACKSPACE = 110
ACTION_BIG_STEP_BACK = 23
ACTION_BIG_STEP_FORWARD = 22
ACTION_BUILT_IN_FUNCTION = 122
ACTION_CALIBRATE_RESET = 48
ACTION_CALIBRATE_SWAP_ARROWS = 47
ACTION_CHANGE_RESOLUTION = 57
ACTION_CHANNEL_DOWN = 185
ACTION_CHANNEL_SWITCH = 183
ACTION_CHANNEL_UP = 184
ACTION_CHAPTER_OR_BIG_STEP_BACK = 98
ACTION_CHAPTER_OR_BIG_STEP_FORWARD = 97
ACTION_CONTEXT_MENU = 117
ACTION_COPY_ITEM = 81
ACTION_CREATE_BOOKMARK = 96
ACTION_CREATE_EPISODE_BOOKMARK = 95
ACTION_CURSOR_LEFT = 120
ACTION_CURSOR_RIGHT = 121
ACTION_DECREASE_PAR = 220
ACTION_DECREASE_RATING = 137
ACTION_DELETE_ITEM = 80
ACTION_ENTER = 135
ACTION_FILTER = 233
ACTION_FILTER_CLEAR = 150
ACTION_FILTER_SMS2 = 151
ACTION_FILTER_SMS3 = 152
ACTION_FILTER_SMS4 = 153
ACTION_FILTER_SMS5 = 154
ACTION_FILTER_SMS6 = 155
ACTION_FILTER_SMS7 = 156
ACTION_FILTER_SMS8 = 157
ACTION_FILTER_SMS9 = 158
ACTION_FIRST_PAGE = 159
ACTION_FORWARD = 16
ACTION_GESTURE_BEGIN = 501
ACTION_GESTURE_END = 599
ACTION_GESTURE_NOTIFY = 500
ACTION_GESTURE_PAN = 504
ACTION_GESTURE_ROTATE = 503
ACTION_GESTURE_SWIPE_DOWN = 541
ACTION_GESTURE_SWIPE_DOWN_TEN = 550
ACTION_GESTURE_SWIPE_LEFT = 511
ACTION_GESTURE_SWIPE_LEFT_TEN = 520
ACTION_GESTURE_SWIPE_RIGHT = 521
ACTION_GESTURE_SWIPE_RIGHT_TEN = 530
ACTION_GESTURE_SWIPE_UP = 531
ACTION_GESTURE_SWIPE_UP_TEN = 540
ACTION_GESTURE_ZOOM = 502
ACTION_GUIPROFILE_BEGIN = 204
ACTION_HIGHLIGHT_ITEM = 8
ACTION_INCREASE_PAR = 219
ACTION_INCREASE_RATING = 136
ACTION_JUMP_SMS2 = 142
ACTION_JUMP_SMS3 = 143
ACTION_JUMP_SMS4 = 144
ACTION_JUMP_SMS5 = 145
ACTION_JUMP_SMS6 = 146
ACTION_JUMP_SMS7 = 147
ACTION_JUMP_SMS8 = 148
ACTION_JUMP_SMS9 = 149
ACTION_LAST_PAGE = 160
ACTION_MOUSE_DOUBLE_CLICK = 103
ACTION_MOUSE_DRAG = 106
ACTION_MOUSE_END = 109
ACTION_MOUSE_LEFT_CLICK = 100
ACTION_MOUSE_MIDDLE_CLICK = 102
ACTION_MOUSE_MOVE = 107
ACTION_MOUSE_RIGHT_CLICK = 101
ACTION_MOUSE_START = 100
ACTION_MOUSE_WHEEL_DOWN = 105
ACTION_MOUSE_WHEEL_UP = 104
ACTION_MOVE_DOWN = 4
ACTION_MOVE_ITEM = 82
ACTION_MOVE_ITEM_DOWN = 116
ACTION_MOVE_ITEM_UP = 115
ACTION_MOVE_LEFT = 1
ACTION_MOVE_RIGHT = 2
ACTION_MOVE_UP = 3
ACTION_MUTE = 91
ACTION_NAV_BACK = 92
ACTION_NEXT_CHANNELGROUP = 186
ACTION_NEXT_CONTROL = 181
ACTION_NEXT_ITEM = 14
ACTION_NEXT_LETTER = 140
ACTION_NEXT_PICTURE = 28
ACTION_NEXT_SCENE = 138
ACTION_NEXT_SUBTITLE = 26
ACTION_NONE = 0
ACTION_NOOP = 999
ACTION_OSD_HIDESUBMENU = 84
ACTION_OSD_SHOW_DOWN = 72
ACTION_OSD_SHOW_LEFT = 69
ACTION_OSD_SHOW_RIGHT = 70
ACTION_OSD_SHOW_SELECT = 73
ACTION_OSD_SHOW_UP = 71
ACTION_OSD_SHOW_VALUE_MIN = 75
ACTION_OSD_SHOW_VALUE_PLUS = 74
ACTION_PAGE_DOWN = 6
ACTION_PAGE_UP = 5
ACTION_PARENT_DIR = 9
ACTION_PASTE = 180
ACTION_PAUSE = 12
ACTION_PLAY = 68
ACTION_PLAYER_FORWARD = 77
ACTION_PLAYER_PLAY = 79
ACTION_PLAYER_PLAYPAUSE = 229
ACTION_PLAYER_REWIND = 78
ACTION_PREVIOUS_CHANNELGROUP = 187
ACTION_PREVIOUS_MENU = 10
ACTION_PREV_CONTROL = 182
ACTION_PREV_ITEM = 15
ACTION_PREV_LETTER = 141
ACTION_PREV_PICTURE = 29
ACTION_PREV_SCENE = 139
ACTION_PVR_PLAY = 188
ACTION_PVR_PLAY_RADIO = 190
ACTION_PVR_PLAY_TV = 189
ACTION_QUEUE_ITEM = 34
ACTION_RECORD = 170
ACTION_RELOAD_KEYMAPS = 203
ACTION_REMOVE_ITEM = 35
ACTION_RENAME_ITEM = 87
ACTION_REWIND = 17
ACTION_ROTATE_PICTURE_CCW = 51
ACTION_ROTATE_PICTURE_CW = 50
ACTION_SCAN_ITEM = 201
ACTION_SCROLL_DOWN = 112
ACTION_SCROLL_UP = 111
ACTION_SELECT_ITEM = 7
ACTION_SETTINGS_LEVEL_CHANGE = 242
ACTION_SETTINGS_RESET = 241
ACTION_SHIFT = 118
ACTION_SHOW_CODEC = 27
ACTION_SHOW_FULLSCREEN = 36
ACTION_SHOW_GUI = 18
ACTION_SHOW_INFO = 11
ACTION_SHOW_MPLAYER_OSD = 83
ACTION_SHOW_OSD = 24
ACTION_SHOW_OSD_TIME = 123
ACTION_SHOW_PLAYLIST = 33
ACTION_SHOW_SUBTITLES = 25
ACTION_SHOW_VIDEOMENU = 134
ACTION_SMALL_STEP_BACK = 76
ACTION_STEP_BACK = 21
ACTION_STEP_FORWARD = 20
ACTION_STEREOMODE_NEXT = 235
ACTION_STEREOMODE_PREVIOUS = 236
ACTION_STEREOMODE_SELECT = 238
ACTION_STEREOMODE_SET = 240
ACTION_STEREOMODE_TOGGLE = 237
ACTION_STEREOMODE_TOMONO = 239
ACTION_STOP = 13
ACTION_SUBTITLE_ALIGN = 232
ACTION_SUBTITLE_DELAY = 162
ACTION_SUBTITLE_DELAY_MIN = 52
ACTION_SUBTITLE_DELAY_PLUS = 53
ACTION_SUBTITLE_VSHIFT_DOWN = 231
ACTION_SUBTITLE_VSHIFT_UP = 230
ACTION_SWITCH_PLAYER = 234
ACTION_SYMBOLS = 119
ACTION_TAKE_SCREENSHOT = 85
ACTION_TELETEXT_BLUE = 218
ACTION_TELETEXT_GREEN = 216
ACTION_TELETEXT_RED = 215
ACTION_TELETEXT_YELLOW = 217
ACTION_TOGGLE_DIGITAL_ANALOG = 202
ACTION_TOGGLE_FULLSCREEN = 199
ACTION_TOGGLE_SOURCE_DEST = 32
ACTION_TOGGLE_WATCHED = 200
ACTION_TOUCH_LONGPRESS = 411
ACTION_TOUCH_LONGPRESS_TEN = 420
ACTION_TOUCH_TAP = 401
ACTION_TOUCH_TAP_TEN = 410
ACTION_VIS_PRESET_LIST = 127
ACTION_VIS_PRESET_LOCK = 130
ACTION_VIS_PRESET_NEXT = 128
ACTION_VIS_PRESET_PREV = 129
ACTION_VIS_PRESET_RANDOM = 131
ACTION_VIS_PRESET_SHOW = 126
ACTION_VIS_RATE_PRESET_MINUS = 133
ACTION_VIS_RATE_PRESET_PLUS = 132
ACTION_VOLAMP_DOWN = 94
ACTION_VOLAMP_UP = 93
ACTION_VOLUME_DOWN = 89
ACTION_VOLUME_UP = 88
ACTION_VSHIFT_DOWN = 228
ACTION_VSHIFT_UP = 227
ACTION_ZOOM_IN = 31
ACTION_ZOOM_LEVEL_1 = 38
ACTION_ZOOM_LEVEL_2 = 39
ACTION_ZOOM_LEVEL_3 = 40
ACTION_ZOOM_LEVEL_4 = 41
ACTION_ZOOM_LEVEL_5 = 42
ACTION_ZOOM_LEVEL_6 = 43
ACTION_ZOOM_LEVEL_7 = 44
ACTION_ZOOM_LEVEL_8 = 45
ACTION_ZOOM_LEVEL_9 = 46
ACTION_ZOOM_LEVEL_NORMAL = 37
ACTION_ZOOM_OUT = 30
ALPHANUM_HIDE_INPUT = 2
CONTROL_TEXT_OFFSET_X = 10
CONTROL_TEXT_OFFSET_Y = 2
ICON_OVERLAY_HAS_TRAINER = 4
ICON_OVERLAY_HD = 8
ICON_OVERLAY_LOCKED = 3
ICON_OVERLAY_NONE = 0
ICON_OVERLAY_RAR = 1
ICON_OVERLAY_TRAINED = 5
ICON_OVERLAY_UNWATCHED = 6
ICON_OVERLAY_WATCHED = 7
ICON_OVERLAY_ZIP = 2
ICON_TYPE_FILES = 106
ICON_TYPE_MUSIC = 103
ICON_TYPE_NONE = 101
ICON_TYPE_PICTURES = 104
ICON_TYPE_PROGRAMS = 102
ICON_TYPE_SETTINGS = 109
ICON_TYPE_VIDEOS = 105
ICON_TYPE_WEATHER = 107
INPUT_ALPHANUM = 0
INPUT_DATE = 2
INPUT_IPADDRESS = 4
INPUT_NUMERIC = 1
INPUT_PASSWORD = 5
INPUT_TIME = 3
KEY_APPCOMMAND = 53248
KEY_ASCII = 61696
KEY_BUTTON_A = 256
KEY_BUTTON_B = 257
KEY_BUTTON_BACK = 275
KEY_BUTTON_BLACK = 260
KEY_BUTTON_DPAD_DOWN = 271
KEY_BUTTON_DPAD_LEFT = 272
KEY_BUTTON_DPAD_RIGHT = 273
KEY_BUTTON_DPAD_UP = 270
KEY_BUTTON_LEFT_ANALOG_TRIGGER = 278
KEY_BUTTON_LEFT_THUMB_BUTTON = 276
KEY_BUTTON_LEFT_THUMB_STICK = 264
KEY_BUTTON_LEFT_THUMB_STICK_DOWN = 281
KEY_BUTTON_LEFT_THUMB_STICK_LEFT = 282
KEY_BUTTON_LEFT_THUMB_STICK_RIGHT = 283
KEY_BUTTON_LEFT_THUMB_STICK_UP = 280
KEY_BUTTON_LEFT_TRIGGER = 262
KEY_BUTTON_RIGHT_ANALOG_TRIGGER = 279
KEY_BUTTON_RIGHT_THUMB_BUTTON = 277
KEY_BUTTON_RIGHT_THUMB_STICK = 265
KEY_BUTTON_RIGHT_THUMB_STICK_DOWN = 267
KEY_BUTTON_RIGHT_THUMB_STICK_LEFT = 268
KEY_BUTTON_RIGHT_THUMB_STICK_RIGHT = 269
KEY_BUTTON_RIGHT_THUMB_STICK_UP = 266
KEY_BUTTON_RIGHT_TRIGGER = 263
KEY_BUTTON_START = 274
KEY_BUTTON_WHITE = 261
KEY_BUTTON_X = 258
KEY_BUTTON_Y = 259
KEY_INVALID = 65535
KEY_MOUSE = 57344
KEY_TOUCH = 61440
KEY_UNICODE = 61952
KEY_VKEY = 61440
KEY_VMOUSE = 61439
NOTIFICATION_ERROR = 'error'
NOTIFICATION_INFO = 'info'
NOTIFICATION_WARNING = 'warning'
PASSWORD_VERIFY = 1
REMOTE_0 = 58
REMOTE_1 = 59
REMOTE_2 = 60
REMOTE_3 = 61
REMOTE_4 = 62
REMOTE_5 = 63
REMOTE_6 = 64
REMOTE_7 = 65
REMOTE_8 = 66
REMOTE_9 = 67
__author__ = 'Team XBMC <http://xbmc.org>'
__credits__ = 'Team XBMC'
__date__ = 'Thu Apr 17 08:03:55 BST 2014'
__platform__ = 'ALL'
__version__ = '2.14.0'

 
Author
        Team XBMC <http://xbmc.org>

 
Credits
        Team XBMC