An easy to install gem version of the Ruby bindings to Qt
C++ CMake Ruby C QMake Shell

README.md

qtbindings - Ruby bindings to QT

qtbindings Version qtbindings-qt Version

This project provides bindings that allow the QT Gui toolkit to be used from the Ruby Programming language. Overall it is a repackaging of a subset of the KDE bindings ruby and smoke systems into a format that lends itself well to packaging into a Ruby gem.

Goals

  1. To make it easy to install a Qt binding for Ruby on all platforms using RubyGems
  2. To maintain an up-to-date binary gem for Windows that is bundled with the latest version of Qt
  3. To reduce the scope and maintenance of the bindings to only bind to the libraries provided by the Qt SDK.
  4. To increase compatibility with non-linux platforms

Note: Qt 5.0 is currently NOT supported. For Ruby 1.9.3 you should use version 4.8.5.2. For Ruby 1.8.x you can try installing version 4.8.3.0, however upgrading Ruby is highly recommended.

Usage Notes

Ruby threading is now fully supported out of the box. All GUI access however must be done inside the main thread. To support updating the GUI using other threads, use the following function provided in Qt4.rb:

Qt.execute_in_main_thread do # block the main thread
  # GUI code which executes and then allows the main thread to execute
end

Qt.execute_in_main_thread(false) do # don't block the main thread
  # GUI code which executes in parallel with the main thread
end

To use Qt plugins (Reading jpgs, etc) on Windows, you should add this line after creating your Qt::Application.

Qt::Application.instance.addLibraryPath(Qt::PLUGIN_PATH)

Tested Environments

Mac OSX 10.9.1 (Mavericks) XCode 5 (clang) Brew - QT 4.8.6 CMake 2.8.9 Ruby 2.0.0p353 - Must be compiled with clang (rvm install --with-gcc=clang)

Windows 7 SP1 QT SDK 4.8.6-1 CMake 3.6.2 Ruby 2.1.9p490 installed from rubyinstaller.org Ruby 2.2.5p319 installed from rubyinstaller.org Ruby 2.3.1p112 installed from rubyinstaller.org

Ubuntu Linux 11.10 QT SDK 4.8.1 Cmake 2.8.5

Compiling

Compiling qtbindings requires the following prerequisites:

  1. Ruby (Ruby must be compiled with --enable-shared on all platforms and with --with-gcc=clang on OSX) On Windows use the latest from RubyInstaller You'll need both the 32bit and 64bit installers to make the fat binary gem On Windows get the DevKit from RubyInstaller You'll need both the 32bit and 64bit installers to make the fat binary gem
  2. CMake 3.6.x
  3. On Windows get OpenSSL 1.0.2 (not Light)
  4. QT 4.8.6 (mingw version for Windows) On Windows install to C:\Qt\4.8.6 (when installing specify the mingw inside the 32bit DevKit) On Windows install a second copy to C:\Qt\4.8.6-x64 (when installing specify the mingw inside the 64bit DevKit) Install Jom to C:\Qt\4.8.6-x64 (or anywhere in your path) Copy qtbindings/vendor/QtConfigureWin64.bat to C:\Qt\4.8.6-x64 and edit paths to match your system Run the batch file to configure the system (this takes several minutes) Type 'jom' to build (this takes a long time)
  5. gcc 4.x, 5.x, or 6.x (or clang for OSX 10.9) On Windows gcc 4.x is included in the DevKit

Note for OSX 10.9. The default compiler has changed from gcc to clang. All libraries need to be compiled with clang or you will get segfaults. This includes ruby, qt, and qtbindings. *** rvm does not compile with clang by default. You must add --with-gcc=clang when installing a version of ruby ***

Additionally: all of the operating system prequisites for compiling, window system development, opengl, etc must be installed.

Rakefile

Perform the following steps to build the gem on Unix or Mac:

  1. rake VERSION=4.8.x.y gem Where the x is the subversion of QT and y is the patch level of qtbindings

Perform the following steps to build the gem on Windows:

  1. cd vendor
  2. Run: BuildWindowsGems.bat

Note: The gem is built eight times to create two FAT binaries which will work on Ruby 2.0, 2.1, 2.2 and 2.3 (x64/x86).

After building the gem, verify the examples work by running:

  1. rake examples

Operating Systems Notes:

Debian Linux

  1. The following should get you the packages you need:
sudo aptitude install build-essential bison openssl libreadline5
  libreadline-dev curl git-core zlib1g zlib1g-dev libssl-dev vim
  libsqlite3-0 libsqlite3-dev sqlite3
  libxml2-dev git-core subversion autoconf xorg-dev libgl1-mesa-dev
  libglu1-mesa-dev

Fedora Linux

You will also need these packages:

sudo yum install qtwebkit-devel qtwebkit

Mac OSX Snow Leopard

  1. XCode
  2. Brew (http://mxcl.github.com/homebrew/) Install qt with brew install qt

Windows - Note: Only necessary for debugging (binary gem available)

Qt should be rebuilt using Devkit before building.

  1. Run vendor\PatchDevkit32.bat
  2. Run vendor\PatchDevkit64.bat
  3. Run vendor\PatchRuby20.bat
  4. Copy vendor\BuildQt4Win32.bat to C:\Qt\4.8.6 and run it
  5. Copy vendor\BuildQt4Win64.bat to C:\Qt\4.8.6-64 and run it

Install

On linux/MacOSX you must make sure you have all the necessary prerequisites installed or the compile will fail.

gem install qtbindings

This should always work flawlessly on Windows because everything is nicely packaged into a binary gem. However, the gem is very large ~90MB, so please be patient while gem downloads the file.

To get help: You can file tickets here at github for issues specific to the qtbindings gem.

License: This library is released under the LGPL Version 2.1. See COPYING.LIB.txt

Contributing: Fork the project and submit pull requests.

Disclaimer: Almost all of this code was written by the guys who worked on the KDE bindings project, particurly Arno Rehn and Richard Dale. I hope to increase the adoption and use of the code that they have written.