%%
%% %CopyrightBegin%
%%
%% Copyright Ericsson AB 2008-2024. All Rights Reserved.
%%
%% Licensed under the Apache License, Version 2.0 (the "License");
%% you may not use this file except in compliance with the License.
%% You may obtain a copy of the License at
%%
%%     http://www.apache.org/licenses/LICENSE-2.0
%%
%% Unless required by applicable law or agreed to in writing, software
%% distributed under the License is distributed on an "AS IS" BASIS,
%% WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
%% See the License for the specific language governing permissions and
%% limitations under the License.
%%
%% %CopyrightEnd%
%% This file is generated DO NOT EDIT

-module(wxSetCursorEvent).
-moduledoc """
A `m:wxSetCursorEvent` is generated from `m:wxWindow` when the mouse cursor is about to
be set as a result of mouse motion.

This event gives the application the chance to perform specific mouse cursor processing
based on the current position of the mouse within the window. Use `setCursor/2` to specify the cursor
you want to be displayed.

See:
* `wx_misc:setCursor/1`

* `wxWindow:setCursor/2`

This class is derived, and can use functions, from:

* `m:wxEvent`

wxWidgets docs: [wxSetCursorEvent](https://docs.wxwidgets.org/3.2/classwx_set_cursor_event.html)

## Events

Use `wxEvtHandler:connect/3` with `wxSetCursorEventType` to subscribe to events of this type.
""".
-include("wxe.hrl").
-export([getCursor/1,getX/1,getY/1,hasCursor/1,setCursor/2]).

%% inherited exports
-export([getId/1,getSkipped/1,getTimestamp/1,isCommandEvent/1,parent_class/1,
  resumePropagation/2,shouldPropagate/1,skip/1,skip/2,stopPropagation/1]).

-type wxSetCursorEvent() :: wx:wx_object().
-include("wx.hrl").
-type wxSetCursorEventType() :: 'set_cursor'.
-export_type([wxSetCursorEvent/0, wxSetCursor/0, wxSetCursorEventType/0]).
-doc false.
parent_class(wxEvent) -> true;
parent_class(_Class) -> erlang:error({badtype, ?MODULE}).

-doc "Returns a reference to the cursor specified by this event.".
-spec getCursor(This) -> wxCursor:wxCursor() when
	This::wxSetCursorEvent().
getCursor(#wx_ref{type=ThisT}=This) ->
  ?CLASS(ThisT,wxSetCursorEvent),
  wxe_util:queue_cmd(This,?get_env(),?wxSetCursorEvent_GetCursor),
  wxe_util:rec(?wxSetCursorEvent_GetCursor).

-doc "Returns the X coordinate of the mouse in client coordinates.".
-spec getX(This) -> integer() when
	This::wxSetCursorEvent().
getX(#wx_ref{type=ThisT}=This) ->
  ?CLASS(ThisT,wxSetCursorEvent),
  wxe_util:queue_cmd(This,?get_env(),?wxSetCursorEvent_GetX),
  wxe_util:rec(?wxSetCursorEvent_GetX).

-doc "Returns the Y coordinate of the mouse in client coordinates.".
-spec getY(This) -> integer() when
	This::wxSetCursorEvent().
getY(#wx_ref{type=ThisT}=This) ->
  ?CLASS(ThisT,wxSetCursorEvent),
  wxe_util:queue_cmd(This,?get_env(),?wxSetCursorEvent_GetY),
  wxe_util:rec(?wxSetCursorEvent_GetY).

-doc """
Returns true if the cursor specified by this event is a valid cursor.

Remark: You cannot specify wxNullCursor with this event, as it is not considered a valid
cursor.
""".
-spec hasCursor(This) -> boolean() when
	This::wxSetCursorEvent().
hasCursor(#wx_ref{type=ThisT}=This) ->
  ?CLASS(ThisT,wxSetCursorEvent),
  wxe_util:queue_cmd(This,?get_env(),?wxSetCursorEvent_HasCursor),
  wxe_util:rec(?wxSetCursorEvent_HasCursor).

-doc "Sets the cursor associated with this event.".
-spec setCursor(This, Cursor) -> 'ok' when
	This::wxSetCursorEvent(), Cursor::wxCursor:wxCursor().
setCursor(#wx_ref{type=ThisT}=This,#wx_ref{type=CursorT}=Cursor) ->
  ?CLASS(ThisT,wxSetCursorEvent),
  ?CLASS(CursorT,wxCursor),
  wxe_util:queue_cmd(This,Cursor,?get_env(),?wxSetCursorEvent_SetCursor).

 %% From wxEvent
-doc false.
stopPropagation(This) -> wxEvent:stopPropagation(This).
-doc false.
skip(This, Options) -> wxEvent:skip(This, Options).
-doc false.
skip(This) -> wxEvent:skip(This).
-doc false.
shouldPropagate(This) -> wxEvent:shouldPropagate(This).
-doc false.
resumePropagation(This,PropagationLevel) -> wxEvent:resumePropagation(This,PropagationLevel).
-doc false.
isCommandEvent(This) -> wxEvent:isCommandEvent(This).
-doc false.
getTimestamp(This) -> wxEvent:getTimestamp(This).
-doc false.
getSkipped(This) -> wxEvent:getSkipped(This).
-doc false.
getId(This) -> wxEvent:getId(This).
