From 1b3b684cbc4310e7e68cb37447a00dbd7b1dc0bf Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Manuel=20Cort=C3=A9z?= <manuel@manuelcortez.net>
Date: Sun, 16 Nov 2014 21:37:29 -0600
Subject: [PATCH] Some documentation added on the wx part on widgetUtils

---
 src/widgetUtils/wxUtils.py | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/src/widgetUtils/wxUtils.py b/src/widgetUtils/wxUtils.py
index 449cfa98..7a3438d9 100644
--- a/src/widgetUtils/wxUtils.py
+++ b/src/widgetUtils/wxUtils.py
@@ -1,19 +1,32 @@
 import wx
 
 # Code responses for WX dialogs.
+# this is when an user presses OK on a dialogue.
 OK = wx.ID_OK
+# This is when an user presses cancel on a dialogue.
 CANCEL = wx.ID_CANCEL
+# This is when an user closes the dialogue or an id to create the close button.
 CLOSE = wx.ID_CLOSE
+# The response for a "yes" Button pressed on a dialogue.
 YES = wx.ID_YES
+# This is when the user presses No on a default dialogue.
 NO = wx.ID_NO
 
 #events
+# This is raised when the application must be closed.
 CLOSE_EVENT = wx.EVT_CLOSE
+# This is activated when a button  is pressed.
 BUTTON_PRESSED = wx.EVT_BUTTON
+# This is activated when an user enter text on an edit box.
 ENTERED_TEXT = wx.EVT_TEXT
 
 def exit_application():
+ """ Closes the current window cleanly. """
  wx.GetApp().ExitMainLoop()
 
 def connect_event(parent, event, func):
+ """ Connects an event to a function.
+  parent wx.window: The widget that will listen for the event.
+  event widgetUtils.event: The event that will be listened for the parent. The event should be one of the widgetUtils events.
+  function func: The function that will be connected to the event."""
  return getattr(parent, "Bind")(event, func)
\ No newline at end of file