Commit 510cae20 authored by Thorbjørn Lindeijer's avatar Thorbjørn Lindeijer
Browse files

Updated ICore documentation to recent additional contexts API change

Reviewed-by: con
parent a4e31396
...@@ -255,40 +255,25 @@ ...@@ -255,40 +255,25 @@
\fn IContext *ICore::currentContextObject() const \fn IContext *ICore::currentContextObject() const
\brief Returns the context object of the current main context. \brief Returns the context object of the current main context.
\sa ICore::addAdditionalContext() \sa ICore::updateAdditionalContexts()
\sa ICore::addContextObject() \sa ICore::addContextObject()
*/ */
/*! /*!
\fn void ICore::addAdditionalContext(int context) \fn void ICore::updateAdditionalContexts(const QList<int> &remove, const QList<int> &add)
\brief Register additional context to be currently active. \brief Change the currently active additional contexts.
Appends the additional \a context to the list of currently active Removes the list of additional contexts specified by \a remove and adds the
contexts. You need to call ICore::updateContext to make that change list of additional contexts specified by \a add.
take effect.
\sa ICore::removeAdditionalContext()
\sa ICore::hasContext() \sa ICore::hasContext()
\sa ICore::updateContext()
*/
/*!
\fn void ICore::removeAdditionalContext(int context)
\brief Removes the given \a context from the list of currently active contexts.
You need to call ICore::updateContext to make that change
take effect.
\sa ICore::addAdditionalContext()
\sa ICore::hasContext()
\sa ICore::updateContext()
*/ */
/*! /*!
\fn bool ICore::hasContext(int context) const \fn bool ICore::hasContext(int context) const
\brief Returns if the given \a context is currently one of the active contexts. \brief Returns if the given \a context is currently one of the active contexts.
\sa ICore::addAdditionalContext() \sa ICore::updateAdditionalContexts()
\sa ICore::addContextObject() \sa ICore::addContextObject()
*/ */
...@@ -300,7 +285,7 @@ ...@@ -300,7 +285,7 @@
current context object whenever its widget gets focus. current context object whenever its widget gets focus.
\sa ICore::removeContextObject() \sa ICore::removeContextObject()
\sa ICore::addAdditionalContext() \sa ICore::updateAdditionalContexts()
\sa ICore::currentContextObject() \sa ICore::currentContextObject()
*/ */
...@@ -309,19 +294,11 @@ ...@@ -309,19 +294,11 @@
\brief Unregisters a \a context object from the list of know contexts. \brief Unregisters a \a context object from the list of know contexts.
\sa ICore::addContextObject() \sa ICore::addContextObject()
\sa ICore::addAdditionalContext() \sa ICore::updateAdditionalContexts()
\sa ICore::currentContextObject() \sa ICore::currentContextObject()
} }
*/ */
/*!
\fn void ICore::updateContext()
\brief Update the list of active contexts after adding or removing additional ones.
\sa ICore::addAdditionalContext()
\sa ICore::removeAdditionalContext()
*/
/*! /*!
\fn void ICore::openFiles(const QStringList &fileNames) \fn void ICore::openFiles(const QStringList &fileNames)
\brief Open all files from a list of \a fileNames like it would be \brief Open all files from a list of \a fileNames like it would be
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment