urho3d.UrhoSharp/Docs/Urho/MouseMode.xml

<Type Name="MouseMode" FullName="Urho.MouseMode">
  <TypeSignature Language="C#" Value="public enum MouseMode" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi sealed MouseMode extends System.Enum" />
  <AssemblyInfo>
    <AssemblyName>Urho</AssemblyName>
    <AssemblyVersion>1.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Enum</BaseTypeName>
  </Base>
  <Docs>
    <summary>Input Mouse Modes.
            </summary>
    <remarks>
      <para />
    </remarks>
  </Docs>
  <Members>
    <Member MemberName="Absolute">
      <MemberSignature Language="C#" Value="Absolute" />
      <MemberSignature Language="ILAsm" Value=".field public static literal valuetype Urho.MouseMode Absolute = int32(0)" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Urho.MouseMode</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>The default behaviour, allowing the toggling of operating system cursor visibility and allowing the cursor to escape the window when visible. When the operating system cursor is invisible in absolute mouse mode, the mouse is confined to the window. If the operating system and UI cursors are both invisible, interaction with the user interface will be limited (for example, drag move and drag end events will not trigger).    Setting this value to Absolute will call SetMouseGrabbed(false).</summary>
      </Docs>
    </Member>
    <Member MemberName="Free">
      <MemberSignature Language="C#" Value="Free" />
      <MemberSignature Language="ILAsm" Value=".field public static literal valuetype Urho.MouseMode Free = int32(3)" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Urho.MouseMode</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>To be added.</summary>
      </Docs>
    </Member>
    <Member MemberName="Relative">
      <MemberSignature Language="C#" Value="Relative" />
      <MemberSignature Language="ILAsm" Value=".field public static literal valuetype Urho.MouseMode Relative = int32(1)" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Urho.MouseMode</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>sets the operating system cursor to invisible and confines the cursor to the window. The operating system cursor cannot be set to be visible in this mode via SetMouseVisible(), however changes are tracked and will be restored when another mouse mode is set. When the virtual cursor is also invisible, UI interaction will still function as normal (eg: drag events will trigger). Setting this will call SetMouseGrabbed(true).</summary>
      </Docs>
    </Member>
    <Member MemberName="Wrap">
      <MemberSignature Language="C#" Value="Wrap" />
      <MemberSignature Language="ILAsm" Value=".field public static literal valuetype Urho.MouseMode Wrap = int32(2)" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Urho.MouseMode</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Grabs the mouse from the operating system and confines the operating system cursor to the window, wrapping the cursor when it is near the edges. Setting this will call SetMouseGrabbed(true).</summary>
      </Docs>
    </Member>
  </Members>
</Type>