forked from qt-creator/qt-creator
26c412deac
QDoc cannot find functions if the signature in the \fn command is not identical to the declaration, including 'const' qualifiers. Removed the \fn where the documentation comes immediately before the function, as qdoc does not need it in that case. Change-Id: If6a2a2e2d58b394905c803787d2a93489049e4ca Reviewed-by: Eike Ziller <eike.ziller@digia.com>
101 lines
3.3 KiB
C++
101 lines
3.3 KiB
C++
/****************************************************************************
|
|
**
|
|
** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
|
|
** Contact: http://www.qt-project.org/legal
|
|
**
|
|
** This file is part of Qt Creator.
|
|
**
|
|
** Commercial License Usage
|
|
** Licensees holding valid commercial Qt licenses may use this file in
|
|
** accordance with the commercial license agreement provided with the
|
|
** Software or, alternatively, in accordance with the terms contained in
|
|
** a written agreement between you and Digia. For licensing terms and
|
|
** conditions see http://qt.digia.com/licensing. For further information
|
|
** use the contact form at http://qt.digia.com/contact-us.
|
|
**
|
|
** GNU Lesser General Public License Usage
|
|
** Alternatively, this file may be used under the terms of the GNU Lesser
|
|
** General Public License version 2.1 as published by the Free Software
|
|
** Foundation and appearing in the file LICENSE.LGPL included in the
|
|
** packaging of this file. Please review the following information to
|
|
** ensure the GNU Lesser General Public License version 2.1 requirements
|
|
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
|
|
**
|
|
** In addition, as a special exception, Digia gives you certain additional
|
|
** rights. These rights are described in the Digia Qt LGPL Exception
|
|
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
|
|
**
|
|
****************************************************************************/
|
|
|
|
#include "iassistinterface.h"
|
|
|
|
using namespace TextEditor;
|
|
|
|
/*!
|
|
\class TextEditor::IAssistInterface
|
|
\brief The IAssistInterface class acts as an interface for providing access to the document
|
|
from which a proposal is computed.
|
|
\ingroup CodeAssist
|
|
|
|
This interface existis in order to avoid a direct dependency on the text editor. This is
|
|
particularly important and safer for asynchronous providers, since in such cases computation
|
|
of the proposal is not done in the GUI thread.
|
|
|
|
In general this API tries to be as decoupled as possible from the base text editor.
|
|
This is in order to make the design a bit more generic and allow code assist to be
|
|
pluggable into different types of documents (there are still issues to be treated).
|
|
|
|
This class is part of the CodeAssist API.
|
|
|
|
\sa IAssistProposal, IAssistProvider, IAssistProcessor
|
|
*/
|
|
|
|
IAssistInterface::IAssistInterface()
|
|
{}
|
|
|
|
IAssistInterface::~IAssistInterface()
|
|
{}
|
|
|
|
/*!
|
|
\fn int TextEditor::IAssistInterface::position() const
|
|
|
|
Returns the cursor position.
|
|
*/
|
|
|
|
/*!
|
|
\fn QChar TextEditor::IAssistInterface::characterAt(int position) const
|
|
|
|
Returns the character at \a position.
|
|
*/
|
|
|
|
/*!
|
|
\fn QString TextEditor::IAssistInterface::textAt(int position, int length) const
|
|
|
|
Returns the text at \a position with the given \a length.
|
|
*/
|
|
|
|
/*!
|
|
\fn QString TextEditor::IAssistInterface::fileName() const
|
|
|
|
Returns the file associated.
|
|
*/
|
|
|
|
/*!
|
|
\fn QTextDocument *TextEditor::IAssistInterface::textDocument() const
|
|
Returns the document.
|
|
*/
|
|
|
|
/*!
|
|
\fn void TextEditor::IAssistInterface::detach(QThread *destination)
|
|
|
|
Detaches the interface. If it is necessary to take any special care in order to allow
|
|
this interface to be run in a separate thread \a destination this needs to be done
|
|
in this method.
|
|
*/
|
|
|
|
/*!
|
|
\fn AssistReason TextEditor::IAssistInterface::reason() const
|
|
|
|
The reason which triggered the assist.
|
|
*/
|