update methods documentation

spyoungtech · Jul 31, 2023 · b092add · b092add
1 parent cc95ca3
commit b092add
Show file tree

Hide file tree

Showing 2 changed files with 35 additions and 13 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -291,6 +291,9 @@ ahk.sound_set(50, device_number=1, component_type='MASTER', control_type='VOLUME
 
 ## GUI
 
+
+Tooltips/traytips
+
 ```python
 import time
 from ahk import AHK
@@ -304,6 +307,18 @@ ahk.show_warning_traytip("Warning", "It's a warning")
 ahk.show_error_traytip("Error", "It's an error")                                 # Error trytip
 ```
 
+Dialog boxes
+
+```python
+from ahk import AHK, MsgBoxButtons
+ahk = AHK()
+
+ahk.msg_box(text='Do you like message boxes?', title='My Title', buttons=MsgBoxButtons.YES_NO)
+ahk.input_box(prompt='Password', title='Enter your password', hide=True)
+ahk.file_select_box(title='Select one or more mp3 files', multi=True, filter='*.mp3', file_must_exist=True)
+ahk.folder_select_box(prompt='Select a folder')
+```
+
 ## Global state changes
 
 You can change various global states such as `CoordMode`, `DetectHiddenWindows`, etc. so you don't have to pass

diff --git a/docs/api/methods.rst b/docs/api/methods.rst
@@ -416,7 +416,8 @@ GUI
 ^^^
 
 GUI methods are largely unimplmented, except ``ToolTip`` and ``TrayTip``.
-We recommend using one of the many Python GUI libraries, such as `easygui <https://github.com/robertlugg/easygui>`_\ , `pysimplegui <https://www.pysimplegui.org/en/latest/>`_ or similar.
+We recommend using one of the many `Python GUI libraries <https://wiki.python.org/moin/GuiProgramming>`_, such as ``tkinter`` from the standard library or a third
+party package such as `pyqt <https://wiki.python.org/moin/PyQt>`_ , `pysimplegui <https://www.pysimplegui.org/en/latest/>`_ or similar.
 
 .. list-table::
    :header-rows: 1
@@ -440,40 +441,46 @@ We recommend using one of the many Python GUI libraries, such as `easygui <https
      - Not Implemented
      -
    * - `Gui TreeView control <https://www.autohotkey.com/docs/commands/TreeView.htm>`_
-     - Not Implemented
+     - Not planned
      -
    * - `IfMsgBox <https://www.autohotkey.com/docs/commands/IfMsgBox.htm>`_
-     - Not Implemented
+     - Not planned
      -
    * - `InputBox <https://www.autohotkey.com/docs/commands/InputBox.htm>`_
-     - Not Implemented
-     -
+     - Implemented
+     - :py:meth:`~ahk._sync.engine.input_box`
+   * - `FileSelectFile <https://www.autohotkey.com/docs/commands/FileSelectFile.htm>`_
+     - Implemented
+     - :py:meth:`~ahk._sync.engine.file_select_box`
+   * - `FileSelectFolder <https://www.autohotkey.com/docs/commands/FileSelectFile.htm>`_
+     - Implemented
+     - :py:meth:`~ahk._sync.engine.folder_select_box`
    * - `LoadPicture() <https://www.autohotkey.com/docs/commands/LoadPicture.htm>`_
      - Not Implemented
      -
    * - `Menu <https://www.autohotkey.com/docs/commands/Menu.htm>`_
      - Not Implemented
      -
    * - `MenuGetHandle() <https://www.autohotkey.com/docs/commands/MenuGetHandle.htm>`_
-     - Not Implemented
+     - Not Planned
      -
    * - `MenuGetName() <https://www.autohotkey.com/docs/commands/MenuGetName.htm>`_
-     - Not Implemented
+     - Not Planned
      -
    * - `MsgBox <https://www.autohotkey.com/docs/commands/MsgBox.htm>`_
-     - Not Implemented
-     -
+     - Implemented
+     - :py:meth:`~ahk._sync.engine.msg_box`
    * - `OnMessage() <https://www.autohotkey.com/docs/commands/OnMessage.htm>`_
-     - Not Implemented
+     - Not Planned
      -
    * - `Progress <https://www.autohotkey.com/docs/commands/Progress.htm>`_
-     - Not Implemented
+     - Not Planned
      -
    * - `SplashImage <https://www.autohotkey.com/docs/commands/Progress.htm>`_
-     - Not Implemented
+     - Not Planned
      -
    * - `SplashTextOn/Off <https://www.autohotkey.com/docs/commands/SplashTextOn.htm>`_
-     - Not Implemented
+     - Not Planned
      -
    * - `ToolTip <https://www.autohotkey.com/docs/commands/ToolTip.htm>`_
      - Implemented