doc/src/snippets/code/src_corelib_kernel_qmetatype.cpp

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
   4 ** Contact: http://www.qt-project.org/
   5 **
   6 ** This file is part of the documentation of the Qt Toolkit.
   7 **
   8 ** $QT_BEGIN_LICENSE:BSD$
   9 ** You may use this file under the terms of the BSD license as follows:
  10 **
  11 ** "Redistribution and use in source and binary forms, with or without
  12 ** modification, are permitted provided that the following conditions are
  13 ** met:
  14 **   * Redistributions of source code must retain the above copyright
  15 **     notice, this list of conditions and the following disclaimer.
  16 **   * Redistributions in binary form must reproduce the above copyright
  17 **     notice, this list of conditions and the following disclaimer in
  18 **     the documentation and/or other materials provided with the
  19 **     distribution.
  20 **   * Neither the name of Nokia Corporation and its Subsidiary(-ies) nor
  21 **     the names of its contributors may be used to endorse or promote
  22 **     products derived from this software without specific prior written
  23 **     permission.
  24 **
  25 ** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  26 ** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  27 ** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  28 ** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  29 ** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  30 ** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  31 ** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  32 ** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  33 ** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  34 ** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  35 ** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."
  36 **
  37 ** $QT_END_LICENSE$
  38 **
  39 ****************************************************************************/
  40
  41 //! [0]
  42 struct MyStruct
  43 {
  44     int i;
  45     ...
  46 };
  47
  48 Q_DECLARE_METATYPE(MyStruct)
  49 //! [0]
  50
  51
  52 //! [1]
  53 namespace MyNamespace
  54 {
  55     ...
  56 }
  57
  58 Q_DECLARE_METATYPE(MyNamespace::MyStruct)
  59 //! [1]
  60
  61
  62 //! [2]
  63 MyStruct s;
  64 QVariant var;
  65 var.setValue(s); // copy s into the variant
  66
  67 ...
  68
  69 // retrieve the value
  70 MyStruct s2 = var.value<MyStruct>();
  71 //! [2]
  72
  73
  74 //! [3]
  75 int id = QMetaType::type("MyClass");
  76 if (id != 0) {
  77     void *myClassPtr = QMetaType::create(id);
  78     ...
  79     QMetaType::destroy(id, myClassPtr);
  80     myClassPtr = 0;
  81 }
  82 //! [3]
  83
  84
  85 //! [4]
  86 qRegisterMetaType<MyClass>("MyClass");
  87 //! [4]
  88
  89
  90 //! [5]
  91 qRegisterMetaTypeStreamOperators<MyClass>("MyClass");
  92 //! [5]
  93
  94
  95 //! [6]
  96 QDataStream &operator<<(QDataStream &out, const MyClass &myObj);
  97 QDataStream &operator>>(QDataStream &in, MyClass &myObj);
  98 //! [6]
  99
 100
 101 //! [7]
 102 int id = qRegisterMetaType<MyStruct>();
 103 //! [7]
 104
 105
 106 //! [8]
 107 int id = qMetaTypeId<QString>();    // id is now QMetaType::QString
 108 id = qMetaTypeId<MyStruct>();       // compile error if MyStruct not declared
 109 //! [8]
 110
 111 //! [9]
 112 typedef QString CustomString;
 113 qRegisterMetaType<CustomString>("CustomString");
 114 //! [9]