projects / wxWidgets.git / blame
| Commit | Line | Data |
|---|---|---|
| 0d5eda9c FM |
1 | |
| 2 | wxWidgets Controls Screenshot Generator | |
| 3 | ======================================= | |
| 4 | ||
| 5 | Author: Utensil Candel (Email: UtensilCandel at GMail dot com) | |
| 6 | Licence: wxWidgets Licence | |
| 7 | ||
| 51d48751 | 8 | Thanks: Francesco Montorsi, Bryan Petty, Auria, Jorg and wxForum |
| 0d5eda9c | 9 | |
| 51d48751 | 10 | This utility is developed to automatically generate screenshots of the wxWidgets |
| 0d5eda9c FM |
11 | controls for use in wxWidgets documentation. |
| 12 | ||
| 51d48751 FM |
13 | The main part of the GUI (guiframe.h/guiframe.cpp) was generated with wxFormBuilder |
| 14 | (http://wxformbuilder.org/), a powerful cross-platform open-source RAD tool. Now its | |
| 15 | trace is removed so we can maintain the code without using it. | |
| 0d5eda9c | 16 | |
| 51d48751 FM |
17 | |
| 18 | ===User Guide: How To Use== | |
| 19 | ||
| 20 | The screenshots will be generated under sub-directory "screenshots" silently. | |
| 21 | Please monitor this folder before taking screenshots using "File->Open screenshots folder". | |
| 22 | ||
| 23 | 1) The menu "Capture->Full screen" can take a screeshot for the fullscreen. It's designed | |
| 24 | for testing purpose only. | |
| 25 | ||
| 26 | 2) The menu "Capture->Regions<Begin>" and "Capture->Regions<End>" was the semi-auto part, | |
| 27 | and now it's deprecated and will be removed soon. | |
| 28 | ||
| 29 | 3) Finnally the full-auto mode: "Capture->Capture All" or Ctrl+Alt+A, follow the instructions | |
| 30 | and all the screenshots will be generated correctly under the subdirectory "screenshots". | |
| 31 | ||
| 32 | ==Developer Guide: How To Add More Controls== | |
| 33 | ||
| 34 | (Coming soon) | |
| 35 | ||
| 36 | ==To-do List== | |
| 37 | ||
| 38 | 1) Remove wxAuiNoteBook related lagacy codes, which is no longer useful; | |
| 39 | ||
| 40 | 2) Refactor the GUI code, which was generated by wxFormBuilder, but it's messy for human to | |
| 41 | maintain; | |
| 42 | ||
| 43 | 3) Remove the class CtrlMaskOut since semi-auto part of this utility is no longer needed. | |
| 44 | ||
| 45 | 4) Clearify the interface of class AutoCaptureMechanism and document how to add a new control | |
| 46 | that needs to take screenshots, and how to adjust it to avoid bugs in wxRTTI system and | |
| 47 | wxWindow::GetScreenRect(); | |
| 48 | ||
| 49 | 5) Make this utility easier to configure; | |
| 50 | ||
| 51 | 6) Add test functionality to confirm bugs in wxRTTI system and wxWindow::GetScreenRect(). |