Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Initial widget docs #2333

Open
wants to merge 4 commits into
base: dev
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added docs/source/images/widgets/dashboard.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/source/images/widgets/disassembly.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/source/images/widgets/graph.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/source/images/widgets/hexdump.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/source/images/widgets/search.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/source/images/widgets/strings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/source/user-docs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ The documentation for users is still on its early stages and will be improved ov
:titlesonly:
:glob:

user-docs/widgets
user-docs/shortcuts
user-docs/command-line
user-docs/menus
Expand Down
40 changes: 40 additions & 0 deletions docs/source/user-docs/widgets.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
Widgets
=======

Cutter UI consists of several widgets (views) such as Disassembly, Decompiler, and Hexdump.
These widgets provide their own functionality, context menus and synchronization with
other widgets to help users get all sorts of analyses done conveniently and quickly.

These are some of the widgets you can find in Cutter:



Dashboard Widget
------------------

.. image:: ../images/widgets/dashboard.png

Disassembly Widget
------------------

.. image:: ../images/widgets/disassembly.gif

Graph Widget
------------------

.. image:: ../images/widgets/graph.gif

HexDump Widget
------------------

.. image:: ../images/widgets/hexdump.gif

Search Widget
------------------

.. image:: ../images/widgets/search.png

Strings Widget
------------------

.. image:: ../images/widgets/strings.png