How to Use QPushButton: Difference between revisions
(Corrected Layout after Wiki Conversion) |
m (misc cleanup) |
||
(10 intermediate revisions by 6 users not shown) | |||
Line 1: | Line 1: | ||
{{LangSwitch}} | |||
[[Category:HowTo]] | [[Category:HowTo]] | ||
[[Category:Snippets]] | [[Category:Snippets]] | ||
[[Category:Tutorial]] | [[Category:Tutorial]] | ||
== Overview == | == Overview == | ||
Using | Using {{DocLink|QPushButton}} developers can create and handle buttons. This class is easy to use and customize so it is among the most useful classes in Qt. In general the button displays text but an icon can also be displayed. | ||
QPushButton inherits | QPushButton inherits {{DocLink|QAbstractButton}} which in turn inherits {{DocLink|QWidget}}. | ||
== Signals == | == Signals == | ||
Line 19: | Line 13: | ||
=== Inherited from QAbstractButton === | === Inherited from QAbstractButton === | ||
* <tt>void clicked ( bool checked = false )</tt> | * <tt>void clicked(bool checked = false)</tt> | ||
* <tt>void pressed ()</tt> | * <tt>void pressed()</tt> | ||
* <tt>void released ()</tt> | * <tt>void released()</tt> | ||
* <tt>void toggled ( bool checked )</tt> | * <tt>void toggled(bool checked)</tt> | ||
=== Inherited from QWidget === | === Inherited from QWidget === | ||
* <tt>void customContextMenuRequested ( const QPoint &pos )</tt> | * <tt>void customContextMenuRequested(const QPoint &pos)</tt> | ||
=== Inherited from QObject === | === Inherited from QObject === | ||
* <tt>void destroyed ( QObject * obj = | * <tt>void destroyed(QObject *obj = nullptr)</tt> | ||
== Basic Usage == | == Basic Usage == | ||
Line 36: | Line 30: | ||
=== Text === | === Text === | ||
The text of QPushButton can be set upon creation or using <tt>setText()</tt>. To get the current text of the button use <tt>text()</tt>. | The text of QPushButton can be set upon creation or using <tt>[http://doc.qt.io/qt-5/qabstractbutton.html#text-prop setText()]</tt>. To get the current text of the button use <tt>[http://doc.qt.io/qt-5/qabstractbutton.html#text-prop text()]</tt>. | ||
=== Icon === | === Icon === | ||
The icon of QPushButton can also be set upon creation. After creation the icon can be changed using <tt>setIcon()</tt> To get the current icon of the button use <tt>icon()</tt> | The icon of QPushButton can also be set upon creation. After creation the icon can be changed using <tt>[http://doc.qt.io/qt-5/qabstractbutton.html#icon-prop setIcon()]</tt> To get the current icon of the button use <tt>[http://doc.qt.io/qt-5/qabstractbutton.html#icon-prop icon()]</tt> | ||
=== Set Position and Size === | === Set Position and Size === | ||
To set the position and the size of the button use <tt>setGeometry()</tt>. If you want just to modify the size of the button use <tt>resize()</tt> | To set the position and the size of the button use <tt>[http://doc.qt.io/qt-5/qwidget.html#geometry-prop setGeometry()]</tt>. If you want just to modify the size of the button use <tt>[http://doc.qt.io/qt-5/qwidget.html#geometry-prop resize()]</tt> | ||
=== Handle Button === | === Handle Button === | ||
Line 51: | Line 45: | ||
<code> | <code> | ||
connect(m_button, | connect(m_button, &QPushButton::released, this, &MainWindow::handleButton);</code> | ||
</code> | |||
== Example == | == Example == | ||
Line 59: | Line 52: | ||
An instance of QPushButton is created. Signal <tt>released()</tt> is connected to slot <tt>handleButton()</tt> which changes the text and the size of the button. | An instance of QPushButton is created. Signal <tt>released()</tt> is connected to slot <tt>handleButton()</tt> which changes the text and the size of the button. | ||
To build and run the example: | |||
# Create an empty folder | |||
# Create a file for each of the below code snippets and add the example code to them (the name of the file should match the name above the snippet). | |||
#* All 4 files must be in the same folder. | |||
# Using command line, navigate into the folder with the 4 files. | |||
# run qmake on the project file: <code>qmake PushButtonExample.pro</code> | |||
#* If successful it will not print any output. | |||
#* This should create a file with the name <tt>Makefile</tt> in the folder. | |||
# Build the application: <code>make</code> | |||
#* The application should compile without any issues. | |||
# Run the application: <code>./PushButtonExample</code> | |||
The above steps are for linux but can easily be followed on other systems by replacing <tt>make</tt> with the correct make call for the system. | |||
=== mainwindow.h === | === mainwindow.h === | ||
<nowiki> | |||
< | |||
#ifndef MAINWINDOW_H | #ifndef MAINWINDOW_H | ||
#define MAINWINDOW_H | #define MAINWINDOW_H | ||
#include < | #include <QMainWindow> | ||
#include < | #include <QPushButton> | ||
namespace Ui { | namespace Ui { | ||
class MainWindow; | |||
} | } | ||
class MainWindow : public QMainWindow | class MainWindow : public QMainWindow | ||
{ | { | ||
Q_OBJECT | |||
public: | public: | ||
explicit MainWindow(QWidget *parent = nullptr); | |||
private slots: | private slots: | ||
void handleButton(); | |||
private: | private: | ||
QPushButton *m_button; | |||
}; | }; | ||
#endif // MAINWINDOW_H | #endif // MAINWINDOW_H | ||
</ | </nowiki> | ||
=== mainwindow.cpp === | === mainwindow.cpp === | ||
<nowiki> | |||
< | |||
#include "mainwindow.h" | #include "mainwindow.h" | ||
MainWindow::MainWindow(QWidget *parent) | MainWindow::MainWindow(QWidget *parent) | ||
: QMainWindow(parent) | |||
{ | { | ||
// Create the button, make "this" the parent | |||
m_button = new QPushButton("My Button", this); | |||
// set size and location of the button | |||
m_button->setGeometry(QRect(QPoint(100, 100), QSize(200, 50))); | |||
// Connect button signal to appropriate slot | |||
// Connect button signal to appropriate slot | connect(m_button, &QPushButton::released, this, &MainWindow::handleButton); | ||
} | } | ||
void MainWindow::handleButton() | void MainWindow::handleButton() | ||
{ | { | ||
// change the text | |||
m_button->setText("Example"); | |||
// resize button | |||
m_button->resize(100,100); | |||
} | } | ||
</ | </nowiki> | ||
=== main.cpp === | === main.cpp === | ||
<nowiki> | |||
< | |||
#include "mainwindow.h" | #include "mainwindow.h" | ||
#include <QApplication> | |||
int main(int argc, char *argv[]) | |||
int main(int argc, char *argv[]) | |||
{ | { | ||
QApplication app(argc, argv); | |||
MainWindow mainWindow; | |||
mainWindow.showMaximized(); | |||
return app.exec(); | |||
} | |||
</nowiki> | |||
=== PushButtonExample.pro === | |||
<nowiki> | |||
QT += core widgets | |||
TARGET = PushButtonExample | |||
</ | TEMPLATE = app | ||
SOURCES += main.cpp mainwindow.cpp | |||
HEADERS += mainwindow.h | |||
</nowiki> |
Latest revision as of 16:12, 29 November 2020
Overview
Using QPushButton developers can create and handle buttons. This class is easy to use and customize so it is among the most useful classes in Qt. In general the button displays text but an icon can also be displayed.
QPushButton inherits QAbstractButton which in turn inherits QWidget.
Signals
Inherited from QAbstractButton
- void clicked(bool checked = false)
- void pressed()
- void released()
- void toggled(bool checked)
Inherited from QWidget
- void customContextMenuRequested(const QPoint &pos)
Inherited from QObject
- void destroyed(QObject *obj = nullptr)
Basic Usage
Text
The text of QPushButton can be set upon creation or using setText(). To get the current text of the button use text().
Icon
The icon of QPushButton can also be set upon creation. After creation the icon can be changed using setIcon() To get the current icon of the button use icon()
Set Position and Size
To set the position and the size of the button use setGeometry(). If you want just to modify the size of the button use resize()
Handle Button
QPushButton emits signals if an event occurs. To handle the button connect its appropriate signal to a slot:
connect(m_button, &QPushButton::released, this, &MainWindow::handleButton);
Example
The following simple code snippet shows how to create and use QPushButton. It has been tested on Qt Symbian Simulator.
An instance of QPushButton is created. Signal released() is connected to slot handleButton() which changes the text and the size of the button.
To build and run the example:
- Create an empty folder
- Create a file for each of the below code snippets and add the example code to them (the name of the file should match the name above the snippet).
- All 4 files must be in the same folder.
- Using command line, navigate into the folder with the 4 files.
- run qmake on the project file:
qmake PushButtonExample.pro
- If successful it will not print any output.
- This should create a file with the name Makefile in the folder.
- Build the application:
make
- The application should compile without any issues.
- Run the application:
./PushButtonExample
The above steps are for linux but can easily be followed on other systems by replacing make with the correct make call for the system.
mainwindow.h
#ifndef MAINWINDOW_H #define MAINWINDOW_H #include <QMainWindow> #include <QPushButton> namespace Ui { class MainWindow; } class MainWindow : public QMainWindow { Q_OBJECT public: explicit MainWindow(QWidget *parent = nullptr); private slots: void handleButton(); private: QPushButton *m_button; }; #endif // MAINWINDOW_H
mainwindow.cpp
#include "mainwindow.h" MainWindow::MainWindow(QWidget *parent) : QMainWindow(parent) { // Create the button, make "this" the parent m_button = new QPushButton("My Button", this); // set size and location of the button m_button->setGeometry(QRect(QPoint(100, 100), QSize(200, 50))); // Connect button signal to appropriate slot connect(m_button, &QPushButton::released, this, &MainWindow::handleButton); } void MainWindow::handleButton() { // change the text m_button->setText("Example"); // resize button m_button->resize(100,100); }
main.cpp
#include "mainwindow.h" #include <QApplication> int main(int argc, char *argv[]) { QApplication app(argc, argv); MainWindow mainWindow; mainWindow.showMaximized(); return app.exec(); }
PushButtonExample.pro
QT += core widgets TARGET = PushButtonExample TEMPLATE = app SOURCES += main.cpp mainwindow.cpp HEADERS += mainwindow.h