mirror of
https://github.com/audacity/wxWidgets.git
synced 2025-12-10 19:37:18 -06:00
Integrate QT documentation into doxygen
This commit is contained in:
Tobias Taschner
parent
f8460059cd
commit
141b5bdf0f
@ -296,6 +296,7 @@ INPUT = mainpages \
|
||||
../ios \
|
||||
../msw \
|
||||
../osx \
|
||||
../qt \
|
||||
../../interface
|
||||
INPUT_ENCODING = UTF-8
|
||||
FILE_PATTERNS = *.h *.md
|
||||
|
||||
@ -167,7 +167,9 @@ wxWindowBase::GetDefaultBorder(), returning wxBORDER_NONE.
|
||||
|
||||
wxQt is a port of wxWidgets using Qt libraries. It requires Qt 5 or later.
|
||||
|
||||
For further information, please see the files in docs/qt in the distribution.
|
||||
@subpage plat_qt_install "Build Instructions"
|
||||
|
||||
@subpage plat_qt_architecture "Architecture Overview"
|
||||
|
||||
@section page_port_wxiOS wxiOS
|
||||
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
# wxQt Architecture
|
||||
# wxQt Architecture {#plat_qt_architecture}
|
||||
|
||||
## Internals
|
||||
|
||||
|
||||
@ -1,6 +1,8 @@
|
||||
wxWidgets for Qt installation
|
||||
wxWidgets for Qt installation {#plat_qt_install}
|
||||
-----------------------------
|
||||
|
||||
[TOC]
|
||||
|
||||
IMPORTANT NOTE:
|
||||
|
||||
If you experience problems installing, please re-read these
|
||||
@ -13,19 +15,23 @@ IMPORTANT NOTE:
|
||||
using (including the beta) and what compiler on what system. One
|
||||
example: wxQt 3.1.0, GCC 4.8.1, Ubuntu 14.04
|
||||
|
||||
* The simplest case
|
||||
Installation {#qt_install}
|
||||
============
|
||||
|
||||
The simplest case {#qt_simple}
|
||||
-------------------
|
||||
|
||||
If you compile wxWidgets on Linux for the first time and don't like to read
|
||||
install instructions just do (in the base dir):
|
||||
|
||||
> mkdir buildqt
|
||||
> cd buildqt
|
||||
> ../configure --with-qt
|
||||
> make
|
||||
> su <type root password>
|
||||
> make install
|
||||
> ldconfig
|
||||
> mkdir buildqt
|
||||
> cd buildqt
|
||||
> ../configure --with-qt
|
||||
> make
|
||||
> su <type root password>
|
||||
> make install
|
||||
> ldconfig
|
||||
|
||||
[if you get "ldconfig: command not found", try using "/sbin/ldconfig"]
|
||||
|
||||
If you don't do the 'make install' part, you can still use the libraries from
|
||||
@ -33,11 +39,11 @@ the buildgtk directory, but they may not be available to other users.
|
||||
|
||||
If you want to remove wxWidgets on Unix you can do this:
|
||||
|
||||
> su <type root password>
|
||||
> make uninstall
|
||||
> ldconfig
|
||||
> su <type root password>
|
||||
> make uninstall
|
||||
> ldconfig
|
||||
|
||||
* The simplest errors
|
||||
The simplest errors {#qt_error_simple}
|
||||
---------------------
|
||||
|
||||
For any configure errors: please look at config.log file which was generated
|
||||
@ -52,20 +58,20 @@ qtconfig/pkg-config. Also check that your LD_LIBRARY_PATH or equivalent
|
||||
variable contains the path to Qt libraries if they were installed in a
|
||||
non-default location.
|
||||
|
||||
* The simplest program
|
||||
The simplest program {#qt_simple_app}
|
||||
----------------------
|
||||
|
||||
Now create your super-application myfoo.cpp and compile anywhere with
|
||||
|
||||
g++ myfoo.cpp `wx-config --libs --cxxflags` -o myfoo
|
||||
g++ myfoo.cpp `wx-config --libs --cxxflags` -o myfoo
|
||||
|
||||
* GUI libraries
|
||||
GUI libraries {#qt_libs_ui}
|
||||
---------------
|
||||
|
||||
wxWidgets/Qt requires the Qt library to be installed on your system. It has
|
||||
to be a stable version, preferably Qt 5.2.1 or later.
|
||||
|
||||
* Building wxQT on Ubuntu
|
||||
Building wxQT on Ubuntu {#qt_build_ubuntu}
|
||||
-------------------------
|
||||
|
||||
Install latest Qt5 packages (qt5-default). To build unit tests, libcppunit-dev
|
||||
@ -77,21 +83,21 @@ libgstreamer-plugins-base0.10-dev)
|
||||
|
||||
Then create a build directory, configure and compile:
|
||||
|
||||
mkdir bldqt5
|
||||
cd bldqt5
|
||||
../configure --with-qt --enable-debug
|
||||
make
|
||||
make samples
|
||||
mkdir bldqt5
|
||||
cd bldqt5
|
||||
../configure --with-qt --enable-debug
|
||||
make
|
||||
make samples
|
||||
|
||||
If everything is ok, you can do the make install as specified before.
|
||||
|
||||
Optionally, you can build and run Unit Tests:
|
||||
|
||||
cd tests
|
||||
make
|
||||
./test_gui
|
||||
cd tests
|
||||
make
|
||||
./test_gui
|
||||
|
||||
* Building wxQT, using qt-unified-XXX-online installer
|
||||
Building wxQT, using qt-unified-XXX-online installer {#qt_build}
|
||||
------------------------------------------------------
|
||||
|
||||
Download qt-unified-XXX-online installer from the qt website.
|
||||
@ -100,30 +106,32 @@ restriction as above).
|
||||
The same build instructions apply, except that you need to explicitly pass
|
||||
to configure the Qt dir of the build intended to use as QT5_CUSTOM_DIR, i.e.
|
||||
|
||||
# for Linux:
|
||||
../configure --with-qt --enable-debug QT5_CUSTOM_DIR=~/Qt/5.11.0/gcc_64
|
||||
for Linux:
|
||||
|
||||
# for Windows (ran from Git Bash, or any other Unix-like shell):
|
||||
# (the syntax for the drive in the path is required by ar and ld)
|
||||
../configure --with-qt --enable-debug QT5_CUSTOM_DIR=c:/Qt/5.11.0/mingw53_32
|
||||
../configure --with-qt --enable-debug QT5_CUSTOM_DIR=~/Qt/5.11.0/gcc_64
|
||||
|
||||
* Building wxGT on Android
|
||||
for Windows (ran from Git Bash, or any other Unix-like shell):
|
||||
(the syntax for the drive in the path is required by ar and ld)
|
||||
|
||||
../configure --with-qt --enable-debug QT5_CUSTOM_DIR=c:/Qt/5.11.0/mingw53_32
|
||||
|
||||
Building wxGT on Android {#qt_android}
|
||||
--------------------------
|
||||
|
||||
Download Android Native Development Kit (NDK), tandalone Android Software
|
||||
Development Kit (SDK), install them and perform the following instructions to
|
||||
prepare the cross-compilation tool-chain to (change NDK and other paths):
|
||||
|
||||
NDK=~/src/android-ndk-r9d
|
||||
SDK=~/src/android-sdk-linux
|
||||
export ANDROID_NDK_ROOT=$NDK
|
||||
$NDK/build/tools/make-standalone-toolchain.sh \
|
||||
--toolchain=arm-linux-androideabi-4.8 --platform=android-9 \
|
||||
--install-dir=/tmp/ndk
|
||||
NDK=~/src/android-ndk-r9d
|
||||
SDK=~/src/android-sdk-linux
|
||||
export ANDROID_NDK_ROOT=$NDK
|
||||
$NDK/build/tools/make-standalone-toolchain.sh \
|
||||
--toolchain=arm-linux-androideabi-4.8 --platform=android-9 \
|
||||
--install-dir=/tmp/ndk
|
||||
|
||||
export PATH=/tmp/ndk/bin:$PATH
|
||||
export CC=arm-linux-androideabi-gcc
|
||||
export CXX=arm-linux-androideabi-g++
|
||||
export PATH=/tmp/ndk/bin:$PATH
|
||||
export CC=arm-linux-androideabi-gcc
|
||||
export CXX=arm-linux-androideabi-g++
|
||||
|
||||
|
||||
Also, you'll need to download the Qt library bundle that matches your operating
|
||||
@ -134,22 +142,23 @@ cross-compile for that architectures)
|
||||
Then, create a build directory (under the wxWidgets folder), configure for
|
||||
Andrid (disable currently unsupported/uneeded features) and run make:
|
||||
|
||||
cd ~/src/wxWidgets
|
||||
mkdir bldqt5droid
|
||||
cd bldqt5droid
|
||||
../configure --with-qt --enable-debug --build=x86_64-unknown-linux-gnu \
|
||||
--host=arm-linux-androideabi --disable-compat28 --disable-shared \
|
||||
--disable-arttango --enable-image --disable-dragimage --disable-sockets \
|
||||
--with-libtiff=no --without-opengl --disable-baseevtloop --disable-utf8
|
||||
make
|
||||
cd ~/src/wxWidgets
|
||||
mkdir bldqt5droid
|
||||
cd bldqt5droid
|
||||
../configure --with-qt --enable-debug --build=x86_64-unknown-linux-gnu \
|
||||
--host=arm-linux-androideabi --disable-compat28 --disable-shared \
|
||||
--disable-arttango --enable-image --disable-dragimage --disable-sockets \
|
||||
--with-libtiff=no --without-opengl --disable-baseevtloop --disable-utf8
|
||||
make
|
||||
|
||||
You can now compile and link your app against this build, and finally
|
||||
package it for Android using standard APK tools.
|
||||
|
||||
* Create your configuration
|
||||
Create your configuration {#qt_config}
|
||||
---------------------------
|
||||
|
||||
Usage:
|
||||
|
||||
./configure options
|
||||
|
||||
If you want to use system's C and C++ compiler,
|
||||
@ -168,7 +177,7 @@ subdirectory of your wxWidgets installation) as this allows you to
|
||||
have multiple configurations (for example, debug and release or GTK
|
||||
and Motif) simultaneously.
|
||||
|
||||
* Feature Options
|
||||
Feature Options {#qt_feature_options}
|
||||
-----------------
|
||||
|
||||
When producing an executable that is linked statically with wxQt
|
||||
@ -182,10 +191,3 @@ of all configurable options.
|
||||
Apart from disabling certain features you can very often "strip"
|
||||
the program of its debugging information resulting in a significant
|
||||
reduction in size.
|
||||
|
||||
----------------------
|
||||
|
||||
In the hope that it will be useful,
|
||||
|
||||
The wxWidgets Team
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user