From WxWiki
Jump to navigation Jump to search

Getting started


Currently, wxQT needs Qt 5 or later (recommended version is Qt 5.2.1). Other dependencies are needed depending on the features to be used (fo example cairo, opengl, jpg/tiff, etc.). For more information see docs/qt folder shipped with the source code, and/or Ubuntu / Android notes.

Building the Library

Note: "Google Summer of Code 2014" and previous wxQt branch was merged to master trunk!

Go to your development directory and download the source code zip archive or checkout the (current repository) with:

git clone https://github.com/wxWidgets/wxWidgets.git
cd wxWidgets

Now create the build directory e.g.: 'bldqt5' and from it call the configure script (using Qt option) and run make to start the compilation process:

mkdir bldqt5
cd bldqt5
../configure --with-qt --enable-debug

Alternatively, If you can use cmake to generate the build scripts using the following command:

mkdir bldqt5
cd bldqt5
export CMAKE_PREFIX_PATH=<path to QT installation> 
cmake ../wxWidgets -DwxBUILD_TOOLKIT=qt -G "Unix Makefiles"

You can specify your preferred cmake generator with -G.

Building Samples, Tests and Demos

After successful build, you can go to the samples sub-directory, compile and run them, for example:

cd samples/controls

You can also try the tests and demos sub-directories.

Port status

Unit Tests results

Pass Fail Error Total
378 155 18 551
68% 28% 4% 100%
Status: experimental


A table attempting to summarize progress in the port can be found at WxQt/Status.

Summary of features running (see bellow caveats and known issues):

  • Application, event loop (limited), FD/Socket monitoring, etc.
  • Most core controls: wxButton, wxBitmapButton, wxToggleButton, wxChoice, wxComboBox, wxTextCtrl, wxStaticText, wxStaticBox, wxStaticBitmap, wxRadioBox, wxCheckBox, wxGauge, wxSlider, wxSpinCtrl, wxNotebook, etc.
  • Some advanced controls: wxCalendar, wxListCtrl, wxTreeCtrl, wxGrid.
  • Top Level Windows: wxFrame (wxMenuBar, wxStatusBar, wxToolBar), wxDialog and common dialogs and wizards
  • AUI (limited)
  • Cairo graphic renderer (limited, not using cairo qt surface)
  • OpenGL (limited, some drawing issues)

General interface is almost 100% complete, at least for wxPython, as it compiles all classes (701 SIP cpp files, except wxHTML2 that is not implemented). See Phoenix notes for more information.

Known Open Issues

Although simple apps works, there are some problems that will affect more complex applications in the near term:

  • Complex painting is failing "mysteriously" in some situations (see clipping problems notes). Also, still there are many Qt warning about QPainter used incorrectly (most of them should not happen, there could be wrong logic about scroll areas or center widget where Qt painting is not direct / orthogonal to wx use cases). wxRichTextCtrl is the leading case here.
  • Mouse capture seems not to be working correctly, and that may be causing some issues in controls like wxHTMLWindow, wxHyperlinkCtrl, AUI, etc. There seems that some semantics are very different between wxWidgets and Qt about mouse movements events (see mouseTracking QWidget attribute). It is somewhat strange as some other samples relating mouse work (for example, MDI tiny doodling).
  • Nested Event Loop implementation is not optimal, as it is doing some kind of busy waiting. It could be enhanced with QEventLoop but didn't work, in fact it get worse: for example, the app no longer exits and some dialogs get blocked, test_gui never ends anymore, etc. Maybe the event loop could be refactorized with QAbstractEventDispatcher to join more tightly both wx and Qt event queues (the docs says there is an example for motif). NOTE that this doesn't affect main application event loop nor modal dialogs, only wxExecute.

Also, there are still some important features like webview (webkit), printing, drag and drop, data view control, native renderer, etc. that aren't implementated. Many of them should be easily achievable (at least webkit, following wxGTK work).


Developers can be contacted on the developer mailing list (not everyone could be active by now):

  • Mariano Reingart (GSoC 2014 developer)
  • Sean D'Epagnier (2014 contributor)
  • Javier Torres (GSoC 2010 developer)
  • Kolya Kosenko (2010, calendar and other contributions)
  • Peter Most (original developer)