cbCodeCompletionPlugin::CCToken Struct Reference

Structure representing a generic token, passed between CC plugins and CCManager. More...

#include <cbplugin.h>

Collaboration diagram for cbCodeCompletionPlugin::CCToken:

Public Member Functions
	CCToken (int _id, const wxString &dispNm, int categ=-1)
	Convenience constructor. More...
	CCToken (int _id, const wxString &dispNm, const wxString &nm, int _weight, int categ=-1)
	Construct a fully specified CCToken. More...

Public Attributes
int	id
	CCManager will pass this back unmodified. Use it as an internal identifier for the token. More...
int	category
	The category corresponding to the index of the registered image (during autocomplete). More...
int	weight
	Lower numbers are placed earlier in listing, 5 is default; try to keep 0-10. More...
wxString	displayName
	Verbose string representing the token. More...
wxString	name
	Minimal name of the token that CCManager may choose to display in restricted circumstances. More...

Detailed Description

Structure representing a generic token, passed between CC plugins and CCManager.

Definition at line 746 of file cbplugin.h.

Constructor & Destructor Documentation

CCToken() [1/2]

cbCodeCompletionPlugin::CCToken::CCToken ( int  _id, const wxString &  dispNm, int  categ = -1  )

inline

Convenience constructor.

Represents a generic token, passed between CC plugins and CCManager.

Parameters

_id	Internal identifier for a CC plugin to reference the token in its data structure.
dispNm	The string CCManager will use to display this token.
categ	The category corresponding to the index of the registered image (during autocomplete). Negative values are reserved for CCManager.

Definition at line 757 of file cbplugin.h.

CCToken() [2/2]

cbCodeCompletionPlugin::CCToken::CCToken ( int  _id, const wxString &  dispNm, const wxString &  nm, int  _weight, int  categ = -1  )

inline

Construct a fully specified CCToken.

Represents a generic token, passed between CC plugins and CCManager.

Parameters

_id	Internal identifier for a CC plugin to reference the token in its data structure.
dispNm	The verbose string CCManager will use to display this token.
nm	Minimal name of the token that CCManager may choose to display in restricted circumstances.
_weight	Lower numbers are placed earlier in listing, 5 is default; try to keep 0-10.
categ	The category corresponding to the index of the registered image (during autocomplete). Negative values are reserved for CCManager.

Definition at line 771 of file cbplugin.h.

Member Data Documentation

category

int cbCodeCompletionPlugin::CCToken::category

The category corresponding to the index of the registered image (during autocomplete).

Definition at line 775 of file cbplugin.h.

displayName

wxString cbCodeCompletionPlugin::CCToken::displayName

Verbose string representing the token.

Definition at line 777 of file cbplugin.h.

Referenced by CodeCompletion::DoAutocomplete(), CCManager::DoBufferedCC(), and TokenSorter::operator()().

id

int cbCodeCompletionPlugin::CCToken::id

CCManager will pass this back unmodified. Use it as an internal identifier for the token.

Definition at line 774 of file cbplugin.h.

Referenced by CodeCompletion::GetDocumentation().

name

wxString cbCodeCompletionPlugin::CCToken::name

Minimal name of the token that CCManager may choose to display in restricted circumstances.

Definition at line 778 of file cbplugin.h.

weight

int cbCodeCompletionPlugin::CCToken::weight

Lower numbers are placed earlier in listing, 5 is default; try to keep 0-10.

Definition at line 776 of file cbplugin.h.

Referenced by TokenSorter::operator()().

---

The documentation for this struct was generated from the following file:

• cbplugin.h