Doc: Use title case in section1 titles
Using Python script title-cased.py Task-number: QTBUG-41250 Change-Id: I00d3d7a0b30db7304a7904efd6d63abd9a7b493b Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
This commit is contained in:
parent
eda8af2a69
commit
54853c5f66
@ -34,7 +34,7 @@
|
||||
|
||||
\image openglwindow-example.png Screenshot of the OpenGLWindow example
|
||||
|
||||
\section1 OpenGLWindow super class
|
||||
\section1 OpenGLWindow Super Class
|
||||
|
||||
Our OpenGLWindow class acts as an API which is then subclassed to do the
|
||||
actual rendering. It has functions to make a request for render() to be
|
||||
@ -118,7 +118,7 @@
|
||||
|
||||
\snippet openglwindow/openglwindow.cpp 5
|
||||
|
||||
\section1 Example OpenGL rendering sub class
|
||||
\section1 Example OpenGL Rendering Sub Class
|
||||
|
||||
Here we sub class OpenGLWindow to show how to do OpenGL to render a
|
||||
rotating triangle. By indirectly sub classing QOpenGLFunctions we gain
|
||||
|
@ -43,7 +43,7 @@
|
||||
In this example, we'll demonstrate how to save and load a simple game to
|
||||
and from JSON and binary formats.
|
||||
|
||||
\section1 The Character class
|
||||
\section1 The Character Class
|
||||
|
||||
The Character class represents a non-player character (NPC) in our game, and
|
||||
stores the player's name, level, and class type.
|
||||
|
@ -90,7 +90,7 @@
|
||||
|
||||
\snippet cube/mainwidget.cpp 2
|
||||
|
||||
\section1 Loading textures from Qt Resource files
|
||||
\section1 Loading Textures from Qt Resource Files
|
||||
|
||||
\c QGLWidget interface implements methods for loading textures from QImage to GL
|
||||
texture memory. We still need to use OpenGL provided functions for specifying
|
||||
@ -133,14 +133,14 @@
|
||||
|
||||
\snippet cube/geometryengine.cpp 2
|
||||
|
||||
\section1 Perspective projection
|
||||
\section1 Perspective Projection
|
||||
|
||||
Using \c QMatrix4x4 helper methods it's really easy to calculate perpective
|
||||
projection matrix. This matrix is used to project vertices to screen space.
|
||||
|
||||
\snippet cube/mainwidget.cpp 5
|
||||
|
||||
\section1 Orientation of the 3D object
|
||||
\section1 Orientation of the 3D Object
|
||||
|
||||
Quaternions are handy way to represent orientation of the 3D object. Quaternions
|
||||
involve quite complex mathematics but fortunately all the necessary mathematics
|
||||
|
@ -192,7 +192,7 @@
|
||||
the platform. By convention the target should have the same name
|
||||
as the plugin (set with Q_EXPORT_PLUGIN2)
|
||||
|
||||
\section1 Further reading and examples
|
||||
\section1 Further Reading and Examples
|
||||
|
||||
The \l {qtplugin-defining-plugins}{Defining Plugins} page presents an overview of the macros needed to
|
||||
create plugins.
|
||||
|
@ -123,7 +123,7 @@
|
||||
styles folder under stylewindow because this is a path in which Qt
|
||||
will search for style plugins.
|
||||
|
||||
\section1 Related articles and examples
|
||||
\section1 Related Articles and Examples
|
||||
|
||||
In addition to the plugin \l{How to Create Qt Plugins}{overview
|
||||
document}, we have other examples and articles that concern
|
||||
|
@ -61,7 +61,7 @@
|
||||
First we will review the \c SortingBox class, then we will take a
|
||||
look at the \c ShapeItem class.
|
||||
|
||||
\section1 SortingBox Class Definition
|
||||
\section1 SortingBox Class Definition
|
||||
|
||||
\snippet widgets/tooltips/sortingbox.h 0
|
||||
|
||||
|
@ -4328,7 +4328,7 @@
|
||||
This tutorial teaches you the basics of qmake. The other topics in this
|
||||
manual contain more detailed information about using qmake.
|
||||
|
||||
\section1 Starting off Simple
|
||||
\section1 Starting Off Simple
|
||||
|
||||
Let's assume that you have just finished a basic implementation of
|
||||
your application, and you have created the following files:
|
||||
|
@ -226,7 +226,7 @@
|
||||
In the example, the enumeration type that is the property type is
|
||||
declared in MyClass and registered with the \l{Meta-Object System}
|
||||
using the Q_ENUMS() macro. This makes the enumeration values
|
||||
available as strings for use as in the call to setProperty(). Had
|
||||
available as strings for use as in the call to \l{QObject::}{setProperty()}. Had
|
||||
the enumeration type been declared in another class, its fully
|
||||
qualified name (i.e., OtherClass::Priority) would be required, and
|
||||
that other class would also have to inherit QObject and register
|
||||
|
@ -84,7 +84,7 @@
|
||||
whether the type has already been destroyed, to avoid the
|
||||
use-after-destruction problem (see QGlobalStatic::isDestroyed()).
|
||||
|
||||
\section1 Constructor and destructor
|
||||
\section1 Constructor and Destructor
|
||||
|
||||
For Q_GLOBAL_STATIC, the type \c Type must be publicly
|
||||
default-constructible and publicly destructible. For
|
||||
@ -156,7 +156,7 @@
|
||||
|
||||
This macro will work, but it will add unnecessary overhead.
|
||||
|
||||
\section1 Reentrancy, thread-safety, deadlocks, and exception-safety on construction
|
||||
\section1 Reentrancy, Thread-safety, Deadlocks, and Exception-safety on Construction
|
||||
|
||||
The Q_GLOBAL_STATIC macro creates an object that initializes itself on
|
||||
first use in a thread-safe manner: if multiple threads attempt to
|
||||
@ -224,7 +224,7 @@
|
||||
\li the object was always created on the heap.
|
||||
\endlist
|
||||
|
||||
\section1 Implementation details
|
||||
\section1 Implementation Details
|
||||
|
||||
Q_GLOBAL_STATIC is implemented by creating a QBasicAtomicInt called the \c
|
||||
guard and a free, inline function called \c innerFunction. The guard
|
||||
|
@ -133,7 +133,7 @@ QT_BEGIN_NAMESPACE
|
||||
special requirements.
|
||||
|
||||
\target raw
|
||||
\section1 Reading and writing raw binary data
|
||||
\section1 Reading and Writing Raw Binary Data
|
||||
|
||||
You may wish to read/write your own raw binary data to/from the
|
||||
data stream directly. Data may be read from the stream into a
|
||||
@ -149,14 +149,14 @@ QT_BEGIN_NAMESPACE
|
||||
data, followed by the data. Note that any encoding/decoding of
|
||||
the data (apart from the length quint32) must be done by you.
|
||||
|
||||
\section1 Reading and writing Qt collection classes
|
||||
\section1 Reading and Writing Qt Collection Classes
|
||||
|
||||
The Qt container classes can also be serialized to a QDataStream.
|
||||
These include QList, QLinkedList, QVector, QSet, QHash, and QMap.
|
||||
The stream operators are declared as non-members of the classes.
|
||||
|
||||
\target Serializing Qt Classes
|
||||
\section1 Reading and writing other Qt classes.
|
||||
\section1 Reading and Writing Other Qt Classes
|
||||
|
||||
In addition to the overloaded stream operators documented here,
|
||||
any Qt classes that you might want to serialize to a QDataStream
|
||||
|
@ -140,7 +140,7 @@ QFileSelectorPrivate::QFileSelectorPrivate()
|
||||
deployment step as an optimization. As selectors come with a performance cost, it is
|
||||
recommended to avoid their use in circumstances involving performance-critical code.
|
||||
|
||||
\section1 Adding selectors
|
||||
\section1 Adding Selectors
|
||||
|
||||
Selectors normally available are
|
||||
\list
|
||||
@ -158,7 +158,7 @@ QFileSelectorPrivate::QFileSelectorPrivate()
|
||||
future calls to select(). If the extra selectors list has been changed, calls to select() will
|
||||
use the new list and may return differently.
|
||||
|
||||
\section1 Conflict resolution when multiple selectors apply
|
||||
\section1 Conflict Resolution when Multiple Selectors Apply
|
||||
|
||||
When multiple selectors could be applied to the same file, the first matching selector is chosen.
|
||||
The order selectors are checked in are:
|
||||
|
@ -71,14 +71,14 @@ static void setBoolLane(QBasicAtomicInt *atomic, bool enable, int shift)
|
||||
boundaries, nor to manipulate the objects directly, nor to inherit from
|
||||
QLoggingCategory.
|
||||
|
||||
\section1 Creating category objects
|
||||
\section1 Creating Category Objects
|
||||
|
||||
The Q_DECLARE_LOGGING_CATEGORY() and Q_LOGGING_CATEGORY() macros
|
||||
conveniently declare and create QLoggingCategory objects:
|
||||
|
||||
\snippet qloggingcategory/main.cpp 1
|
||||
|
||||
\section1 Checking category configuration
|
||||
\section1 Checking Category Configuration
|
||||
|
||||
QLoggingCategory provides \l isDebugEnabled(), \l isWarningEnabled(),
|
||||
\l isCriticalEnabled(), as well as \l isEnabled()
|
||||
@ -90,7 +90,7 @@ static void setBoolLane(QBasicAtomicInt *atomic, bool enable, int shift)
|
||||
|
||||
\snippet qloggingcategory/main.cpp 4
|
||||
|
||||
\section1 Default category configuration
|
||||
\section1 Default Category Configuration
|
||||
|
||||
Both the QLoggingCategory constructor and the Q_LOGGING_CATEGORY() macro
|
||||
accept an optional QtMsgType argument, which disables all message types with
|
||||
@ -172,7 +172,7 @@ static void setBoolLane(QBasicAtomicInt *atomic, bool enable, int shift)
|
||||
custom filter via \l installFilter(). All filter rules are ignored in this
|
||||
case.
|
||||
|
||||
\section1 Printing the category
|
||||
\section1 Printing the Category
|
||||
|
||||
Use the \c %{category} place holder to print the category in the default
|
||||
message handler:
|
||||
|
@ -678,7 +678,7 @@ void QMetaCallEvent::placeMetaCall(QObject *object)
|
||||
will remain in the old thread when moveToThread() is called.
|
||||
|
||||
\target No copy constructor
|
||||
\section1 No copy constructor or assignment operator
|
||||
\section1 No Copy Constructor or Assignment Operator
|
||||
|
||||
QObject has neither a copy constructor nor an assignment operator.
|
||||
This is by design. Actually, they are declared, but in a
|
||||
@ -723,7 +723,7 @@ void QMetaCallEvent::placeMetaCall(QObject *object)
|
||||
and both standard Qt widgets and user-created forms can be given dynamic
|
||||
properties.
|
||||
|
||||
\section1 Internationalization (i18n)
|
||||
\section1 Internationalization (I18n)
|
||||
|
||||
All QObject subclasses support Qt's translation features, making it possible
|
||||
to translate an application's user interface into different languages.
|
||||
|
@ -213,7 +213,7 @@ QThreadPrivate::~QThreadPrivate()
|
||||
\note Care must be taken when interacting with objects across different
|
||||
threads. See \l{Synchronizing Threads} for details.
|
||||
|
||||
\section1 Managing threads
|
||||
\section1 Managing Threads
|
||||
|
||||
QThread will notifiy you via a signal when the thread is
|
||||
started() and finished(), or you can use isFinished() and
|
||||
|
@ -144,7 +144,7 @@
|
||||
|
||||
QList and QVector's non-const iterator types are random access iterators.
|
||||
|
||||
\section1 Qt and the STL algorithms
|
||||
\section1 Qt and the STL Algorithms
|
||||
|
||||
Historically, Qt used to provide functions which were direct equivalents of
|
||||
many STL algorithmic functions. Starting with Qt 5.0, you are instead
|
||||
|
@ -77,7 +77,7 @@ QT_BEGIN_NAMESPACE
|
||||
|
||||
\snippet qelapsedtimer/main.cpp 2
|
||||
|
||||
\section1 Reference clocks
|
||||
\section1 Reference Clocks
|
||||
|
||||
QElapsedTimer will use the platform's monotonic reference clock in all
|
||||
platforms that support it (see QElapsedTimer::isMonotonic()). This has
|
||||
|
@ -468,7 +468,7 @@ void **QListData::erase(void **xi)
|
||||
value that might not be in the valid range, check that it is less
|
||||
than the value returned by size() but \e not less than 0.
|
||||
|
||||
\section1 More members
|
||||
\section1 More Members
|
||||
|
||||
If T is a QByteArray, this class has a couple more members that can be
|
||||
used. See the documentation for QByteArrayList for more information.
|
||||
|
@ -138,7 +138,7 @@ QT_BEGIN_NAMESPACE
|
||||
|
||||
\snippet code/src_corelib_tools_qregularexpression.cpp 3
|
||||
|
||||
\section1 Pattern options
|
||||
\section1 Pattern Options
|
||||
|
||||
The meaning of the pattern string can be modified by setting one or more
|
||||
\e{pattern options}. For instance, it is possible to set a pattern to match
|
||||
@ -162,7 +162,7 @@ QT_BEGIN_NAMESPACE
|
||||
Please refer to the QRegularExpression::PatternOption enum documentation for
|
||||
more information about each pattern option.
|
||||
|
||||
\section1 Match type and match options
|
||||
\section1 Match Type and Match Options
|
||||
|
||||
The last two arguments of the match() and the globalMatch() functions set
|
||||
the match type and the match options. The match type is a value of the
|
||||
@ -177,7 +177,7 @@ QT_BEGIN_NAMESPACE
|
||||
QRegularExpression::MatchOption enum documentation for more details.
|
||||
|
||||
\target normal matching
|
||||
\section1 Normal matching
|
||||
\section1 Normal Matching
|
||||
|
||||
In order to perform a match you can simply invoke the match() function
|
||||
passing a string to match against. We refer to this string as the
|
||||
@ -227,7 +227,7 @@ QT_BEGIN_NAMESPACE
|
||||
\snippet code/src_corelib_tools_qregularexpression.cpp 12
|
||||
|
||||
\target global matching
|
||||
\section1 Global matching
|
||||
\section1 Global Matching
|
||||
|
||||
\e{Global matching} is useful to find all the occurrences of a given
|
||||
regular expression inside a subject string. Suppose that we want to extract
|
||||
@ -257,7 +257,7 @@ QT_BEGIN_NAMESPACE
|
||||
the globalMatch() function, exactly like normal matching with match().
|
||||
|
||||
\target partial matching
|
||||
\section1 Partial matching
|
||||
\section1 Partial Matching
|
||||
|
||||
A \e{partial match} is obtained when the end of the subject string is
|
||||
reached, but more characters are needed to successfully complete the match.
|
||||
@ -396,7 +396,7 @@ QT_BEGIN_NAMESPACE
|
||||
text) would have been \c{"abcabc"}; by matching only against the leading
|
||||
\c{"abc"} we instead get a partial match.
|
||||
|
||||
\section1 Error handling
|
||||
\section1 Error Handling
|
||||
|
||||
It is possible for a QRegularExpression object to be invalid because of
|
||||
syntax errors in the pattern string. The isValid() function will return
|
||||
@ -415,7 +415,7 @@ QT_BEGIN_NAMESPACE
|
||||
its \l{QRegularExpressionMatch::}{isValid()} function will return false).
|
||||
The same applies for attempting a global match.
|
||||
|
||||
\section1 Unsupported Perl-compatible regular expressions features
|
||||
\section1 Unsupported Perl-compatible Regular Expressions Features
|
||||
|
||||
QRegularExpression does not support all the features available in
|
||||
Perl-compatible regular expressions. The most notable one is the fact that
|
||||
@ -424,7 +424,7 @@ QT_BEGIN_NAMESPACE
|
||||
|
||||
This may change in a future version of Qt.
|
||||
|
||||
\section1 Notes for QRegExp users
|
||||
\section1 Notes for QRegExp Users
|
||||
|
||||
The QRegularExpression class introduced in Qt 5 is a big improvement upon
|
||||
QRegExp, in terms of APIs offered, supported pattern syntax and speed of
|
||||
@ -517,7 +517,7 @@ QT_BEGIN_NAMESPACE
|
||||
QRegExp::CaretAtOffset behaviour. There is no equivalent for the other
|
||||
QRegExp::CaretMode modes.
|
||||
|
||||
\section1 Debugging code that uses QRegularExpression
|
||||
\section1 Debugging Code that Uses QRegularExpression
|
||||
|
||||
QRegularExpression internally uses a just in time compiler (JIT) to
|
||||
optimize the execution of the matching algorithm. The JIT makes extensive
|
||||
|
@ -73,7 +73,7 @@ QT_BEGIN_NAMESPACE
|
||||
|
||||
\snippet code/src_corelib_tools_qscopedpointer.cpp 2
|
||||
|
||||
\section1 Custom cleanup handlers
|
||||
\section1 Custom Cleanup Handlers
|
||||
|
||||
Arrays as well as pointers that have been allocated with \c malloc must
|
||||
not be deleted using \c delete. QScopedPointer's second template parameter
|
||||
|
@ -222,7 +222,7 @@ QT_BEGIN_NAMESPACE
|
||||
In the member function documentation, \e{d pointer} always refers
|
||||
to the internal pointer to the shared data object.
|
||||
|
||||
\section1 Optimize performance for usage in Qt Containers
|
||||
\section1 Optimize Performance for Usage in Qt Containers
|
||||
|
||||
You should consider marking your implicitly shared class as a movable type
|
||||
using the Q_DECLARE_TYPEINFO() macro if it resembles the \c Employee class
|
||||
|
@ -103,7 +103,7 @@
|
||||
does so weakly. QWeakPointer has the same functionality, but its use for
|
||||
that function is deprecated.
|
||||
|
||||
\section1 Optional pointer tracking
|
||||
\section1 Optional Pointer Tracking
|
||||
|
||||
A feature of QSharedPointer that can be enabled at compile-time for
|
||||
debugging purposes is a pointer tracking mechanism. When enabled,
|
||||
|
@ -69,7 +69,7 @@
|
||||
respectively after and behind the iterator's current position, but they
|
||||
will not return the code point the iterator has moved through.
|
||||
|
||||
\section1 Unicode handling
|
||||
\section1 Unicode Handling
|
||||
|
||||
QString and all of its functions work in terms of UTF-16 code units. Unicode code points
|
||||
that fall outside the Basic Multilingual Plane (U+10000 to U+10FFFF) will therefore
|
||||
@ -91,7 +91,7 @@
|
||||
a decoding problem; please refer to the each function documentation for
|
||||
more details.
|
||||
|
||||
\section1 Unchecked iteration
|
||||
\section1 Unchecked Iteration
|
||||
|
||||
It is possible to optimize iterating over a QString contents by skipping
|
||||
some checks. This is in general not safe to do, because a QString is allowed
|
||||
|
@ -90,7 +90,7 @@ QT_BEGIN_NAMESPACE
|
||||
|
||||
\tableofcontents
|
||||
|
||||
\section1 Adding strings
|
||||
\section1 Adding Strings
|
||||
|
||||
Strings can be added to a list using the \l
|
||||
{QList::append()}{append()}, \l
|
||||
@ -99,7 +99,7 @@ QT_BEGIN_NAMESPACE
|
||||
|
||||
\snippet qstringlist/main.cpp 0
|
||||
|
||||
\section1 Iterating over the strings
|
||||
\section1 Iterating Over the Strings
|
||||
|
||||
To iterate over a list, you can either use index positions or
|
||||
QList's Java-style and STL-style iterator types:
|
||||
@ -121,7 +121,7 @@ QT_BEGIN_NAMESPACE
|
||||
QMutableStringListIterator class which is a type definition for
|
||||
QMutableListIterator<QString>.
|
||||
|
||||
\section1 Manipulating the strings
|
||||
\section1 Manipulating the Strings
|
||||
|
||||
QStringList provides several functions allowing you to manipulate
|
||||
the contents of a list. You can concatenate all the strings in a
|
||||
|
@ -325,7 +325,7 @@ QXmlStreamEntityResolver *QXmlStreamReader::entityResolver() const
|
||||
namespace prefixes, you can turn off namespace processing completely
|
||||
with the \l namespaceProcessing property.
|
||||
|
||||
\section1 Incremental parsing
|
||||
\section1 Incremental Parsing
|
||||
|
||||
QXmlStreamReader is an incremental parser. It can handle the case
|
||||
where the document can't be parsed all at once because it arrives in
|
||||
@ -349,7 +349,7 @@ QXmlStreamEntityResolver *QXmlStreamReader::entityResolver() const
|
||||
stream reader using addData(). Then you call your custom parsing
|
||||
function that reads the XML events from the reader.
|
||||
|
||||
\section1 Performance and memory consumption
|
||||
\section1 Performance and Memory Consumption
|
||||
|
||||
QXmlStreamReader is memory-conservative by design, since it doesn't
|
||||
store the entire XML document tree in memory, but only the current
|
||||
|
@ -97,7 +97,7 @@
|
||||
Break-down analysis:
|
||||
\tableofcontents
|
||||
|
||||
\section1 The header
|
||||
\section1 The Header
|
||||
|
||||
The header of the example is:
|
||||
\snippet code/doc_src_qdbusadaptors.cpp 3
|
||||
@ -109,7 +109,7 @@
|
||||
\li it declares the name of the D-Bus interface it implements.
|
||||
\endlist
|
||||
|
||||
\section1 The properties
|
||||
\section1 The Properties
|
||||
|
||||
The properties are declared as follows:
|
||||
\snippet code/doc_src_qdbusadaptors.cpp 4
|
||||
@ -126,7 +126,7 @@
|
||||
caption property is empty. Note how it is possible to access data defined in other objects
|
||||
through the getter/setter functions.
|
||||
|
||||
\section1 The constructor
|
||||
\section1 The Constructor
|
||||
|
||||
The constructor:
|
||||
\snippet code/doc_src_qdbusadaptors.cpp 6
|
||||
|
@ -68,7 +68,7 @@
|
||||
higher level API's, like Qt Quick, that are much more suitable
|
||||
than the enablers found in the Qt GUI module.
|
||||
|
||||
\section1 Getting started
|
||||
\section1 Getting Started
|
||||
|
||||
To include the definitions of the module's classes, use the
|
||||
following directive:
|
||||
@ -170,7 +170,7 @@
|
||||
|
||||
|
||||
|
||||
\section1 Qt GUI prior to Qt 5.0
|
||||
\section1 Qt GUI Prior to Qt 5.0
|
||||
|
||||
Prior to Qt 5.0, the Qt GUI module was the monolithic container
|
||||
for all things relating to graphical user interfaces in Qt, and
|
||||
|
@ -3989,7 +3989,7 @@ QWindowStateChangeEvent::~QWindowStateChangeEvent()
|
||||
This makes it possible for sibling widgets to handle touch events independently while making
|
||||
sure that the sequence of QTouchEvents is always correct.
|
||||
|
||||
\section1 Mouse Events and Touch Event synthesizing
|
||||
\section1 Mouse Events and Touch Event Synthesizing
|
||||
|
||||
QTouchEvent delivery is independent from that of QMouseEvent. The application flags
|
||||
Qt::AA_SynthesizeTouchForUnhandledMouseEvents and Qt::AA_SynthesizeMouseForUnhandledTouchEvents
|
||||
|
@ -297,7 +297,7 @@ QOpenGLContext *qt_gl_global_share_context()
|
||||
For an example of how to use QOpenGLContext see the
|
||||
\l{OpenGL Window Example}{OpenGL Window} example.
|
||||
|
||||
\section1 Thread affinity
|
||||
\section1 Thread Affinity
|
||||
|
||||
QOpenGLContext can be moved to a different thread with moveToThread(). Do
|
||||
not call makeCurrent() from a different thread than the one to which the
|
||||
@ -305,7 +305,7 @@ QOpenGLContext *qt_gl_global_share_context()
|
||||
and against one surface at a time, and a thread only has one context
|
||||
current at a time.
|
||||
|
||||
\section1 Context resource sharing
|
||||
\section1 Context Resource Sharing
|
||||
|
||||
Resources, such as framebuffer objects, textures, and vertex buffer objects
|
||||
can be shared between contexts. Use setShareContext() before calling
|
||||
@ -317,7 +317,7 @@ QOpenGLContext *qt_gl_global_share_context()
|
||||
the share group. A non-sharing context has a share group consisting of a
|
||||
single context.
|
||||
|
||||
\section1 Default framebuffer
|
||||
\section1 Default Framebuffer
|
||||
|
||||
On certain platforms, a framebuffer other than 0 might be the default frame
|
||||
buffer depending on the current surface. Instead of calling
|
||||
|
@ -75,14 +75,14 @@ QT_BEGIN_NAMESPACE
|
||||
are useful reference examples for how to render to a QWindow using
|
||||
either approach.
|
||||
|
||||
\section1 Resource management
|
||||
\section1 Resource Management
|
||||
|
||||
Windows can potentially use a lot of memory. A usual measurement is
|
||||
width times height times color depth. A window might also include multiple
|
||||
buffers to support double and triple buffering, as well as depth and stencil
|
||||
buffers. To release a window's memory resources, call the destroy() function.
|
||||
|
||||
\section1 Content orientation
|
||||
\section1 Content Orientation
|
||||
|
||||
QWindow has reportContentOrientationChange() that can be used to specify
|
||||
the layout of the window contents in relation to the screen. The content
|
||||
@ -93,7 +93,7 @@ QT_BEGIN_NAMESPACE
|
||||
system might use this value to determine the layout of system popups or
|
||||
dialogs.
|
||||
|
||||
\section1 Visibility and Windowing system exposure.
|
||||
\section1 Visibility and Windowing System Exposure
|
||||
|
||||
By default, the window is not visible, and you must call setVisible(true),
|
||||
or show() or similar to make it visible. To make a window hidden again,
|
||||
@ -123,7 +123,7 @@ QT_BEGIN_NAMESPACE
|
||||
isExposed() changes, reimplement exposeEvent(). The window will always get
|
||||
a resize event before the first expose event.
|
||||
|
||||
\section1 Initial geometry
|
||||
\section1 Initial Geometry
|
||||
|
||||
If the window's width and height are left uninitialized, the window will
|
||||
get a reasonable default geometry from the platform window. If the position
|
||||
|
@ -107,7 +107,7 @@ QT_BEGIN_NAMESPACE
|
||||
QOpenGLDebugLogger supports both these modes of operation. Refer to the
|
||||
following sections to find out the differences between them.
|
||||
|
||||
\section1 Creating an OpenGL debug context
|
||||
\section1 Creating an OpenGL Debug Context
|
||||
|
||||
For efficiency reasons, OpenGL implementations are allowed not to create
|
||||
any debug output at all, unless the OpenGL context is a debug context. In order
|
||||
@ -134,7 +134,7 @@ QT_BEGIN_NAMESPACE
|
||||
version, as it relies on the availability of the \c{GL_KHR_debug} extension
|
||||
(see below).
|
||||
|
||||
\section1 Creating and initializing a QOpenGLDebugLogger
|
||||
\section1 Creating and Initializing a QOpenGLDebugLogger
|
||||
|
||||
QOpenGLDebugLogger is a simple QObject-derived class. Just like all QObject
|
||||
subclasses, you create an instance (and optionally specify a parent
|
||||
@ -163,7 +163,7 @@ QT_BEGIN_NAMESPACE
|
||||
where \c{ctx} is a valid QOpenGLContext. If the extension is not available,
|
||||
initialize() will return false.
|
||||
|
||||
\section1 Reading the internal OpenGL debug log
|
||||
\section1 Reading the Internal OpenGL Debug Log
|
||||
|
||||
OpenGL implementations keep an internal log of debug messages. Messages
|
||||
stored in this log can be retrieved by using the loggedMessages() function:
|
||||
@ -237,7 +237,7 @@ QT_BEGIN_NAMESPACE
|
||||
OpenGL log), it is important to always check if it contains any message
|
||||
after calling startLogging().
|
||||
|
||||
\section1 Inserting messages in the debug log
|
||||
\section1 Inserting Messages in the Debug Log
|
||||
|
||||
It is possible for applications and libraries to insert custom messages in
|
||||
the debug log, for instance for marking a group of related OpenGL commands
|
||||
@ -262,7 +262,7 @@ QT_BEGIN_NAMESPACE
|
||||
this length by calling the maximumMessageLength() method; messages longer
|
||||
than the limit will automatically get truncated.
|
||||
|
||||
\section1 Controlling the debug output
|
||||
\section1 Controlling the Debug Output
|
||||
|
||||
QOpenGLDebugMessage is also able to apply filters to the debug messages, and
|
||||
therefore limit the amount of messages logged. You can enable or disable
|
||||
|
@ -71,7 +71,7 @@ QT_BEGIN_NAMESPACE
|
||||
|
||||
\snippet code/src_gui_qopenglshaderprogram.cpp 0
|
||||
|
||||
\section1 Writing portable shaders
|
||||
\section1 Writing Portable Shaders
|
||||
|
||||
Shader programs can be difficult to reuse across OpenGL implementations
|
||||
because of varying levels of support for standard vertex attributes and
|
||||
@ -95,7 +95,7 @@ QT_BEGIN_NAMESPACE
|
||||
to just features that are present in GLSL/ES, and avoid
|
||||
standard variable names that only work on the desktop.
|
||||
|
||||
\section1 Simple shader example
|
||||
\section1 Simple Shader Example
|
||||
|
||||
\snippet code/src_gui_qopenglshaderprogram.cpp 1
|
||||
|
||||
@ -104,7 +104,7 @@ QT_BEGIN_NAMESPACE
|
||||
|
||||
\snippet code/src_gui_qopenglshaderprogram.cpp 2
|
||||
|
||||
\section1 Binary shaders and programs
|
||||
\section1 Binary Shaders and Programs
|
||||
|
||||
Binary shaders may be specified using \c{glShaderBinary()} on
|
||||
the return value from QOpenGLShader::shaderId(). The QOpenGLShader instance
|
||||
|
@ -197,7 +197,7 @@ static void ensureInitialized()
|
||||
can be:
|
||||
\snippet code/src_network_access_qnetworkaccessmanager.cpp 1
|
||||
|
||||
\section1 Network and Roaming support
|
||||
\section1 Network and Roaming Support
|
||||
|
||||
With the addition of the \l {Bearer Management} API to Qt 4.7
|
||||
QNetworkAccessManager gained the ability to manage network connections.
|
||||
|
@ -83,7 +83,7 @@ QT_BEGIN_NAMESPACE
|
||||
\l {QNetworkSession}{session} is \l {QNetworkSession::open()}{opened}. Not all platforms
|
||||
support the concept of a user choice configuration.
|
||||
|
||||
\section1 Configuration states
|
||||
\section1 Configuration States
|
||||
|
||||
The list of available configurations can be obtained via
|
||||
QNetworkConfigurationManager::allConfigurations(). A configuration can have
|
||||
|
@ -204,7 +204,7 @@
|
||||
\l{multicastreceiver}{Multicast Receiver} examples show how to use
|
||||
write UDP multicast clients.
|
||||
|
||||
\section1 Resolving Host Names using QHostInfo
|
||||
\section1 Resolving Host Names Using QHostInfo
|
||||
|
||||
Before establishing a network connection, QTcpSocket and
|
||||
QUdpSocket perform a name lookup, translating the host name
|
||||
|
@ -66,7 +66,7 @@ QT_BEGIN_NAMESPACE
|
||||
|
||||
\snippet code/src_opengl_qglshaderprogram.cpp 0
|
||||
|
||||
\section1 Writing portable shaders
|
||||
\section1 Writing Portable Shaders
|
||||
|
||||
Shader programs can be difficult to reuse across OpenGL implementations
|
||||
because of varying levels of support for standard vertex attributes and
|
||||
@ -90,7 +90,7 @@ QT_BEGIN_NAMESPACE
|
||||
to just features that are present in GLSL/ES, and avoid
|
||||
standard variable names that only work on the desktop.
|
||||
|
||||
\section1 Simple shader example
|
||||
\section1 Simple Shader Example
|
||||
|
||||
\snippet code/src_opengl_qglshaderprogram.cpp 1
|
||||
|
||||
@ -99,7 +99,7 @@ QT_BEGIN_NAMESPACE
|
||||
|
||||
\snippet code/src_opengl_qglshaderprogram.cpp 2
|
||||
|
||||
\section1 Binary shaders and programs
|
||||
\section1 Binary Shaders and Programs
|
||||
|
||||
Binary shaders may be specified using \c{glShaderBinary()} on
|
||||
the return value from QGLShader::shaderId(). The QGLShader instance
|
||||
|
@ -75,7 +75,7 @@ QT_BEGIN_NAMESPACE
|
||||
the default behavior suffices, some circumstances require greater control over the
|
||||
interaction with screen.
|
||||
|
||||
\section1 Window types
|
||||
\section1 Window Types
|
||||
|
||||
The QNX QPA plugin can operate in two modes, with or without a root window. The
|
||||
selection of mode is made via the \e rootwindow and \e no-rootwindow options to the
|
||||
|
@ -45,7 +45,7 @@ QT_BEGIN_NAMESPACE
|
||||
|
||||
\brief Class documentation of the Qt Lighthouse plugin for Windows.
|
||||
|
||||
\section1 Supported parameters
|
||||
\section1 Supported Parameters
|
||||
|
||||
The following parameters can be passed on to the -platform argument
|
||||
of QGuiApplication:
|
||||
|
@ -672,7 +672,7 @@
|
||||
|
||||
In this chapter we will see how to write a simple GUI test.
|
||||
|
||||
\section1 Writing a GUI test
|
||||
\section1 Writing a GUI Test
|
||||
|
||||
This time, let's assume you want to test the behavior of our
|
||||
QLineEdit class. As before, you will need a class that contains
|
||||
|
@ -166,7 +166,7 @@ the notifier.
|
||||
|
||||
\snippet examples/cpp.qdoc.sample overloaded notifier
|
||||
|
||||
\section1 Enums, Namespaces, and other Types
|
||||
\section1 Enums, Namespaces, and Other Types
|
||||
|
||||
Enums, namespaces, and macros have a \l{writing-topic-commands}{topic command} for their documentation:
|
||||
\list
|
||||
|
@ -39,7 +39,7 @@
|
||||
documentation build process is still under consideration. This section will be updated
|
||||
as the decisions are made.
|
||||
|
||||
\section1 What is a DITA map?
|
||||
\section1 What is a DITA Map?
|
||||
|
||||
A complete description of DITA can be found at the
|
||||
\l{http://www.oasis-open.org/committees/tc_home.php?wg_abbrev=dita}
|
||||
@ -107,7 +107,7 @@
|
||||
\mapref {Creator Manual} {creator-manual.ditamap} \endmapref
|
||||
\endcode
|
||||
|
||||
\section1 An example ditamap page
|
||||
\section1 An Example Ditamap Page
|
||||
|
||||
The following example uses the three qdoc ditamap commands described above.
|
||||
|
||||
@ -131,7 +131,7 @@
|
||||
\endtopicref
|
||||
\endcode
|
||||
|
||||
\section1 The resulting ditamap file
|
||||
\section1 The Resulting Ditamap File
|
||||
|
||||
This is the \e{.ditamap} file you get when you input the qdoc
|
||||
ditamap page shown above. Note that you can write ditamap files
|
||||
|
@ -107,7 +107,7 @@
|
||||
See \l{The QDoc Configuration File} for instructions on how to
|
||||
set up a QDoc configuration file.
|
||||
|
||||
\section1 How QDoc works
|
||||
\section1 How QDoc Works
|
||||
|
||||
QDoc begins by reading the configuration file you specified on the
|
||||
command line. It stores all the variables from the configuration
|
||||
|
@ -1126,7 +1126,7 @@
|
||||
erroneous documentation due to non-standard C++ constructs.
|
||||
|
||||
\target Cpp.ignoredirectives-variable
|
||||
\section1 Cpp.ignoredirectives
|
||||
\section1 Cpp.ignoredirectives
|
||||
The \c Cpp.ignoredirectives variable makes QDoc ignore the
|
||||
specified non-standard constructs, within C++ source code.
|
||||
|
||||
@ -1177,7 +1177,7 @@
|
||||
See also \l Cpp.ignoretokens.
|
||||
|
||||
\target Cpp.ignoretokens-variable
|
||||
\section1 Cpp.ignoretokens
|
||||
\section1 Cpp.ignoretokens
|
||||
|
||||
The \c Cpp.ignoretokens variable makes QDoc ignore the specified
|
||||
non-standard constructs, within C++ source code.
|
||||
|
@ -214,7 +214,7 @@
|
||||
classes, such as QListView, QTableView, and QTreeView with
|
||||
QStandardItemModel.
|
||||
|
||||
\section1 Using models and views
|
||||
\section1 Using Models and Views
|
||||
|
||||
The following sections explain how to use the model/view pattern
|
||||
in Qt. Each section includes an example and is followed by a
|
||||
@ -282,7 +282,7 @@
|
||||
of items. This subject is covered in more detail in the section about
|
||||
\l{Handling Selections in Item Views}.
|
||||
|
||||
\section1 Model classes
|
||||
\section1 Model Classes
|
||||
|
||||
Before examining how selections are handled, you may find it
|
||||
useful to examine the concepts used in the model/view framework.
|
||||
@ -518,7 +518,7 @@
|
||||
section, we demonstrate this by creating a convenient ready-to-use
|
||||
model for holding lists of strings.
|
||||
|
||||
\section1 View classes
|
||||
\section1 View Classes
|
||||
|
||||
\section2 Concepts
|
||||
|
||||
@ -678,7 +678,7 @@
|
||||
each view; for example, a contiguous selection in a table view can be
|
||||
represented as a fragmented set of highlighted items in a tree view.
|
||||
|
||||
\section1 Delegate classes
|
||||
\section1 Delegate Classes
|
||||
|
||||
\section2 Concepts
|
||||
|
||||
@ -863,7 +863,7 @@
|
||||
be less integrated into applications, and will be less usable than
|
||||
those that emit hints to support common editing actions.
|
||||
|
||||
\section1 Handling selections in item views
|
||||
\section1 Handling Selections in Item Views
|
||||
|
||||
\section2 Concepts
|
||||
|
||||
@ -1139,7 +1139,7 @@
|
||||
determine whether any given item is the parent of another level of
|
||||
items.
|
||||
|
||||
\section1 Creating new models
|
||||
\section1 Creating New Models
|
||||
|
||||
The separation of functionality between the model/view components allows
|
||||
models to be created that can take advantage of existing views. This
|
||||
@ -1405,7 +1405,7 @@
|
||||
virtual functions that must be implemented to enable various features in
|
||||
different types of models.
|
||||
|
||||
\section1 Item view convenience classes
|
||||
\section1 Item View Convenience Classes
|
||||
|
||||
The item-based widgets have names which reflect their uses:
|
||||
\c QListWidget provides a list of items, \c QTreeWidget displays a
|
||||
@ -1832,7 +1832,7 @@
|
||||
|
||||
\sa {itemviews/puzzle}{Item Views Puzzle Example}
|
||||
|
||||
\section1 Proxy models
|
||||
\section1 Proxy Models
|
||||
|
||||
In the model/view framework, items of data supplied by a single model can be shared
|
||||
by any number of views, and each of these can possibly represent the same information
|
||||
@ -1917,7 +1917,7 @@
|
||||
\l{QSortFilterProxyModel::lessThan()}{lessThan()} function to perform custom
|
||||
comparisons.
|
||||
|
||||
\section1 Model subclassing reference
|
||||
\section1 Model Subclassing Reference
|
||||
|
||||
Model subclasses need to provide implementations of many of the virtual functions
|
||||
defined in the QAbstractItemModel base class. The number of these functions that need
|
||||
@ -2299,7 +2299,7 @@
|
||||
false and does nothing.
|
||||
|
||||
\keyword Model/View Classes
|
||||
\section1 The model/view classes
|
||||
\section1 The Model/View Classes
|
||||
|
||||
These classes use the model/view design pattern in which the
|
||||
underlying data (in the model) is kept separate from the way the
|
||||
@ -2307,7 +2307,7 @@
|
||||
|
||||
\annotatedlist model-view
|
||||
|
||||
\section1 Related examples
|
||||
\section1 Related Examples
|
||||
|
||||
\list
|
||||
\li \l{itemviews/dirview}{Dir View}
|
||||
|
@ -84,7 +84,7 @@
|
||||
|
||||
\annotatedlist appearance
|
||||
|
||||
\section1 The QStyle implementation
|
||||
\section1 The QStyle Implementation
|
||||
|
||||
The API of QStyle contains functions that draw the widgets, static
|
||||
helper functions to do common and difficult tasks (e.g.,
|
||||
|
@ -512,7 +512,7 @@
|
||||
In contrast, setting a font and propagate using QWidget::setFont() and
|
||||
QWidget::setPalette() propagates to child widgets.
|
||||
|
||||
\section1 Widgets inside C++ namespaces
|
||||
\section1 Widgets Inside C++ Namespaces
|
||||
|
||||
The Type Selector can be used to style widgets of a particular type. For
|
||||
example,
|
||||
@ -528,7 +528,7 @@
|
||||
|
||||
\snippet code/doc_src_stylesheet.cpp 27
|
||||
|
||||
\section1 Setting QObject properties
|
||||
\section1 Setting QObject Properties
|
||||
|
||||
From 4.3 and above, any designable Q_PROPERTY
|
||||
can be set using the qproperty-<property name> syntax.
|
||||
@ -3549,7 +3549,7 @@
|
||||
[Hint: The \l{The Style Sheet Syntax#Conflict Resolution}{Conflict Resolution} section above explains
|
||||
what happens in cases like this.]
|
||||
|
||||
\section1 Customizing specific widgets
|
||||
\section1 Customizing Specific Widgets
|
||||
|
||||
This section provides examples to customize specific widgets using Style Sheets.
|
||||
|
||||
@ -3930,7 +3930,7 @@
|
||||
\sa {Style Sheet Example}, {Supported HTML Subset}, QStyle
|
||||
|
||||
|
||||
\section1 Common mistakes
|
||||
\section1 Common Mistakes
|
||||
|
||||
This section lists some common mistakes when using stylesheets.
|
||||
|
||||
|
@ -54,7 +54,7 @@
|
||||
This means that when you delete a window widget, all the child
|
||||
widgets it contains are also deleted.
|
||||
|
||||
\section1 Writing a main Function
|
||||
\section1 Writing a Main Function
|
||||
|
||||
Many of the GUI examples provided with Qt follow the pattern of
|
||||
having a \c{main.cpp} file, which contains the standard code to
|
||||
@ -72,7 +72,7 @@
|
||||
function returns. Finally, \c{main()} returns the value returned
|
||||
by QApplication::exec().
|
||||
|
||||
\section1 Simple widget examples
|
||||
\section1 Simple Widget Examples
|
||||
|
||||
Each of theses simple widget examples is written entirely within
|
||||
the \c main() function.
|
||||
@ -87,7 +87,7 @@
|
||||
\li \l {tutorials/widgets/nestedlayouts} {Nested layouts}
|
||||
\endlist
|
||||
|
||||
\section1 Real world widget examples
|
||||
\section1 Real World Widget Examples
|
||||
|
||||
In these \l{Qt Widgets Examples} {more advanced examples}, the code
|
||||
that creates the widgets and layouts is stored in other files. For
|
||||
|
@ -92,7 +92,7 @@
|
||||
If the spacing is negative, the items will overlap to some extent.
|
||||
|
||||
|
||||
\section1 Known issues
|
||||
\section1 Known Issues
|
||||
There are some features that QGraphicsAnchorLayout currently does not support.
|
||||
This might change in the future, so avoid using these features if you want to
|
||||
avoid any future regressions in behaviour:
|
||||
|
@ -149,7 +149,7 @@ QT_BEGIN_NAMESPACE
|
||||
|
||||
\endlist
|
||||
|
||||
\section1 OpenGL function calls, headers and QOpenGLFunctions
|
||||
\section1 OpenGL Function Calls, Headers and QOpenGLFunctions
|
||||
|
||||
When making OpenGL function calls, it is strongly recommended to avoid calling
|
||||
the functions directly. Instead, prefer using QOpenGLFunctions (when making
|
||||
@ -177,7 +177,7 @@ QT_BEGIN_NAMESPACE
|
||||
feasible. This means that constants and function pointer typedefs from ARB,
|
||||
EXT, OES extensions are automatically available.
|
||||
|
||||
\section1 Code examples
|
||||
\section1 Code Examples
|
||||
|
||||
To get started, the simplest QOpenGLWidget subclass could like like the following:
|
||||
|
||||
@ -282,7 +282,7 @@ QT_BEGIN_NAMESPACE
|
||||
fully controlled by the thread, e.g. an additional framebuffer object, and
|
||||
blitting to the QOpenGLWidget's framebuffer at a suitable time.
|
||||
|
||||
\section1 Context sharing
|
||||
\section1 Context Sharing
|
||||
|
||||
When multiple QOpenGLWidgets are added as children to the same top-level
|
||||
widget, their contexts will share with each other. This does not apply for
|
||||
@ -311,7 +311,7 @@ QT_BEGIN_NAMESPACE
|
||||
created later. Some other drivers may behave in unexpected ways when trying to
|
||||
utilize shared resources between different threads.
|
||||
|
||||
\section1 Resource initialization and cleanup
|
||||
\section1 Resource Initialization and Cleanup
|
||||
|
||||
The QOpenGLWidget's associated OpenGL context is guaranteed to be current
|
||||
whenever initializeGL() and paintGL() are invoked. Do not attempt to create
|
||||
|
@ -1304,7 +1304,7 @@ void QMenu::initStyleOption(QStyleOptionMenuItem *option, const QAction *action)
|
||||
do not support the signals: aboutToHide (), aboutToShow () and hovered ().
|
||||
It is not possible to display an icon in a native menu on Windows Mobile.
|
||||
|
||||
\section1 QMenu on Mac OS X with Qt build against Cocoa
|
||||
\section1 QMenu on Mac OS X with Qt Build Against Cocoa
|
||||
|
||||
QMenu can be inserted only once in a menu/menubar. Subsequent insertions will
|
||||
have no effect or will result in a disabled menu item.
|
||||
|
Loading…
x
Reference in New Issue
Block a user