• Home
• MediaPortal
• GUI
• Library
• GUIWindow

C# Class MediaPortal.GUI.Library.GUIWindow

ファイルを表示 Open project: MediaPortal/MediaPortal-1 Class Usage Examples

Public Properties

Property	Type	Description
_mainThreadContext	System.Threading.SynchronizationContext

Protected Properties

Property	Type	Description
_autoHideTopbar	bool
_autoHideTopbarType	AutoHideTopBar
_defaultControlId	int
_disableTopBar	bool
_isOverlayAllowed	bool
_isOverlayAllowedCondition	int
_isOverlayAllowedOriginalCondition	int
_listPositions	List
_loadParameter	string
_loadSkinDone	bool
_shouldRestore	bool
_volumeOverlayOffsetX	int
_volumeOverlayOffsetY	int
_windowXmlFileName	string

Public Methods

Method	Description
Add ( GUIControl &control ) : void	add a new control to this window
AllocResources ( ) : void	Gets called by the runtime just before the window gets shown. It will ask every control of the window to allocate its (directx) resources
BeginInit ( ) : void
Clear ( ) : void	Clear() method. This method gets called when user switches skin. It removes any static vars the GUIWindow class has
ClearAll ( ) : void	remove all controls from the window
DeInit ( ) : void	Gets called by the runtime when a window will be destroyed Every window window should override this method and cleanup any resources
Dispose ( ) : void	Gets called by the runtime when the window is not longer shown. It will ask every control of the window 2 free its (directx) resources
DoRestoreSkin ( ) : void
EndInit ( ) : void
GUIWindow ( ) : System	The (empty) constructor of the GUIWindow
GUIWindow ( string skinFile ) : System	Constructor
GetControl ( int iControlId ) : GUIControl	get a control by the control ID
GetFocusControlId ( ) : int	returns the ID of the control which has the focus
GetModuleName ( ) : string
InWindow ( int x, int y ) : bool
Init ( ) : bool	Gets called by the runtime when a new window has been created Every window window should override this method and load itself by calling the Load() method
InitControls ( ) : void	This method will call the OnInit() on each control belonging to this window this gives the control a way to do some pre-initalisation stuff
IsInstance ( Object obj ) : bool
Load ( string skinFileName ) : bool	Load the XML file for this window which contains a definition of which controls the GUI has
LoadSkin ( ) : bool
LoadSkinBool ( ) : bool	Loads the xml file for the window.
LoadSkinThreaded ( int p1, int p2, object s ) : int
LooseFocus ( ) : void	This method will remove the focus from the currently focused control
NeedRefresh ( ) : bool	NeedRefresh() can be called to see if the windows needs 2 redraw itself or not some controls (for example the fadelabel) contain scrolling texts and need 2 ne re-rendered constantly
OnAction ( Action action ) : void	OnAction() method. This method gets called when there's a new action like a keypress or mousemove or... By overriding this method, the window can respond to any action
OnAdded ( ) : void
OnDeviceLost ( ) : void	Gets called when DirectX device has been lost. Any texture/font is now invalid
OnDeviceRestored ( ) : void	Gets called when DirectX device has been restored.
OnMessage ( GUIMessage message ) : bool	OnMessage() This method gets called when there's a new message. Controls send messages to notify their parents about their state (changes) By overriding this method a window can respond to the messages of its controls
PreInit ( ) : void	This function gets called once by the runtime when everything is up & running directX is now initialized, but before the first window is activated. It gives the window the oppertunity to allocate any (directx) resources it may need
Process ( ) : void
QueueAnimation ( AnimationType animType ) : void
Remove ( int dwId ) : void	remove a control by its id from this window
Render ( float timePassed ) : void	Render() method. This method draws the window by asking every control of the window to render itself
ResetAllControls ( ) : void	Resets all the controls to their original positions, width and height
Restore ( ) : void	Restores all the (x,y) positions of the XML file to their original values
RestoreControlPosition ( int iControl ) : void	Restores the position of the control to its default position.
SendToFront ( GUIControl &ctrl ) : void	Move the control with the specified id to the end of the control list (will render last; in front of other controls).
SetObject ( object obj ) : void
UpdateOverlay ( ) : void	Restores window overlay status to default value from skin condition
UpdateVisibility ( ) : void	calls UpdateVisibility for all children components (also used for allowing to switch focus to a component that can only be focused if the current component is not active)

Protected Methods

Method	Description
DeInitControls ( ) : void
IsAnimating ( AnimationType animType ) : bool
LoadControl ( XmlNode node, string>.IDictionary defines ) : void	This method will load a single control from the xml node
OnClicked ( int controlId, GUIControl control, Action actionType ) : void
OnClickedDown ( int controlId, GUIControl control, Action actionType ) : void
OnClickedUp ( int controlId, GUIControl control, Action actionType ) : void
OnMouseClick ( int posX, int posY, Action action ) : void
OnMouseMove ( int cx, int cy, Action action ) : void
OnPageDestroy ( int newWindowId ) : void
OnPageLoad ( ) : void
OnPreviousWindow ( ) : void
OnShowContextMenu ( ) : void
OnWindowLoaded ( ) : void	Gets by the window manager when it has loaded the window default implementation stores the position of all controls in _listPositions
PreLoadPage ( ) : void

Private Methods

Method	Description
AnimationTrigger ( GUIMessage message ) : void
FreeResources ( ) : void
HasAnimation ( AnimationType animType ) : bool
LoadDefines ( XmlDocument document ) : string>.IDictionary
LoadInclude ( XmlNode node, string>.IDictionary defines ) : bool
RenderAnimation ( uint time ) : bool
SetControlVisibility ( ) : void
SetInitialOverlayAllowed ( ) : void
TemporaryAnimationTrigger ( ) : void
UpdateOverlayAllowed ( ) : void
UpdateOverlayAllowed ( bool useOriginal ) : void
UpdateStates ( AnimationType type, AnimationProcess currentProcess, AnimationState currentState ) : void

Method Details

Property Details