Skip to content

Latest commit

 

History

History
156 lines (95 loc) · 3.59 KB

dearpygui_wrapper.md

File metadata and controls

156 lines (95 loc) · 3.59 KB

DearPyGuiWrapper

Cli2gui Index / Cli2gui / Gui / DearPyGuiWrapper

Auto-generated documentation for cli2gui.gui.dearpygui_wrapper module.

DearPyGuiWrapper

Show source in dearpygui_wrapper.py:26

Wrapper class for Dear PyGui.

Signature

class DearPyGuiWrapper(AbstractGUI):
    def __init__(self, base24Theme: list[str]) -> None: ...

See also

DearPyGuiWrapper()._helpFileWidget

Show source in dearpygui_wrapper.py:80

Create a UI element with an input text field and a file picker.

Signature

def _helpFileWidget(self, item: Item) -> None: ...

See also

DearPyGuiWrapper().addItemsAndGroups

Show source in dearpygui_wrapper.py:147

Items and groups and return a list of these so we can get values from the dpg widgets.

Arguments

  • section Group - section with a name to display and items

Returns

Type: list[Item] flattened list of items

Signature

def addItemsAndGroups(self, section: Group) -> list[Item]: ...

See also

DearPyGuiWrapper().addWidgetFromItem

Show source in dearpygui_wrapper.py:125

Select a widget based on the item type.

Arguments

  • item Item - the item

Signature

def addWidgetFromItem(self, item: Item) -> None: ...

See also

DearPyGuiWrapper().main

Show source in dearpygui_wrapper.py:191

Run the gui (dpg) with a given buildSpec, quit_callback, and run_callback.

  • Theming + Configure dpg
  • Menu Prep
  • Create Window, set up Menu and Widgets
  • Then, start dpg

Arguments

  • buildSpec FullBuildSpec - Full cli parse/ build spec :param Callable[[], None] quit_callback: generic callable used to quit :param Callable[[dict[str, Any]], None] run_callback: generic callable used to run

Signature

def main(
    self,
    buildSpec: FullBuildSpec,
    quit_callback: Callable[[], None],
    run_callback: Callable[[dict[str, Any]], None],
) -> None: ...

See also

DearPyGuiWrapper().open_menu_item

Show source in dearpygui_wrapper.py:177

Open a menu item.

Arguments

  • sender type - file to open
  • _app_data type - [unused]

Signature

def open_menu_item(self, sender: str, _app_data: None) -> None: ...

hex_to_rgb

Show source in dearpygui_wrapper.py:17

Convert a color hex code to a tuple of integers (r, g, b).

Signature

def hex_to_rgb(hex_code: str) -> tuple[int, int, int, int]: ...