xtd::forms::control_trace_listener Class Reference

Inheritance diagram for xtd::forms::control_trace_listener:

Definition

Directs tracing or debugging output to a icontrol_trace object.

Header

#include <xtd/forms/control_trace_listener>

Namespace

xtd::forms

Library

xtd.forms

Examples

Public Constructors
	control_trace_listener (xtd::forms::icontrol_trace &control_trace)
	Initializes a new instance of the control_trace_listener class with specified control_trace.

Public Properties
virtual xtd::forms::icontrol_trace &	control_trace () noexcept
	Gets icontroll_trace object.
virtual void	control_trace (xtd::forms::icontrol_trace &control_trace)
	Sets icontroll_trace object.

Public Methods
void	close () override
	When overridden in a derived class, closes the output stream so it no longer receives tracing or debugging output.
void	flush () override
	When overridden in a derived class, flushes the output buffer.
void	write (const xtd::string &message) override
	Writes the message to the listener you create when you implement the trace_listener class.
void	write_line (const xtd::string &message) override
	Writes the message to the listener you create when you implement the trace_listener class.

Public Static Methods
static xtd::sptr< xtd::diagnostics::trace_listener >	create (xtd::forms::icontrol_trace &control_trace)
	Create new control_trace_listener.

Additional Inherited Members
Public Member Functions inherited from xtd::diagnostics::trace_listener
	trace_listener ()=default
	Initializes a new instance of the trace_listener class.
	trace_listener (const xtd::string &name)
	Initializes a new instance of the trace_listener class using the specified name as the listener.
uint32	indent_level () const noexcept
	Gets the indent level.
void	indent_level (uint32 indent_level) noexcept
	Sets the indent level.
uint32	indent_size () const noexcept
	Gets the number of spaces in an indent.
void	indent_size (uint32 indent_size) noexcept
	Sets the number of spaces in an indent.
virtual bool	is_thread_safe () const noexcept
	Gets a value indicating whether the trace listener is thread safe.
const xtd::string &	name () const noexcept
	Gets or sets a name for this TraceListener.
void	name (const xtd::string &name) noexcept
	Sets a name for this TraceListener.
trace_options	trace_output_options () const noexcept
	Gets the trace output options.
void	trace_output_options (trace_options trace_output_options) noexcept
	Sets the trace output options.
virtual void	fail (const xtd::string &message)
	Emits an error message to the listener you create when you implement the TraceListener class.
virtual void	fail (const xtd::string &message, const xtd::string &detail_message)
	Emits the specified error message.
template<typename object >
void	trace_data (const xtd::diagnostics::trace_event_cache &event_cache, const xtd::string &source, const xtd::diagnostics::trace_event_type &event_type, int32 id, const object &data)
	Writes trace information, a data object and event information to the listener specific output.
template<typename object >
void	trace_data (const xtd::diagnostics::trace_event_cache &event_cache, const xtd::string &source, const xtd::diagnostics::trace_event_type &event_type, int32 id, const std::vector< object > &data)
	Writes trace information, a data object and event information to the listener specific output.
template<typename ... objects>
void	trace_data (const xtd::diagnostics::trace_event_cache &event_cache, const xtd::string &source, const xtd::diagnostics::trace_event_type &event_type, int32 id, const objects &... data)
	Writes trace information, an array of data objects and event information to the listener specific output.
virtual void	trace_event (const xtd::diagnostics::trace_event_cache &event_cache, const xtd::string &source, const xtd::diagnostics::trace_event_type &event_type, int32 id)
	Writes trace and event information to the listener specific output.
virtual void	trace_event (const xtd::diagnostics::trace_event_cache &event_cache, const xtd::string &source, const xtd::diagnostics::trace_event_type &event_type, int32 id, const xtd::string &message)
	Writes trace information, a message, and event information to the listener specific output.
template<typename ... objects>
void	trace_event (const xtd::diagnostics::trace_event_cache &event_cache, const xtd::string &source, const xtd::diagnostics::trace_event_type &event_type, int32 id, const xtd::string &format, const objects &... args)
	Writes trace information, a formatted array of objects and event information to the listener specific output.
template<typename activity_id_type >
void	trace_transfer (const xtd::diagnostics::trace_event_cache &event_cache, const xtd::string &source, int32 id, const xtd::string &message, const activity_id_type &related_activity_id)
	Writes trace information, a message, a related activity identity and event information to the listener specific output.
template<typename object >
void	write (const object &o)
	Writes the value of the object's ToString method to the listener you create when you implement the TraceListener class.
template<typename object >
void	write (const object &o, const xtd::string &category)
	Writes a category name and the value of the object's ToString method to the listener you create when you implement the TraceListener class.
template<typename object >
void	write_line (const object &o)
	Writes the value of the object's ToString method to the listener you create when you implement the TraceListener class.
template<typename object >
void	write_line (const object &o, const xtd::string &category)
	Writes a category name and the value of the object's ToString method to the listener you create when you implement the TraceListener class.
Public Member Functions inherited from xtd::object
	object ()=default
	Create a new instance of the ultimate base class object.
virtual bool	equals (const object &obj) const noexcept
	Determines whether the specified object is equal to the current object.
virtual size_t	get_hash_code () const noexcept
	Serves as a hash function for a particular type.
virtual type_object	get_type () const noexcept
	Gets the type of the current instance.
template<typename object_t >
xtd::uptr< object_t >	memberwise_clone () const
	Creates a shallow copy of the current object.
virtual xtd::string	to_string () const noexcept
	Returns a xtd::string that represents the current object.
Static Public Member Functions inherited from xtd::object
template<typename object_a_t , typename object_b_t >
static bool	equals (const object_a_t &object_a, const object_b_t &object_b) noexcept
	Determines whether the specified object instances are considered equal.
template<typename object_a_t , typename object_b_t >
static bool	reference_equals (const object_a_t &object_a, const object_b_t &object_b) noexcept
	Determines whether the specified object instances are the same instance.
Protected Member Functions inherited from xtd::diagnostics::trace_listener
bool	need_indent () const noexcept
	Gets a value indicating whether to indent the output.
void	need_indent (bool need_indent) noexcept
	Sets a value indicating whether to indent the output.
void	thread_safe (bool thread_safe) noexcept
	Sets a value indicating whether the trace listener is thread safe.
virtual void	write_indent ()
	Writes the indent to the listener you create when you implement this class, and resets the NeedIndent property to false.
Protected Member Functions inherited from xtd::abstract_object
	abstract_object ()=default
	Initializes a new instance of the xtd::abstract_object class.

Constructor & Destructor Documentation

control_trace_listener()

xtd::forms::control_trace_listener::control_trace_listener ( xtd::forms::icontrol_trace &  control_trace )

inline

Initializes a new instance of the control_trace_listener class with specified control_trace.

Parameters

control_trace

A control that inherits to the icontrol_trace interface.

See also

see xtd::forms::icontrol_trace interface.

Member Function Documentation

control_trace() [1/2]

virtual xtd::forms::icontrol_trace & xtd::forms::control_trace_listener::control_trace ( )

inlinevirtualnoexcept

Gets icontroll_trace object.

Returns

The icontrol_trace object used.

control_trace() [2/2]

virtual void xtd::forms::control_trace_listener::control_trace ( xtd::forms::icontrol_trace &  control_trace )

inlinevirtual

Sets icontroll_trace object.

Parameters

control_trace

The icontrol_trace object to use.

close()

void xtd::forms::control_trace_listener::close ( )

inlineoverridevirtual

When overridden in a derived class, closes the output stream so it no longer receives tracing or debugging output.

Remarks

Use this method when the output is going to a file, such as to the TextWriterTraceListener. After a call to this method, you must reinitialize the object.

Reimplemented from xtd::diagnostics::trace_listener.

flush()

void xtd::forms::control_trace_listener::flush ( )

inlineoverridevirtual

When overridden in a derived class, flushes the output buffer.

Reimplemented from xtd::diagnostics::trace_listener.

write()

void xtd::forms::control_trace_listener::write ( const xtd::string &  message )

inlineoverridevirtual

Writes the message to the listener you create when you implement the trace_listener class.

Parameters

message

A string you want to write.

Implements xtd::diagnostics::trace_listener.

write_line()

void xtd::forms::control_trace_listener::write_line ( const xtd::string &  message )

inlineoverridevirtual

Writes the message to the listener you create when you implement the trace_listener class.

Parameters

message

A string you want to write.

Implements xtd::diagnostics::trace_listener.

create()

static xtd::sptr< xtd::diagnostics::trace_listener > xtd::forms::control_trace_listener::create ( xtd::forms::icontrol_trace &  control_trace )

inlinestatic

Create new control_trace_listener.

Returns

New created trace listener.

---

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

• xtd.forms/include/xtd/forms/control_trace_listener.hpp