Implements a Windows message.
- Header
#include <xtd/forms/message>
- Namespace
- xtd::forms
- Library
- xtd.forms
- Examples:
- action1.cpp, action2.cpp, action3.cpp, form_and_messages.cpp, and wnd_proc.cpp.
|
| object ()=default |
| Create a new instance of the ultimate base class object. More...
|
|
bool | equals (const object &obj) const noexcept |
| Determines whether the specified object is equal to the current object. More...
|
|
virtual size_t | get_hash_code () const noexcept |
| Serves as a hash function for a particular type. More...
|
|
virtual type_object | get_type () const noexcept |
| Gets the type of the current instance. More...
|
|
template<typename object_t > |
std::unique_ptr< object_t > | memberwise_clone () const noexcept |
| Creates a shallow copy of the current object. More...
|
|
static bool | equals (const object &object_a, const object &object_b) noexcept |
| Determines whether the specified object instances are considered equal. More...
|
|
static bool | reference_equals (const object &object_a, const object &object_b) noexcept |
| Determines whether the specified object instances are the same instance. More...
|
|
◆ create()
Creates a new message.
- Parameters
-
hwnd | The window handle that the message is for. |
msg | The message ID.The message ID. |
wparam | The message wparam field. |
lparam | The message lparam field. |
- Returns
- A xtd::forms::message that represents the message that was created.
◆ get_lparam()
template<typename type_t >
type_t xtd::forms::message::get_lparam |
( |
| ) |
const |
|
inlinenoexcept |
Gets the lparam value and converts the value to an object.
- Template Parameters
-
type | The type to use to create an instance. This type must be declared as a structure type. |
- Returns
- An object that represents an instance of the class specified by the template parameter, with the data from the lparam field of the message.
◆ hwnd() [1/2]
intptr xtd::forms::message::hwnd |
( |
| ) |
const |
|
noexcept |
Gets the window handle of the message.
- Returns
- The window handle of the message.
◆ hwnd() [2/2]
void xtd::forms::message::hwnd |
( |
intptr |
value | ) |
|
Sets the window handle of the message.
- Parameters
-
hwnd | The window handle of the message. |
◆ lparam() [1/2]
intptr xtd::forms::message::lparam |
( |
| ) |
const |
|
noexcept |
Gets the lparam field of the message.
- Returns
- The lparam field of the message.
- Examples:
- form_and_messages.cpp.
◆ lparam() [2/2]
void xtd::forms::message::lparam |
( |
intptr |
value | ) |
|
Sets the lparam field of the message.
- Parameters
-
value | The lparam field of the message. |
◆ msg() [1/2]
uint32 xtd::forms::message::msg |
( |
| ) |
const |
|
noexcept |
◆ msg() [2/2]
void xtd::forms::message::msg |
( |
uint32 |
value | ) |
|
Sets the ID number for the message.
- Parameters
-
value | The ID number for the message. |
◆ result() [1/2]
intptr xtd::forms::message::result |
( |
| ) |
const |
|
noexcept |
Gets the value that is returned to Windows in response to handling the message.
- Returns
- The return value of the message.
◆ result() [2/2]
void xtd::forms::message::result |
( |
intptr |
value | ) |
|
Sets the value that is returned to Windows in response to handling the message.
- Parameters
-
value | The return value of the message. |
◆ to_string()
Returns a string that represents the current message.
- Returns
- A xtd::ustring that represents the current message.
Reimplemented from xtd::object.
◆ wparam() [1/2]
intptr xtd::forms::message::wparam |
( |
| ) |
const |
|
noexcept |
◆ wparam() [2/2]
void xtd::forms::message::wparam |
( |
intptr |
value | ) |
|
Sets the wparam field of the message.
- Parameters
-
value | The wparam field of the message. |
The documentation for this class was generated from the following file: