Qt Tools for Android Studio

Overview

What you need to know about the Qt Tools for Android Studio 3.0.0 plugin:

Features

With the plugin, you can:

Supported configurations

You can find the host OS, IDE, and Android SDK versions supported here.

Host environments

The plugin has been tested only with supported Android Studio versions on the following operating systems:

• Linux (Ubuntu 22.04)
• Windows (10, 11)
• macOS ARM (Xcode version 15.2)

Android Studio

Android Studio Hedgehog (2023.1.1) to Koala (2024.1.1) is supported.

Licensing

This plugin is covered by the Qt Community Edition license.

Attributions

The plugin may contain third-party modules under the following permissive licenses:

Getting started

The following sections cover installing the plugin, importing an example Qt for Android project, building and running the project on a target device.

Installing dependencies

The dependencies are Android Studio and the Qt Gradle Plugin.

Install Android Studio and the plugin

This plugin is installed like any other IntelliJ plugin: using the Plugins pane or manually downloading the plugin. Here's how you can manually download and install the plugin.

1. Download and install a compatible version.
2. Head to the plugin's IntelliJ marketplace page to download the plugin's jar file.
3. Start Android Studio.
4. On top-right corner select Settings(gear-icon)->Install Plugins From Disk

   

5. Select file and select OK.

   

6. Check that the plugin is installed.

   

Configure the plugin

Follow the configuration instructions in the Qt Gradle Plugin's documentation. Take note of your Qt install path, as you will need it when configuring your QML for Android projects in Android Studio.

Running the example

Test your development setup by running the examples shipped with the Qt installation. You'll need to know your Qt folder path first. When using the Qt Online Installer, the default install locations for the Qt folder are:

• Windows: C:/Qt
• macOS: ~/Qt
• Linux: ~/Qt

The example projects are located under your Qt installation directory in Qt/Examples/<qt version>/platforms/android/. To test the examples:

1. From Android Studio's welcome screen, select Open.

   

2. Select the Qt project example you want.

   

Compiling and deploying to a target device or emulator

1. First, you need to select Sync. You'll need to be online for this step the first time, as this downloads the needed Gradle plugin dependencies.
2. To compile and deploy, select Run.

   

   The build button builds the QML and Android projects and runs the resulting packages.

Debugging

Debugging QML or C is not possible with the plugin. See Qt Creator for debugging options.

Writing your first application from scratch

1. Open an existing Android Studio project or create a new one.
2. From Android Studio top-left select File -> New -> New Qt Project.

   

3. Set the name for the project, select the projects folder, select the Qt version and select OK.

   

   This creates four initial files for the project in a folder with the name you specified for your project.

   • The CMakeLists.txt project file.
   • The main.cpp file.
   • The Main.qml file.
   • A .gitignore file, to ignore any files within a future build directory.
4. The plugin will now provide you with a code snippet to copy and paste into the app/build.gradle file of your Android project.

   

5. Once you have done that, press Sync, and your QML project will appear in your Android project tree.

   

6. Start writing your first Qt QML application!

If you are a returning user or just getting started with QML, the QML Reference has what you need.

Integrating QML in an Android application

See the QML for Android overview for information on embedding QML in Android applications.