xtd 0.2.0
Loading...
Searching...
No Matches
xtd::forms::find_event_args Class Reference
Inheritance diagram for xtd::forms::find_event_args:
xtd::event_args xtd::object

Definition

Provides data for the xtd::forms::find_dialog::find_next and xtd::forms::replace_dialog::find_next events.

Header
#include <xtd/forms/find_event_args>
Namespace
xtd::forms
Library
xtd.forms
Examples
find_box.cpp, find_dialog.cpp, replace_box.cpp, and replace_dialog.cpp.

Public Constructors

 find_event_args ()
 Initializes a new instance of the xtd::forms::find_event_args class.
 
 find_event_args (const xtd::ustring &find_string, bool match_case, xtd::forms::search_direction search_direction, bool whole_word)
 Initializes a new instance of the xtd::forms::find_event_args class.
 

Public Properties

const xtd::ustringfind_string () const noexcept
 Gets the string to find.
 
bool match_case () const noexcept
 Gets the match case value.
 
xtd::forms::search_direction search_direction () const noexcept
 Gets the search direction value.
 
bool whole_word () const noexcept
 Gets the whole word value.
 

Additional Inherited Members

- Static Public Attributes inherited from xtd::event_args
static const event_args empty
 Provides a value to use with events that do not have event data.
 
- Public Member Functions inherited from xtd::event_args
 event_args ()=default
 Initializes a new instance of the event_args class.
 
- Public Member Functions inherited from xtd::object
 object ()=default
 Create a new instance of the ultimate base class object.
 
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 >
std::unique_ptr< object_t > memberwise_clone () const noexcept
 Creates a shallow copy of the current object.
 
virtual xtd::ustring to_string () const noexcept
 Returns a sxd::ustring that represents the current object.
 
- Static Public Member Functions inherited from xtd::object
static bool equals (const object &object_a, const object &object_b) noexcept
 Determines whether the specified object instances are considered equal.
 
static bool reference_equals (const object &object_a, const object &object_b) noexcept
 Determines whether the specified object instances are the same instance.
 

Constructor & Destructor Documentation

◆ find_event_args() [1/2]

xtd::forms::find_event_args::find_event_args ( )

Initializes a new instance of the xtd::forms::find_event_args class.

◆ find_event_args() [2/2]

xtd::forms::find_event_args::find_event_args ( const xtd::ustring find_string,
bool  match_case,
xtd::forms::search_direction  search_direction,
bool  whole_word 
)

Initializes a new instance of the xtd::forms::find_event_args class.

Parameters
find_stringThe string to find.
match_casetrue if match case option selected; otherwise false.
search_directiontrue if match case option selected; otherwise false.
whole_wordOne of xtd::forms::search_direction values.

Member Function Documentation

◆ find_string()

const xtd::ustring & xtd::forms::find_event_args::find_string ( ) const
noexcept

Gets the string to find.

Returns
The string to find.

◆ match_case()

bool xtd::forms::find_event_args::match_case ( ) const
noexcept

Gets the match case value.

Returns
true if match case option selected; otherwise false. The default is false.

◆ search_direction()

xtd::forms::search_direction xtd::forms::find_event_args::search_direction ( ) const
noexcept

Gets the search direction value.

Returns
One of xtd::forms::search_direction values; The default is xtd::forms::search_direction::down.

◆ whole_word()

bool xtd::forms::find_event_args::whole_word ( ) const
noexcept

Gets the whole word value.

Returns
true if whole word option selected; otherwise false. The default is false.

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