Skip to content

Commit

Permalink
main : updated README
Browse files Browse the repository at this point in the history
my1e5 committed Mar 13, 2023
1 parent d220c5c commit 66109aa
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -24,50 +24,50 @@ A collection of example scripts which demonstrate various features/functionality

Examples of how to implement various types of buttons. This includes how to implement a button which changes colour when clicked and how to implement nested radio buttons.

## Data binding
## [Data binding](data_binding/)

Examples of how to link a data structure to GUI items so that changes made using the GUI are reflected in the underlying data structure.

## Drawing
## [Drawing](drawing/)

Examples of how to use the drawing API.

### Simple paint
### [Simple paint](drawing/simple_paint.py)

A very simple implementation of a paint app. It demonstrates how you can click and drag the mouse on a `dpg.add_drawlist` and draw basic free-form lines using `dpg.draw_line`.

## Listbox
## [Listbox](listbox/)

Examples of custom listbox widgets which extend the functionality of the default listbox. Includes how to implement a listbox which is unselected by default and how to respond to key presses.

## Misc
## [Misc](misc/)

Miscellaneous examples.

## Persistance
## [Persistance](persistance/)

Examples of how to save and load the state of a GUI. This includes the values of GUI items, the position of windows, etc. A simple example using `dict` is shown as well as an approach using `dataclasses`. Both store the app state in a JSON file.

## Plots
## [Plots](plots/)

Examples of how to implement various features in plots. Such as enforcing axes limits and updating colours and marker styles.

## Sizing
## [Sizing](sizing/)

Examples of how to size/re-size GUI items. There are some quirks with sizing - mainly to do with getting the correct size of an item on startup.

## Spacing
## [Spacing](spacing/)

Examples of how to space GUI items using different methods. This includes automatic spacing, spacing using a grid of child windows and spacing using tables.

## Threading
## [Threading](threading/)

Examples of how to use threading in DearPyGui. Includes a start/stop button which can be used to start/stop a thread and a progress bar to show the progress of a task.

### Progress bar
### [Progress bar](threading/progress_bar.py)

A basic progress bar with a start button. Once running, the start button changes to a pause button. The task can then be paused, upon which the pause button changes to a resume button and a reset button appears.

## Window
## [Window](window/)

Examples of how to manage windows. This includes how to create a window which is always on top and how to drag the viewport when `decorated=False`. Also includes restricting the position of a window and how to implement a clicked handler for child windows.

0 comments on commit 66109aa

Please sign in to comment.