Look up wxWidgets API in Emacs by using local html manual
Emacs Lisp Shell
Switch branches/tags
Nothing to show
Latest commit 18d51c5 Feb 17, 2014 @redguardtoo require w3m
Failed to load latest commit information.


wxwidgets-help (version 0.0.4)

Look up wxWidgets API in its html manual which is produced by doxygen.

w3m (the command line application and emacs plugin) is required.


wxwidgets-help is already uploaded to http://marmalade-repo.org/. So the best way to install it is through Emacs package manager.

Set up

Step 1, set environment variable WXWIN or WXWIDGETS to directory of wxWidgets.

For example, add one line into your ~/.bashrc,

export WXWIN=$HOME/wxWidgets-master
# or
export WXWIDGETS=$HOME/wxWidgets-master

Step 2, create html manual from wxWidgets source.

sudo apt-get install doxygen graphviz # if you use ubuntu/debian
cd $WXWIN/docs/doxygen;WX_SKIP_DOXYGEN_VERSION_CHECK=1 ./regen.sh html

How to use it

Move the focus on any keyword you want to look up and then “M-x wxhelp-browse-class-or-api”.

BTW, the keyword is copied to the clipboard automatically.

Contact me

You can report bugs at https://github.com/redguardtoo/wxwidgets-help. My email is <chenbin DOT sh AT gmail>.


Copyright (C) 2014 Chen Bin

Author: Chen Bin <chenbin DOT sh AT gmail> Keywords: wxWidgets C++

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.