Difference between revisions of "Policies/API to Avoid"

Jump to: navigation, search
(Qt classes that have their KDE versions)
(Replaced content with "{{Moved To Community}}")
 
Line 1: Line 1:
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).
+
{{Moved To Community}}
 
+
== API that has KDE replacements ==
+
 
+
=== Qt classes that have their KDE versions ===
+
==== When buliding with kdelibs4 ====
+
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.
+
 
+
==== When building with Qt5 and KDE Frameworks ====
+
For frameworks, a lot of functionality from K classes has been merged into upstream Q classes. Use of QFileDialog, QDialog, and QMainWindow are ok and even encouraged, while other classes like KLineEdit and KComboBox are only required for utilizing features like completion See [https://community.kde.org/Frameworks/Porting_Notes#Application 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 [http://bugs.kde.org/show_bug.cgi?id=157941 bug #157941]), the same way showNormal() is not an inverse call to showFullScreen().
+
 
+
Either use QWidget::setWindowState() in the following way
+
<syntaxhighlight lang="cpp-qt">
+
widget->setWindowState(widget->windowState() | Qt::WindowFullScreen); // set
+
widget->setWindowState(widget->windowState() & ~Qt::WindowFullScreen); // reset
+
</syntaxhighlight>
+
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 [[Development/Tutorials/Common_Programming_Mistakes|common programming mistakes]].
+

Latest revision as of 18:27, 10 March 2016

This page is now on the community wiki.


This page was last modified on 10 March 2016, at 18:27. Content is available under Creative Commons License SA 4.0 unless otherwise noted.