wxWidgets/utils/screenshotgen
Vadim Zeitlin ec091c9f2b Don't override CFLAGS etc in configure-generated makefile
CPPFLAGS, CFLAGS, CXXFLAGS and LDFLAGS are supposed to be under
user-control and putting configure-determined options in them broke
something as simple as running "make CXXFLAGS=-Wno-some-extra-warning"
because this overrode the CXXFLAGS set by configure and required for
build.

Improve this by using WX_*FLAGS in the generated makefile and leaving
the user-controlled FLAGS alone. This is still not ideal as running
"configure CFLAGS=-DFOO" and then "make CFLAGS=-DBAR" will define both
FOO and BAR, as configure copies CFLAGS to WX_CFLAGS, and so setting it
on make command line won't override it, as it should, but this should be
a much more rare and also much less severe problem, so we should be able
to live with it for now.

Normally this commit shouldn't result in any user-visible changes, i.e.
it shouldn't break any previously working scenarios and only make some
previously broken ones work.
2020-02-11 23:19:31 +01:00
..
src Don't override CFLAGS etc in configure-generated makefile 2020-02-11 23:19:31 +01:00
Makefile.in
README.txt

 wxWidgets Controls Screenshot Generator
 =======================================

 Author: Utensil Candel (Email: UtensilCandel at GMail dot com)
 Licence: wxWindows licence

 Thanks: Francesco Montorsi, Bryan Petty, Auria, Jorg and wxForum

 This utility is developed to automatically generate screenshots of the wxWidgets
 controls for use in wxWidgets documentation.

 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.


===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) Finally 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().