NumeRe::CallTipProvider Class Reference

This class uses a global Language instance to obtain the language string associated with a distinct code symbol, prepares the layout of the calltip and returns the calltip with all necessary fields filled. More...

#include <calltipprovider.hpp>

Collaboration diagram for NumeRe::CallTipProvider:

Public Member Functions
	CallTipProvider (size_t nMaxLineLength=100u)
CallTip	getCommand (std::string sToken) const
	Get the calltip for the selected command. More...
CallTip	getFunction (std::string sToken) const
	Get the calltip for the selected (built-in) function. More...
CallTip	getProcedure (std::string sToken) const
	Get the calltip for the selected (global) procedure. More...
CallTip	getOption (std::string sToken) const
	Get the calltip for the selected option. More...
CallTip	getMethod (std::string sToken) const
	Get the calltip for the selected method. More...
CallTip	getPredef (std::string sToken) const
	Get the calltip for the selected predefined symbol. More...
CallTip	getConstant (std::string sToken) const
	Get the calltip for the selected constant. More...

Private Attributes
size_t	m_maxLineLength

Detailed Description

This class uses a global Language instance to obtain the language string associated with a distinct code symbol, prepares the layout of the calltip and returns the calltip with all necessary fields filled.

Definition at line 54 of file calltipprovider.hpp.

Constructor & Destructor Documentation

CallTipProvider()

NumeRe::CallTipProvider::CallTipProvider ( size_t  nMaxLineLength = 100u )

inline

Definition at line 60 of file calltipprovider.hpp.

Member Function Documentation

getCommand()

CallTip NumeRe::CallTipProvider::getCommand

(

std::string

sToken

)

const

Get the calltip for the selected command.

Parameters

sToken

std::string

Returns

CallTip

Definition at line 574 of file calltipprovider.cpp.

References _lang, NumeRe::addLinebreaks(), Language::get(), m_maxLineLength, NumeRe::realignLangString(), and toUpperCase().

Referenced by GenericTerminal::handle_calltip(), and NumeReEditor::OnMouseDwell().

Here is the call graph for this function:

getConstant()

CallTip NumeRe::CallTipProvider::getConstant

(

std::string

sToken

)

const

Get the calltip for the selected constant.

Parameters

sToken

std::string

Returns

CallTip

Definition at line 788 of file calltipprovider.cpp.

References _lang, Language::get(), NumeRe::CallTip::nEnd, NumeRe::CallTip::nStart, NumeRe::CallTip::sDefinition, and toUpperCase().

Referenced by GenericTerminal::handle_calltip(), and NumeReEditor::OnMouseDwell().

Here is the call graph for this function:

getFunction()

CallTip NumeRe::CallTipProvider::getFunction

(

std::string

sToken

)

const

Get the calltip for the selected (built-in) function.

Parameters

sToken

std::string

Returns

CallTip

Definition at line 639 of file calltipprovider.cpp.

References _lang, NumeRe::addLinebreaks(), Language::get(), m_maxLineLength, NumeRe::realignLangString(), and toUpperCase().

Referenced by GenericTerminal::handle_calltip(), NumeReEditor::HandleFunctionCallTip(), and NumeReEditor::OnMouseDwell().

Here is the call graph for this function:

getMethod()

CallTip NumeRe::CallTipProvider::getMethod

(

std::string

sToken

)

const

Get the calltip for the selected method.

Parameters

sToken

std::string

Returns

CallTip

Definition at line 752 of file calltipprovider.cpp.

References _lang, NumeRe::addLinebreaks(), Language::get(), m_maxLineLength, NumeRe::CallTip::nStart, NumeRe::realignLangString(), NumeRe::CallTip::sDefinition, and toUpperCase().

Referenced by GenericTerminal::handle_calltip(), NumeReEditor::HandleFunctionCallTip(), and NumeReEditor::OnMouseDwell().

Here is the call graph for this function:

getOption()

CallTip NumeRe::CallTipProvider::getOption

(

std::string

sToken

)

const

Get the calltip for the selected option.

Parameters

sToken

std::string

Returns

CallTip

Definition at line 731 of file calltipprovider.cpp.

References _lang, Language::get(), and toUpperCase().

Referenced by GenericTerminal::handle_calltip(), and NumeReEditor::OnMouseDwell().

Here is the call graph for this function:

getPredef()

CallTip NumeRe::CallTipProvider::getPredef

(

std::string

sToken

)

const

Get the calltip for the selected predefined symbol.

Parameters

sToken

std::string

Returns

CallTip

Definition at line 774 of file calltipprovider.cpp.

References _lang, NumeRe::addLinebreaks(), Language::get(), m_maxLineLength, NumeRe::realignLangString(), and toUpperCase().

Referenced by NumeReEditor::OnMouseDwell().

Here is the call graph for this function:

getProcedure()

CallTip NumeRe::CallTipProvider::getProcedure

(

std::string

sToken

)

const

Get the calltip for the selected (global) procedure.

Parameters

sToken

std::string

Returns

CallTip

Definition at line 667 of file calltipprovider.cpp.

References NumeRe::addLinebreaks(), NumeRe::FindProcedureDefinition(), NumeReKernel::getInstance(), Settings::getProcPath(), NumeReKernel::getSettings(), and m_maxLineLength.

Referenced by GenericTerminal::handle_calltip().

Here is the call graph for this function:

Member Data Documentation

m_maxLineLength

size_t NumeRe::CallTipProvider::m_maxLineLength

private

Definition at line 57 of file calltipprovider.hpp.

Referenced by getCommand(), getFunction(), getMethod(), getPredef(), and getProcedure().

---

The documentation for this class was generated from the following files:

• D:/CPP/numere-source/trunk/kernel/core/ui/calltipprovider.hpp
• D:/CPP/numere-source/trunk/kernel/core/ui/calltipprovider.cpp