epic/OpenRA
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #10651 from Phrohdoh/widget-xmldoc

Browse Source 
Add xmldoc to Widget.HandleMouseInput
This commit is contained in:
Oliver Brakmann
2016-01-30 22:06:25 +01:00
parent 10ebd7e48d d12fd9de86
commit c22281876c
1 changed files with 7 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
OpenRA.Game/Widgets/Widget.cs
View File

@@ -108,6 +108,9 @@ namespace OpenRA.Widgets
return handled; return handled;
} }
/// <summary>Possibly handle keyboard input (if this widget has keyboard focus)</summary>
/// <returns><c>true</c>, if keyboard input was handled, <c>false</c> if the input should bubble to the parent widget</returns>
/// <param name="e">Key input data</param>
public static bool HandleKeyPress(KeyInput e) public static bool HandleKeyPress(KeyInput e)
{ {
if (KeyboardFocusWidget != null) if (KeyboardFocusWidget != null)
@@ -345,6 +348,10 @@ namespace OpenRA.Widgets
public virtual void MouseEntered() { } public virtual void MouseEntered() { }
public virtual void MouseExited() { } public virtual void MouseExited() { }
/// <summary>Possibly handles mouse input (click, drag, scroll, etc).</summary>
/// <returns><c>true</c>, if mouse input was handled, <c>false</c> if the input should bubble to the parent widget</returns>
/// <param name="mi">Mouse input data</param>
public virtual bool HandleMouseInput(MouseInput mi) { return false; } public virtual bool HandleMouseInput(MouseInput mi) { return false; }
public bool HandleMouseInputOuter(MouseInput mi) public bool HandleMouseInputOuter(MouseInput mi)