Difference between revisions of "Policies/API to Avoid"

Jump to: navigation, search
m (Text replace - "</code>" to "</syntaxhighlight>")
(Qt classes that have their KDE versions)
Line 5: Line 5:
 
=== Qt classes that have their KDE versions ===
 
=== Qt classes that have their KDE versions ===
 
KDE applications should not use Qt classes that have their KDE replacements. Examples include QFileDialog, QDialog, QMainWindow. KDE versions of these classes provide better integration with KDE.
 
KDE applications should not use Qt classes that have their KDE replacements. Examples include QFileDialog, QDialog, QMainWindow. KDE versions of these classes provide better integration with KDE.
 +
 +
Keep in mind however that classes in KDELibs4Support when building against frameworks are there to ease porting and are not recommended for new code. For example QLineEdit is preferred over KLineEdit. See [https://community.kde.org/Frameworks/Porting_Notes#Application Frameworks Porting Notes] for more details.
  
 
=== QSystemTrayIcon::showMessage() ===
 
=== QSystemTrayIcon::showMessage() ===

Revision as of 05:08, 11 October 2014

There are classes and functions that should be avoided in KDE applications, but KDE has no direct control over them (for example, they are part of Qt).

API that has KDE replacements

Qt classes that have their KDE versions

KDE applications should not use Qt classes that have their KDE replacements. Examples include QFileDialog, QDialog, QMainWindow. KDE versions of these classes provide better integration with KDE.

Keep in mind however that classes in KDELibs4Support when building against frameworks are there to ease porting and are not recommended for new code. For example QLineEdit is preferred over KLineEdit. See Frameworks Porting Notes for more details.

QSystemTrayIcon::showMessage()

Use KNotification for better KDE integration.

QHttp

QHttp does not respect desktop settings such as the user's proxy settings or resource restrictions. Always use KIO to access network resources.

API that is considered broken

QWidget::showFullScreen/Maximized/Minimized/Normal()

Try to avoid calls to QWidget::showFullScreen(), QWidget::showMaximized(), QWidget::showMinimized() and QWidget::showNormal(), use them only if you understand what they do and you really want that. These calls do not only change the relevant window state as most people expect, but they also have other effects. For example, showFullScreen() among other things also removes the maximized state (see bug #157941), the same way showNormal() is not an inverse call to showFullScreen().

Either use QWidget::setWindowState() in the following way

widget->setWindowState(widget->windowState() | Qt::WindowFullScreen); // set
widget->setWindowState(widget->windowState() & ~Qt::WindowFullScreen); // reset

or use KDE API - KToggleFullScreenAction has setFullScreen() helper function, and KWindowSystem has calls for changing window state.

Further Links

For further programming tips, please read the article about common programming mistakes.


Content is available under Creative Commons License SA 4.0 unless otherwise noted.