examples: add basic widgets example

Cargo.toml

@@ -16,6 +16,7 @@ members = [
     "examples/demo_threading/rust",
     "examples/qml_features/rust",
     "examples/qml_minimal/rust",
+    "examples/widgets_minimal",
 
     "tests/basic_cxx_only/rust",
     "tests/basic_cxx_qt/rust",

crates/cxx-qt-lib-extras/build.rs

@@ -57,6 +57,7 @@ fn main() {
         "core/qcommandlineoption",
         "core/qcommandlineparser",
         "gui/qapplication",
+        "gui/qpushbutton",
     ];
 
     for rust_source in &rust_bridges {
@@ -68,6 +69,7 @@ fn main() {
         "core/qcommandlineoption",
         "core/qcommandlineparser",
         "gui/qapplication",
+        "gui/qpushbutton",
     ];
 
     builder = builder.cc_builder(move |cc| {

crates/cxx-qt-lib-extras/include/gui/qpushbutton.h

@@ -0,0 +1,10 @@
+// clang-format off
+// SPDX-FileCopyrightText: 2023 Klarälvdalens Datakonsult AB, a KDAB Group company <[email protected]>
+// clang-format on
+// SPDX-FileContributor: Andrew Hayzen <[email protected]>
+//
+// SPDX-License-Identifier: MIT OR Apache-2.0
+
+#pragma once
+
+#include <QtWidgets/QPushButton>

crates/cxx-qt-lib-extras/src/gui/mod.rs

@@ -5,3 +5,6 @@
 
 mod qapplication;
 pub use qapplication::QApplication;
+
+mod qpushbutton;
+pub use qpushbutton::QPushButton;

crates/cxx-qt-lib-extras/src/gui/qpushbutton.cpp

@@ -0,0 +1,8 @@
+// clang-format off
+// SPDX-FileCopyrightText: 2024 Klarälvdalens Datakonsult AB, a KDAB Group company <[email protected]>
+// clang-format on
+// SPDX-FileContributor: Andrew Hayzen <[email protected]>
+//
+// SPDX-License-Identifier: MIT OR Apache-2.0
+
+#include "cxx-qt-lib-extras/qpushbutton.h"

crates/cxx-qt-lib-extras/src/gui/qpushbutton.rs

@@ -0,0 +1,53 @@
+// SPDX-FileCopyrightText: 2024 Klarälvdalens Datakonsult AB, a KDAB Group company <[email protected]>
+// SPDX-FileContributor: Andrew Hayzen <[email protected]>
+//
+// SPDX-License-Identifier: MIT OR Apache-2.0
+
+#[cxx_qt::bridge]
+mod ffi {
+    unsafe extern "C++" {
+        include!("cxx-qt-lib/qstring.h");
+        type QString = cxx_qt_lib::QString;
+    }
+
+    unsafe extern "C++Qt" {
+        include!("cxx-qt-lib-extras/qpushbutton.h");
+
+        #[qobject]
+        type QPushButton;
+
+        // TODO: we should use upcasting methods here and implement QAbstractButton and QWidget
+        // so that we don't need to duplicate all of the methods
+
+        /// This signal is emitted when the button is activated (i.e., pressed down then released while the mouse cursor is inside the button)
+        #[qsignal]
+        fn clicked(self: Pin<&mut QPushButton>, checked: bool);
+
+        /// Set the text shown on the button
+        #[rust_name = "set_text"]
+        fn setText(self: Pin<&mut QPushButton>, text: &QString);
+
+        /// Shows the widget and its child widgets.
+        fn show(self: Pin<&mut QPushButton>);
+    }
+
+    #[namespace = "rust::cxxqtlib1"]
+    unsafe extern "C++Qt" {
+        include!("cxx-qt-lib/common.h");
+
+        #[doc(hidden)]
+        #[rust_name = "qpushbutton_init_default"]
+        fn make_unique() -> UniquePtr<QPushButton>;
+    }
+}
+
+impl ffi::QPushButton {
+    // TODO: we need to think about how ownership in widgets is going to work
+    // as for items like QPushButton you may have a parent and have that
+    // free the object and not when the unique ptr goes out of scope
+    pub fn new() -> cxx::UniquePtr<Self> {
+        ffi::qpushbutton_init_default()
+    }
+}
+
+pub use ffi::QPushButton;

examples/widgets_minimal/Cargo.toml

@@ -0,0 +1,26 @@
+# SPDX-FileCopyrightText: 2024 Klarälvdalens Datakonsult AB, a KDAB Group company <[email protected]>
+# SPDX-FileContributor: Andrew Hayzen <[email protected]>
+#
+# SPDX-License-Identifier: MIT OR Apache-2.0
+
+[package]
+name = "widgets-minimal-no-cmake"
+version = "0.1.0"
+authors = [
+  "Andrew Hayzen <[email protected]>",
+  "Be Wilson <[email protected]>",
+  "Gerhard de Clercq <[email protected]>",
+  "Leon Matthes <[email protected]>"
+]
+edition = "2021"
+license = "MIT OR Apache-2.0"
+
+[dependencies]
+cxx.workspace = true
+cxx-qt.workspace = true
+cxx-qt-lib.workspace = true
+cxx-qt-lib-extras.workspace = true
+
+[build-dependencies]
+# The link_qt_object_files feature is required for statically linking Qt 6.
+cxx-qt-build = { workspace = true, features = [ "link_qt_object_files" ] }

examples/widgets_minimal/build.rs

@@ -0,0 +1,13 @@
+// SPDX-FileCopyrightText: 2024 Klarälvdalens Datakonsult AB, a KDAB Group company <[email protected]>
+// SPDX-FileContributor: Andrew Hayzen <[email protected]>
+//
+// SPDX-License-Identifier: MIT OR Apache-2.0
+
+use cxx_qt_build::CxxQtBuilder;
+
+fn main() {
+    CxxQtBuilder::new()
+        // Link Qt's Network library
+        .qt_module("Network")
+        .build();
+}

examples/widgets_minimal/src/main.rs

@@ -0,0 +1,35 @@
+// SPDX-FileCopyrightText: 2024 Klarälvdalens Datakonsult AB, a KDAB Group company <[email protected]>
+// SPDX-FileContributor: Andrew Hayzen <[email protected]>
+//
+// SPDX-License-Identifier: MIT OR Apache-2.0
+
+//! This example provides demostrations of building a Qt Widgets CXX-Qt application
+
+use cxx_qt_lib::QString;
+use cxx_qt_lib_extras::{QApplication, QPushButton};
+
+fn main() {
+    let mut app = QApplication::new();
+
+    // TODO: we should really pass a parent in here
+    let mut push_button = QPushButton::new();
+
+    if let Some(mut push_button) = push_button.as_mut() {
+        push_button
+            .as_mut()
+            .set_text(&QString::from("Hello World!"));
+
+        push_button
+            .as_mut()
+            .on_clicked(|_, _| {
+                println!("Button Clicked!");
+            })
+            .release();
+
+        push_button.show();
+    }
+
+    if let Some(app) = app.as_mut() {
+        app.exec();
+    }
+}