wex::ctags_entry Class Reference

Offers information about a specific tag (see tagEntry). More...

#include <wex/ctags/ctags-entry.h>

Public Member Functions
	ctags_entry ()
	Default constructor.
const auto &	access () const
	Returns access member.
ctags_entry &	access (const std::string &v)
	Sets access member.
const auto &	class_name () const
	Returns class member.
ctags_entry &	class_name (const std::string &v)
	Sets class member.
void	clear ()
	Clears the members.
auto &	entry ()
	Returns entry.
const auto &	entry () const
	Returns const entry.
const std::string	entry_string (size_t min_size) const
	Returns complete entry as a string.
const std::string	filter () const
	Returns filter name.
ctags_entry &	filter (const ctags_entry &entry)
	Sets filter.
bool	is_active () const
	Returns true if one of the members is filled.
bool	is_class_name () const
	C++ these kinds are recommended:
bool	is_define () const
bool	is_enumerator () const
bool	is_enumeration_name () const
bool	is_file_name () const
bool	is_function () const
bool	is_function_or_prototype () const
	Combination.
bool	is_function_prototype () const
bool	is_master () const
	Returns true if this is a master entry.
bool	is_member () const
bool	is_structure_name () const
bool	is_typedef () const
bool	is_union_name () const
bool	is_variable () const
auto &	kind () const
	Returns kind.
ctags_entry &	kind (const std::string &v)
	Sets kind of tag.
const std::stringstream	log () const
	Logs info about this entry.
const auto &	signature () const
	Returns signature member.
ctags_entry &	signature (const std::string &v)
	Sets signature member.

Static Public Member Functions
static void	register_image (wxStyledTextCtrl *stc)
	Register image on stc component.

Detailed Description

Offers information about a specific tag (see tagEntry).

Member Function Documentation

entry_string()

const std::string wex::ctags_entry::entry_string

(

size_t

min_size

)

const

Returns complete entry as a string.

Contains image and name, and might assign the signature.

is_class_name()

bool wex::ctags_entry::is_class_name ( ) const

inline

C++ these kinds are recommended:

• c class name

is_define()

bool wex::ctags_entry::is_define ( ) const

inline

• d define (from define XXX)

is_enumeration_name()

bool wex::ctags_entry::is_enumeration_name ( ) const

inline

• g enumeration name

is_enumerator()

bool wex::ctags_entry::is_enumerator ( ) const

inline

• e enumerator

is_file_name()

bool wex::ctags_entry::is_file_name ( ) const

inline

• F file name

is_function()

bool wex::ctags_entry::is_function ( ) const

inline

• f function or method name

is_function_prototype()

bool wex::ctags_entry::is_function_prototype ( ) const

inline

• p function prototype

is_member()

bool wex::ctags_entry::is_member ( ) const

inline

• m member (of structure or class data)

is_structure_name()

bool wex::ctags_entry::is_structure_name ( ) const

inline

• s structure name

is_typedef()

bool wex::ctags_entry::is_typedef ( ) const

inline

• t typedef

is_union_name()

bool wex::ctags_entry::is_union_name ( ) const

inline

• u union name

is_variable()

bool wex::ctags_entry::is_variable ( ) const

inline

• v variable

kind()

ctags_entry & wex::ctags_entry::kind

(

const std::string &

v

)

Sets kind of tag.

The value depends on the language. For C and C++ these kinds are recommended:

• c class name
• d define (from define XXX)
• e enumerator
• f function or method name
• F file name
• g enumeration name
• m member (of structure or class data)
• p function prototype
• s structure name
• t typedef
• u union name
• v variable