Changeset 26352 in vbox

Timestamp:

Feb 9, 2010 10:14:49 AM (15 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

57441

Message:

doc: updated coding style rules for the GUI

File:

• trunk/doc/VBox-CodingGuidelines.cpp (modified) (3 diffs)

trunk/doc/VBox-CodingGuidelines.cpp

@@ -23 +23 @@
  *
  * The VBox Coding guidelines are followed by all of VBox with the exception of
- * the GUI and qemu. The GUI is using something close to the Qt style. Qemu is
- * using whatever the frenchman does.
+ * qemu. Qemu is using whatever the frenchman does.
  *
  * There are a few compulsory rules and a bunch of optional ones. The following
@@ -237 +236 @@
  *
  *
+ * @subsection sec_vbox_guideline_compulsory_cppqtgui   C++ guidelines for the Qt GUI
+ *
+ * The Qt GUI is currently (2010) on its way to become more compatible to the
+ * rest of VirtualBox coding style wise. From now on, all the coding style
+ * rules described in this file are also mandatory for the Qt GUI. Additionally
+ * the following rules should be respected:
+ *
+ * - GUI classes which correspond to GUI tasks should be prefixed by UI (no VBox anymore)
+ *
+ * - Classes which extents some of the Qt classes should be prefix by QI
+ *
+ * - General task classes should be prefixed by C
+ *
+ * - Slots are prefixed by slt -> sltName
+ *
+ * - Signals are prefixed by sig -> sigName
+ *
+ * - Use Qt classes for lists, strings and so on, the use of STL classes should
+ *   be avoided
+ *
+ * - All files like .cpp, .h, .ui, which belong together are located in the
+ *   same directory and named the same
+ *
  *
  * @section sec_vbox_guideline_optional         Optional
@@ -376 +398 @@
  *      - The 'usz' prefix means zero terminated Unicode string (array of RTUNICP).
  *
- *      - The 'str' prefix means C++ string; either a std::string or, in Main, a Utf8Str.
+ *      - The 'str' prefix means C++ string; either a std::string or, in Main,
+ *        a Utf8Str or, in Qt, a QString
  *
  *      - The 'bstr' prefix, in Main, means a UTF-16 Bstr.