Qt 5.11 - Special Content

विशेष सामग्री




qt

विशेष सामग्री

दस्तावेज़ की सामग्री दस्तावेज़ के कुछ हिस्सों की पहचान करती है, एक विशेष प्रतिपादन, वैचारिक अर्थ या कार्य के साथ भागों।

\उद्धरण

\ Quotation और \ endquotation कमांड लंबे कोटेशन का परिसीमन करते हैं।

सीमांकित ब्लॉक का टेक्स्ट HTML आउटपुट में <blockquote> और </ blockquote> से घिरा हुआ है, जैसे:

/ *!
  Although the prospect of a significantly broader market is
  good news for Firstlogic, the notion also posed some
  challenges. Dave Dobson, director of technology for the La
  Crosse, Wisconsin-based company, said:

  \quotation
     As our solutions were being adopted into new
     environments, we saw an escalating need for easier
     integration with a wider range of enterprise
     applications.
  \endquotation
* /

\ उद्धरण ब्लॉक में पाठ उत्पन्न HTML में दिखाई देगा:

<blockquote>
  <p>As our solutions were being adopted into new environments,
  we saw an escalating need for easier integration with a wider
  range of enterprise applications.</p>
    </blockquote>

अधिकांश ब्राउज़रों के लिए अंतर्निहित शैली पत्रक <blockquote> टैग की सामग्री को बाएं और दाएं इंडेंटेशन के साथ प्रस्तुत करेगा। ऊपर दिए गए उदाहरण के रूप में प्रस्तुत किया जाएगा:

जैसा कि हमारे समाधानों को नए वातावरण में अपनाया जा रहा था, हमने व्यापक रूप से उद्यम अनुप्रयोगों के साथ आसान एकीकरण की आवश्यकता देखी।

लेकिन आप अपने style.css फ़ाइल में <blockquote> टैग को फिर से परिभाषित कर सकते हैं।

\पाद लेख

\ Footnote और \ endfootnote कमांड एक फुटनोट का परिसीमन करते हैं।

पेज के नीचे फुटनोट का प्रतिपादन किया गया है।

चेतावनी: \ footnote और \ endfootnote आदेशों को लागू नहीं किया गया है। फुटनोट को एक नियमित HTML पैराग्राफ के रूप में प्रस्तुत किया गया है।

\ध्यान दें

"नोट कमांड" एक नए पैराग्राफ को "नोट:" से पहले बोल्ड में परिभाषित करता है।

\विषय - सूची

\ Tableofcontents कमांड को अक्षम कर दिया गया है क्योंकि QDoc अब स्वचालित रूप से सामग्री की एक तालिका बनाता है।

पृष्ठ के ऊपरी दाहिने कोने में सामग्री की स्वचालित रूप से निर्मित तालिका दिखाई देती है।

\संक्षिप्त करें

\ संक्षिप्त आदेश एक वर्ग, नाम स्थान, हेडर फ़ाइल, संपत्ति या चर का एक-वाक्य विवरण प्रस्तुत करता है।

संक्षिप्त पाठ का उपयोग संबद्ध ऑब्जेक्ट के दस्तावेज़ीकरण को प्रस्तुत करने के लिए किया जाता है, और \generatelist कमांड और \annotatedlist सूची का उपयोग करके उत्पन्न सूचियों में।

\ संक्षिप्त आदेश का उपयोग दो महत्वपूर्ण अलग-अलग तरीकों से किया जा सकता है: एक वर्ग, नामस्थान और हेडर फ़ाइलों के लिए , और एक गुण और चर के लिए

जब किसी संपत्ति या चर का वर्णन करने के लिए \ संक्षिप्त आदेश का उपयोग किया जाता है, तो संक्षिप्त पाठ में "चाहे" (बूलियन संपत्ति या चर के लिए) या "" (किसी अन्य संपत्ति या चर के लिए) के साथ शुरू होने वाला एक वाक्य टुकड़ा होना चाहिए। ।

उदाहरण के लिए बूलियन QWidget::isWindow गुण:

/ *!
    \property QWidget::isActiveWindow
    \brief Whether this widget's window is the active window

    The active window is the window that contains the widget that
    has keyboard focus.

    When popup windows are visible, this property is \c true
    for both the active window \e and the popup.

    \sa activateWindow(), QApplication::activeWindow()
* /

और QWidget::geometry संपत्ति

/ *!
    \property QWidget::geometry
    \brief The geometry of the widget relative to its parent and
    excluding the window frame

    When changing the geometry, the widget, if visible,
    receives a move event (moveEvent()) and/or a resize
    event (resizeEvent()) immediately.

    ...

   \sa frameGeometry(), rect(), ...
* /

QDoc इसे प्रस्तुत करता है:

ज्यामिति: QRect

यह संपत्ति अपने माता-पिता के सापेक्ष विजेट की ज्यामिति रखती है और खिड़की के फ्रेम को छोड़कर।

...

पहुंच कार्य:

  • const QRect और ज्यामिति () const
  • शून्य सेटग्रोमेट्री (इंट एक्स, इंट वाई, इंट डब्ल्यू, इंट एच)
  • शून्य सेटग्रोमेट्री (const QRect &)

frameGeometry() , rect() , ...

जब एक वर्ग का वर्णन करने के लिए \ संक्षिप्त कमांड का उपयोग किया जाता है, तो हम इस तरह से एक पूर्ण वाक्य का उपयोग करने की सलाह देते हैं:

The <classname> class is|provides|contains|specifies...

चेतावनी: अपने विस्तृत विवरण को उसी वाक्य के साथ न दोहराएं क्योंकि संक्षिप्त विवरण विस्तृत विवरण का पहला पैराग्राफ होगा।

/ *!
    \class PreviewWindow
    \brief The PreviewWindow class is a custom widget
           displaying the names of its currently set
           window flags in a read-only text editor.

    The PreviewWindow class inherits QWidget. The widget
    displays the names of its window flags set with the
    setWindowFlags() function. It is also provided with a
    QPushButton that closes the window.

    ...

    \sa QWidget
* /

QDoc इसे प्रस्तुत करता है:

प्रीव्यूविंडो क्लास रेफरेंस

प्रीव्यूविंडो क्लास एक कस्टम विजेट है जो अपने वर्तमान में सेट किए गए विंडो फ्लैग के नामों को रीड-ओनली टेक्स्ट एडिटर में प्रदर्शित करता है। More...

गुण

  • 52 गुण QWidget से विरासत में QWidget
  • 1 संपत्ति QObject से विरासत में मिली

सार्वजनिक कार्य

  • 183 सार्वजनिक कार्य QWidget से विरासत में QWidget
  • 28 सार्वजनिक कार्य QObject से विरासत में QObject

सार्वजनिक स्लॉट

  • 17 सार्वजनिक स्लॉट QWidget से विरासत में QWidget
  • 1 सार्वजनिक स्लॉट QObject से विरासत में मिला है

अतिरिक्त घायल सदस्य

  • 1 संकेत QWidget से विरासत में मिला
  • 1 संकेत QObject से विरासत में मिला
  • 4 स्थिर सार्वजनिक सदस्य QWidget से विरासत में QWidget
  • 4 स्थिर सार्वजनिक सदस्य QObject से विरासत में QObject
  • 39 संरक्षित कार्य QWidget से विरासत में QWidget
  • 7 संरक्षित कार्य QObject से विरासत में QObject

विस्तृत विवरण

प्रीव्यूविंडो क्लास एक कस्टम विजेट है जो अपने वर्तमान में सेट किए गए विंडो फ्लैग के नामों को रीड-ओनली टेक्स्ट एडिटर में प्रदर्शित करता है।

QWidget वर्ग QWidget विरासत में QWidget । विजेट setWindowFlags फ़ंक्शन के साथ अपने विंडो फ्लैग के नाम प्रदर्शित करता है। यह एक QPushButton साथ भी दिया गया है जो खिड़की को बंद करता है।

...

QWidget भी देखें।

सदस्य समारोह प्रलेखन

प्रीव्यू विंडो (QWidget * जनक = 0)

माता-पिता के साथ एक पूर्वावलोकन विंडो विजेट का निर्माण करता है।

setWindowFlags (Qt :: WindowFlags झंडे)

विजेट QWidget::setWindowFlags को QWidget::setWindowFlags () फ़ंक्शन का उपयोग करके सेट करता है।

फिर उपलब्ध विंडो झंडे के माध्यम से चलता है, जिसमें एक पाठ बना होता है जिसमें झंडे के नाम शामिल होते हैं जो झंडे पैरामीटर से मेल खाते हैं, पाठ को विजेट्स संपादक में प्रदर्शित करते हैं।

\ Namepace में \ संक्षिप्त का उपयोग करना:

/ *!
    \namespace Qt

    \brief The Qt namespace contains miscellaneous identifiers
    used throughout the Qt library.
* /

\headerfile में \ संक्षिप्त का उपयोग करना:

/ *!
    \headerfile <QtGlobal>
    \title Global Qt Declarations

    \brief The <QtGlobal> header file provides basic
    declarations and is included by all other Qt headers.

    \sa <QtAlgorithms>
* /

\property , \class , \namespace और \headerfile भी देखें।

\ कानूनी बारीकियों

\ कानूनी और \ endlegalese आदेश एक लाइसेंस समझौते को सीमांकित करते हैं।

उत्पन्न HTML में, सीमांकित पाठ <div class = "LegaleseLeft"> और </ div> टैग से घिरा हुआ है।

लाइसेंस समझौते का एक उदाहरण \ कानूनी और \ endlegalese में संलग्न है:

/ *!
  \legalese
      Copyright 1996 Daniel Dardailler.

      Permission to use, copy, modify, distribute, and sell this
      software for any purpose is hereby granted without fee,
      provided that the above copyright notice appear in all
      copies and that both that copyright notice and this
      permission notice appear in supporting documentation, and
      that the name of Daniel Dardailler not be used in
      advertising or publicity pertaining to distribution of the
      software without specific, written prior permission. Daniel
      Dardailler makes no representations about the suitability of
      this software for any purpose. It is provided "as is"
      without express or implied warranty.

  Modifications Copyright 1999 Matt Koss, under the same
      license as above.
      \endlegalese
    * /

यह उत्पन्न HTML में इस प्रकार दिखाई देगा:

<div class="LegaleseLeft">
  <p>Copyright 1996 Daniel Dardailler.</p>
      <p>Permission to use, copy, modify, distribute, and sell
      this software for any purpose is hereby granted without fee,
      provided that the above copyright notice appear in all
      copies and that both that copyright notice and this
      permission notice appear in supporting documentation, and
      that the name of Daniel Dardailler not be used in
      advertising or publicity pertaining to distribution of the
      software without specific, written prior permission. Daniel
      Dardailler makes no representations about the suitability of
      this software for any purpose. It is provided "as is"
      without express or implied warranty.</p>

  <p>Modifications Copyright 1999 Matt Koss, under the same
      license as above.</p>
</div>

यदि \ endlegalese कमांड को छोड़ दिया जाता है, तो QDoc \ कानूनी कमांड को संसाधित करेगा लेकिन बाकी के प्रलेखन पृष्ठ को लाइसेंस अनुबंध मानता है।

आदर्श रूप से, लाइसेंस पाठ लाइसेंस कोड के साथ स्थित है।

अन्य जगहों पर, \ कानूनी कमांड के रूप में पहचाने जाने वाले दस्तावेज़ को तर्क के रूप में legalese रूप से legalese का उपयोग करके संचित किया जा सकता है। यह स्रोत कोड से जुड़े लाइसेंस समझौतों का अवलोकन उत्पन्न करने के लिए उपयोगी है।

नोट: \generatelist legalese आदेश के आउटपुट में केवल वर्तमान दस्तावेज़ प्रोजेक्ट में \ कानूनी पाठ शामिल हैं। यदि वर्तमान प्रलेखन परियोजना अन्य मॉड्यूल पर निर्भर करती है, तो उनके लाइसेंस ग्रंथों को सूचीबद्ध नहीं किया जाएगा।

\ चेतावनी

\ चेतावनी कमांड बोल्ड फ़ॉन्ट में कमांड के तर्क के लिए "चेतावनी:" प्रस्तुत करता है।

/ *!
    Qt::HANDLE is a platform-specific handle type
    for system objects. This is  equivalent to
    \c{void *} on Windows and macOS, and to
    \c{unsigned long} on X11.

    \warning Using this type is not portable.
* /

QDoc इसे प्रस्तुत करता है:

Qt::HANDLE सिस्टम ऑब्जेक्ट्स के लिए एक प्लेटफ़ॉर्म-विशिष्ट हैंडल प्रकार है। यह विंडोज और macOS पर void * बराबर है, और X11 पर unsigned long अनसाइन किया गया है।

चेतावनी: इस प्रकार का उपयोग करना पोर्टेबल नहीं है।