2008-10-06 05:37:27 -04:00
|
|
|
|
|
|
|
|
wxWidgets Controls Screenshot Generator
|
|
|
|
|
=======================================
|
|
|
|
|
|
|
|
|
|
Author: Utensil Candel (Email: UtensilCandel at GMail dot com)
|
2010-07-13 09:29:13 -04:00
|
|
|
Licence: wxWindows licence
|
2008-10-06 05:37:27 -04:00
|
|
|
|
2009-01-08 09:28:55 -05:00
|
|
|
Thanks: Francesco Montorsi, Bryan Petty, Auria, Jorg and wxForum
|
2008-10-06 05:37:27 -04:00
|
|
|
|
2009-01-08 09:28:55 -05:00
|
|
|
This utility is developed to automatically generate screenshots of the wxWidgets
|
2008-10-06 05:37:27 -04:00
|
|
|
controls for use in wxWidgets documentation.
|
|
|
|
|
|
2009-01-08 09:28:55 -05:00
|
|
|
The main part of the GUI (guiframe.h/guiframe.cpp) was generated with wxFormBuilder
|
|
|
|
|
(http://wxformbuilder.org/), a powerful cross-platform open-source RAD tool. Now its
|
|
|
|
|
trace is removed so we can maintain the code without using it.
|
2008-10-06 05:37:27 -04:00
|
|
|
|
2009-01-08 09:28:55 -05:00
|
|
|
|
|
|
|
|
===User Guide: How To Use==
|
|
|
|
|
|
|
|
|
|
The screenshots will be generated under sub-directory "screenshots" silently.
|
|
|
|
|
Please monitor this folder before taking screenshots using "File->Open screenshots folder".
|
|
|
|
|
|
|
|
|
|
1) The menu "Capture->Full screen" can take a screeshot for the fullscreen. It's designed
|
|
|
|
|
for testing purpose only.
|
|
|
|
|
|
|
|
|
|
2) The menu "Capture->Regions<Begin>" and "Capture->Regions<End>" was the semi-auto part,
|
|
|
|
|
and now it's deprecated and will be removed soon.
|
|
|
|
|
|
|
|
|
|
3) Finnally the full-auto mode: "Capture->Capture All" or Ctrl+Alt+A, follow the instructions
|
|
|
|
|
and all the screenshots will be generated correctly under the subdirectory "screenshots".
|
|
|
|
|
|
|
|
|
|
==Developer Guide: How To Add More Controls==
|
|
|
|
|
|
|
|
|
|
(Coming soon)
|
|
|
|
|
|
|
|
|
|
==To-do List==
|
|
|
|
|
|
|
|
|
|
1) Remove wxAuiNoteBook related lagacy codes, which is no longer useful;
|
|
|
|
|
|
|
|
|
|
2) Refactor the GUI code, which was generated by wxFormBuilder, but it's messy for human to
|
|
|
|
|
maintain;
|
|
|
|
|
|
|
|
|
|
3) Remove the class CtrlMaskOut since semi-auto part of this utility is no longer needed.
|
|
|
|
|
|
|
|
|
|
4) Clearify the interface of class AutoCaptureMechanism and document how to add a new control
|
|
|
|
|
that needs to take screenshots, and how to adjust it to avoid bugs in wxRTTI system and
|
|
|
|
|
wxWindow::GetScreenRect();
|
|
|
|
|
|
|
|
|
|
5) Make this utility easier to configure;
|
|
|
|
|
|
|
|
|
|
6) Add test functionality to confirm bugs in wxRTTI system and wxWindow::GetScreenRect().
|
