]> git.saurik.com Git - wxWidgets.git/blame - docs/doxygen/mainpages/utilities.h
don't restore the focus manually after closing the dialog, default Windows behaviour...
[wxWidgets.git] / docs / doxygen / mainpages / utilities.h
CommitLineData
4514447c
FM
1/////////////////////////////////////////////////////////////////////////////
2// Name: utilities.h
3// Purpose: Utilities page of the Doxygen manual
4// Author: wxWidgets team
5// RCS-ID: $Id$
6// Licence: wxWindows license
7/////////////////////////////////////////////////////////////////////////////
8
880efa2a 9/**
4514447c 10
29f86fc1 11@page page_utils Included Utilities
4514447c 12
dc28cdf8
FM
13In addition to the wxWidgets libraries (see @ref page_libs), some utilities
14are available to the users in the @c utils hierarchy (even if some of them are
15explicitely coinceived for wxWidgets maintainance and will probably be of
16little use to others).
4514447c 17
dc28cdf8
FM
18Please note that these utilities do represent only the utilities developed
19and maintained by the wxWidgets team.
20There are lots of other user-contributed and user-maintained packages;
21see the wxWidgets download page: http://www.wxwidgets.org/downloads
22or directly http://wxcode.sourceforge.net or http://www.wxcommunity.com/ .
4514447c 23
dc28cdf8 24@li @ref page_utils_emulator
dc28cdf8
FM
25@li @ref page_utils_helpview
26@li @ref page_utils_hhp2cached
5934cda1 27@li @ref page_utils_ifacecheck
dc28cdf8 28@li @ref page_utils_wxrc
4514447c
FM
29
30
dc28cdf8 31<hr>
4514447c 32
4514447c 33
dc28cdf8 34@section page_utils_emulator Emulator
4514447c 35
dc28cdf8 36Xnest-based display emulator for X11-based PDA applications.
4514447c 37
dc28cdf8
FM
38<!-- On some systems, the Xnest window does not synchronise with the
39'skin' window. THIS ISN'T THE PLACE FOR THIS STATEMENT I THINK -->
4514447c 40
dc28cdf8 41This program can be found in @c utils/emulator.
4514447c 42
4514447c 43
5934cda1 44@section page_utils_helpview Help Viewer
4514447c 45
5934cda1
FM
46Helpview is a program for displaying wxWidgets HTML Help files.
47In many cases, you may wish to use the wxWidgets HTML
dc28cdf8
FM
48Help classes from within your application, but this provides a
49handy stand-alone viewer. See @ref overview_html for more details.
4514447c 50
dc28cdf8 51You can find Helpview in @c utils/helpview.
4514447c
FM
52
53
dc28cdf8 54@section page_utils_hhp2cached HHP2Cached
3c4f71cc 55
dc28cdf8
FM
56This utility creates a "cached" version of a @c .hhp file; using cached @c .hhp
57files in wxHtmlHelpController can drammatically improve the performances
58of the help viewer. See wxHtmlHelpController for more details.
3c4f71cc 59
0c1cc948 60You can find HHP2Cached in @c utils/hhp2cached.
3c4f71cc 61
3c4f71cc 62
5934cda1
FM
63@section page_utils_ifacecheck Interface checker
64
65This utility compares the wxWidgets real interface contained in the @c include
66hierarchy with the wxWidgets interface used for documentation purposes and
67kept in the @c interface hierarchy.
68
69Ifacecheck warns about incoherences (mainly wrong prototype signatures) and
70can even correct them automatically. It uses the XML outputs of the gccxml utility
71(see http://www.gccxml.org) and of the Doxygen utility (see http://www.doxygen.org)
72to do the comparisons.
73
21864ff2
FM
74It's explicitely designed for wxWidgets documentation needs and is probably of little
75use for anything else than wxWidgets docs reviewing.
76
5934cda1
FM
77You can find it in @c utils/ifacecheck.
78
79
5934cda1 80@section page_utils_wxrc wxWidgets XML Resource Compiler
3c4f71cc 81
dc28cdf8
FM
82This utility allows the user to compile @e binary versions of their XRC files,
83which are compressed and can be loaded faster than plain XRC files.
84See @ref overview_xrc for more info.
3c4f71cc 85
dc28cdf8 86You can find it under @c utils/wxrc.
3c4f71cc 87
4514447c 88*/
29f86fc1 89