| CMakeLists.txt |
|
2618 |
- |
| doc |
|
|
- |
| images |
|
|
- |
| qcompressedhelpinfo.cpp |
!
\class QCompressedHelpInfo
\since 5.13
\inmodule QtHelp
\brief The QCompressedHelpInfo class provides access to
the details about a compressed help file.
The detailed information about the compressed
help file can be fetched by calling the fromCompressedHelpFile()
static method, providing the path to the compressed
help file.
The class provides access to various information about a compressed help file.
The namespace associated with the given compressed help file is
namespaceName(), the associated component name is component()
and version() provides version information.
\sa QHelpFilterEngine
|
4153 |
- |
| qcompressedhelpinfo.h |
|
1190 |
- |
| qfilternamedialog.cpp |
|
1093 |
- |
| qfilternamedialog.ui |
|
1416 |
- |
| qfilternamedialog_p.h |
|
963 |
- |
| qhelp_global.cpp |
|
1528 |
- |
| qhelp_global.h |
|
846 |
- |
| qhelpcollectionhandler.cpp |
|
83327 |
- |
| qhelpcollectionhandler_p.h |
|
7717 |
- |
| qhelpcontentitem.cpp |
!
\class QHelpContentItem
\inmodule QtHelp
\brief The QHelpContentItem class provides an item for use with QHelpContentModel.
\since 4.4
|
2061 |
- |
| qhelpcontentitem.h |
|
1005 |
- |
| qhelpcontentwidget.cpp |
!
\class QHelpContentModel
\inmodule QtHelp
\brief The QHelpContentModel class provides a model that supplies content to views.
\since 4.4
|
8338 |
- |
| qhelpcontentwidget.h |
|
1983 |
- |
| qhelpdbreader.cpp |
: The placeholders are: %1 - The name of the database which cannot be opened
%2 - The unique id for the connection
%3 - The actual error string |
18872 |
- |
| qhelpdbreader_p.h |
|
2797 |
- |
| qhelpengine.cpp |
!
\class QHelpEngine
\since 4.4
\inmodule QtHelp
\brief The QHelpEngine class provides access to contents and
indices of the help engine.
|
4367 |
- |
| qhelpengine.h |
|
955 |
- |
| qhelpenginecore.cpp |
!
\class QHelpEngineCore
\since 4.4
\inmodule QtHelp
\brief The QHelpEngineCore class provides the core functionality
of the help system.
Before the help engine can be used, it must be initialized by
calling setupData(). At the beginning of the setup process the
signal setupStarted() is emitted. From this point on until
the signal setupFinished() is emitted, is the help data in an
undefined meaning unusable state.
The core help engine can be used to perform different tasks.
By calling documentsForIdentifier() the engine returns
URLs specifying the file locations inside the help system. The
actual file data can then be retrieved by calling fileData().
The help engine can contain any number of custom filters.
The management of the filters, including adding new filters,
changing filter definitions, or removing existing filters,
is done through the QHelpFilterEngine class, which can be accessed
by the filterEngine() method.
\note QHelpFilterEngine replaces the older filter API that is
deprecated since Qt 5.13. Call setUsesFilterEngine() with \c true to
enable the new functionality.
The core help engine has two modes:
\list
\li Read-only mode, where the help collection file is not changed
unless explicitly requested. This also works if the
collection file is in a read-only location,
and is the default.
\li Fully writable mode, which requires the help collection
file to be writable.
\endlist
The mode can be changed by calling setReadOnly() method, prior to
calling setupData().
The help engine also offers the possibility to set and read values
in a persistent way comparable to ini files or Windows registry
entries. For more information see \l setCustomValue() or \l customValue().
This class does not offer any GUI components or functionality for
indices or contents. If you need one of those use QHelpEngine
instead.
|
30717 |
- |
| qhelpenginecore.h |
|
4212 |
- |
| qhelpfilterdata.cpp |
!
\class QHelpFilterData
\since 5.13
\inmodule QtHelp
\brief The QHelpFilterData class provides details for the filters
used by QHelpFilterEngine.
By using setComponents() you may constrain the search results to
documents that belong only to components specified on the given list.
By using setVersions() you may constrain the search results to
documents that belong only to versions specified on the given list.
\sa QHelpFilterEngine
|
3155 |
- |
| qhelpfilterdata.h |
|
1144 |
- |
| qhelpfilterengine.cpp |
!
\class QHelpFilterEngine
\since 5.13
\inmodule QtHelp
\brief The QHelpFilterEngine class provides a filtered view of the
help contents.
The filter engine allows the management of filters associated with
a QHelpEngineCore instance. The help engine internally creates an
instance of the filter engine, which can be accessed by calling
QHelpEngineCore::filterEngine(). Therefore, the public constructor
of this class is disabled.
The filters are identified by a filter name string. Filter details are
described by the \l QHelpFilterData class.
The filter engine allows for adding new filters and changing the existing
filters' data through the setFilterData() method. An existing filter can
be removed through the removeFilter() method.
Out of the registered filters one can be marked as the active one.
The active filter will be used by the associated help engine for returning
filtered results of many different functions, such as content, index, or
search results. If no filter is marked active, the help engine returns the
full results list available.
The active filter is returned by activeFilter() and it can be changed by
setActiveFilter().
\sa QHelpEngineCore
|
8047 |
- |
| qhelpfilterengine.h |
|
1669 |
- |
| qhelpfiltersettingswidget.cpp |
|
16331 |
- |
| qhelpfiltersettingswidget.h |
|
1223 |
- |
| qhelpfiltersettingswidget.ui |
|
2216 |
- |
| qhelpindexwidget.cpp |
!
\class QHelpIndexModel
\since 4.4
\inmodule QtHelp
\brief The QHelpIndexModel class provides a model that
supplies index keywords to views.
|
8914 |
- |
| qhelpindexwidget.h |
|
1997 |
- |
| qhelplink.cpp |
!
\class QHelpLink
\since 5.15
\inmodule QtHelp
\brief The QHelpLink struct provides the data associated with a help link.
The QHelpLink object is a data object that describes a link to a documentation file.
The description of the help link contains the document title and URL of the document.
\sa QHelpEngineCore
|
713 |
- |
| qhelplink.h |
|
429 |
- |
| qhelpsearchengine.cpp |
!
\class QHelpSearchQuery
\deprecated
\since 4.4
\inmodule QtHelp
\brief The QHelpSearchQuery class contains the field name and the associated
search term.
The QHelpSearchQuery class contains the field name and the associated search
term. Depending on the field the search term might get split up into separate
terms to be parsed differently by the search engine.
\note This class has been deprecated in favor of QString.
\sa QHelpSearchQueryWidget
|
10452 |
- |
| qhelpsearchengine.h |
|
2405 |
- |
| qhelpsearchenginecore.cpp |
!
\class QHelpSearchEngineCore
\since 6.8
\inmodule QtHelp
\brief The QHelpSearchEngineCore class provides access to index and
search documentation.
Before the search engine can be used, one has to instantiate at least a
QHelpEngineCore object that needs to be passed to the search engines constructor.
This is required as the search engine needs to be connected to the help
engines setupFinished() signal to know when it can start to index documentation.
After starting the indexing process the signal indexingStarted() is emitted and
on the end of the indexing process the indexingFinished() is emitted. To stop
the indexing one can call cancelIndexing().
When the indexing process has finished, the search engine can be used to
search through the index for a given term using the search() function. When
the search input is passed to the search engine, the searchingStarted()
signal is emitted. When the search finishes, the searchingFinished() signal
is emitted. The search process can be stopped by calling cancelSearching().
If the search succeeds, searchingFinished() is called with the search result
count to fetch the search results from the search engine. Calling the
searchResults() function with a range returns a list of QHelpSearchResult
objects within the range. The results consist of the document title and URL,
as well as a snippet from the document that contains the best match for the
search input.
|
8863 |
- |
| qhelpsearchenginecore.h |
|
1244 |
- |
| qhelpsearchindexreader.cpp |
|
9229 |
- |
| qhelpsearchindexreader_p.h |
|
1557 |
- |
| qhelpsearchindexwriter.cpp |
|
15999 |
- |
| qhelpsearchindexwriter_p.h |
|
1268 |
- |
| qhelpsearchquerywidget.cpp |
!
\class QHelpSearchQueryWidget
\since 4.4
\inmodule QtHelp
\brief The QHelpSearchQueryWidget class provides a simple line edit or
an advanced widget to enable the user to input a search term in a
standardized input mask.
|
9620 |
- |
| qhelpsearchquerywidget.h |
|
1287 |
- |
| qhelpsearchresult.cpp |
!
\class QHelpSearchResult
\since 5.9
\inmodule QtHelp
\brief The QHelpSearchResult class provides the data associated with the
search result.
The QHelpSearchResult object is a data object that describes a single search result.
The vector of search result objects is returned by QHelpSearchEngine::searchResults().
The description of the search result contains the document title and URL
that the search input matched. It also contains the snippet from
the document content containing the best match of the search input.
\sa QHelpSearchEngine
|
2310 |
- |
| qhelpsearchresult.h |
|
890 |
- |
| qhelpsearchresultwidget.cpp |
name |
9102 |
- |
| qhelpsearchresultwidget.h |
|
915 |
- |
| qoptionswidget.cpp |
|
6274 |
- |
| qoptionswidget_p.h |
|
1767 |
- |