gui-cs.Terminal.Gui/ecmadocs/en/Terminal.Gui/MouseFlags.xml

<Type Name="MouseFlags" FullName="Terminal.Gui.MouseFlags">
  <TypeSignature Language="C#" Value="public enum MouseFlags" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi sealed MouseFlags extends System.Enum" />
  <AssemblyInfo>
    <AssemblyName>Terminal.Gui</AssemblyName>
    <AssemblyVersion>1.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Enum</BaseTypeName>
  </Base>
  <Attributes>
    <Attribute>
      <AttributeName>System.Flags</AttributeName>
    </Attribute>
  </Attributes>
  <Docs>
    <summary>
            Mouse flags reported in MouseEvent.
            </summary>
    <remarks>
            They just happen to map to the ncurses ones.
            </remarks>
  </Docs>
  <Members>
    <Member MemberName="AllEvents">
      <MemberSignature Language="C#" Value="AllEvents" />
      <MemberSignature Language="ILAsm" Value=".field public static literal valuetype Terminal.Gui.MouseFlags AllEvents = int32(134217727)" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Terminal.Gui.MouseFlags</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Mask that captures all the events.
            </summary>
      </Docs>
    </Member>
    <Member MemberName="Button1Clicked">
      <MemberSignature Language="C#" Value="Button1Clicked" />
      <MemberSignature Language="ILAsm" Value=".field public static literal valuetype Terminal.Gui.MouseFlags Button1Clicked = int32(4)" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Terminal.Gui.MouseFlags</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            The first mouse button was clicked (press+release).
            </summary>
      </Docs>
    </Member>
    <Member MemberName="Button1DoubleClicked">
      <MemberSignature Language="C#" Value="Button1DoubleClicked" />
      <MemberSignature Language="ILAsm" Value=".field public static literal valuetype Terminal.Gui.MouseFlags Button1DoubleClicked = int32(8)" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Terminal.Gui.MouseFlags</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            The first mouse button was double-clicked.
            </summary>
      </Docs>
    </Member>
    <Member MemberName="Button1Pressed">
      <MemberSignature Language="C#" Value="Button1Pressed" />
      <MemberSignature Language="ILAsm" Value=".field public static literal valuetype Terminal.Gui.MouseFlags Button1Pressed = int32(2)" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Terminal.Gui.MouseFlags</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            The first mouse button was pressed.
            </summary>
      </Docs>
    </Member>
    <Member MemberName="Button1Released">
      <MemberSignature Language="C#" Value="Button1Released" />
      <MemberSignature Language="ILAsm" Value=".field public static literal valuetype Terminal.Gui.MouseFlags Button1Released = int32(1)" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Terminal.Gui.MouseFlags</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            The first mouse button was released.
            </summary>
      </Docs>
    </Member>
    <Member MemberName="Button1TripleClicked">
      <MemberSignature Language="C#" Value="Button1TripleClicked" />
      <MemberSignature Language="ILAsm" Value=".field public static literal valuetype Terminal.Gui.MouseFlags Button1TripleClicked = int32(16)" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Terminal.Gui.MouseFlags</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            The first mouse button was tripple-clicked.
            </summary>
      </Docs>
    </Member>
    <Member MemberName="Button2Clicked">
      <MemberSignature Language="C#" Value="Button2Clicked" />
      <MemberSignature Language="ILAsm" Value=".field public static literal valuetype Terminal.Gui.MouseFlags Button2Clicked = int32(256)" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Terminal.Gui.MouseFlags</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            The second mouse button was clicked (press+release).
            </summary>
      </Docs>
    </Member>
    <Member MemberName="Button2DoubleClicked">
      <MemberSignature Language="C#" Value="Button2DoubleClicked" />
      <MemberSignature Language="ILAsm" Value=".field public static literal valuetype Terminal.Gui.MouseFlags Button2DoubleClicked = int32(512)" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Terminal.Gui.MouseFlags</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            The second mouse button was double-clicked.
            </summary>
      </Docs>
    </Member>
    <Member MemberName="Button2Pressed">
      <MemberSignature Language="C#" Value="Button2Pressed" />
      <MemberSignature Language="ILAsm" Value=".field public static literal valuetype Terminal.Gui.MouseFlags Button2Pressed = int32(128)" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Terminal.Gui.MouseFlags</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            The second mouse button was pressed.
            </summary>
      </Docs>
    </Member>
    <Member MemberName="Button2Released">
      <MemberSignature Language="C#" Value="Button2Released" />
      <MemberSignature Language="ILAsm" Value=".field public static literal valuetype Terminal.Gui.MouseFlags Button2Released = int32(64)" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Terminal.Gui.MouseFlags</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            The second mouse button was released.
            </summary>
      </Docs>
    </Member>
    <Member MemberName="Button2TrippleClicked">
      <MemberSignature Language="C#" Value="Button2TrippleClicked" />
      <MemberSignature Language="ILAsm" Value=".field public static literal valuetype Terminal.Gui.MouseFlags Button2TrippleClicked = int32(1024)" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Terminal.Gui.MouseFlags</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            The second mouse button was tripple-clicked.
            </summary>
      </Docs>
    </Member>
    <Member MemberName="Button3Clicked">
      <MemberSignature Language="C#" Value="Button3Clicked" />
      <MemberSignature Language="ILAsm" Value=".field public static literal valuetype Terminal.Gui.MouseFlags Button3Clicked = int32(16384)" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Terminal.Gui.MouseFlags</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            The third mouse button was clicked (press+release).
            </summary>
      </Docs>
    </Member>
    <Member MemberName="Button3DoubleClicked">
      <MemberSignature Language="C#" Value="Button3DoubleClicked" />
      <MemberSignature Language="ILAsm" Value=".field public static literal valuetype Terminal.Gui.MouseFlags Button3DoubleClicked = int32(32768)" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Terminal.Gui.MouseFlags</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            The third mouse button was double-clicked.
            </summary>
      </Docs>
    </Member>
    <Member MemberName="Button3Pressed">
      <MemberSignature Language="C#" Value="Button3Pressed" />
      <MemberSignature Language="ILAsm" Value=".field public static literal valuetype Terminal.Gui.MouseFlags Button3Pressed = int32(8192)" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Terminal.Gui.MouseFlags</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            The third mouse button was pressed.
            </summary>
      </Docs>
    </Member>
    <Member MemberName="Button3Released">
      <MemberSignature Language="C#" Value="Button3Released" />
      <MemberSignature Language="ILAsm" Value=".field public static literal valuetype Terminal.Gui.MouseFlags Button3Released = int32(4096)" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Terminal.Gui.MouseFlags</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            The third mouse button was released.
            </summary>
      </Docs>
    </Member>
    <Member MemberName="Button3TripleClicked">
      <MemberSignature Language="C#" Value="Button3TripleClicked" />
      <MemberSignature Language="ILAsm" Value=".field public static literal valuetype Terminal.Gui.MouseFlags Button3TripleClicked = int32(65536)" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Terminal.Gui.MouseFlags</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            The third mouse button was tripple-clicked.  
            </summary>
      </Docs>
    </Member>
    <Member MemberName="Button4Clicked">
      <MemberSignature Language="C#" Value="Button4Clicked" />
      <MemberSignature Language="ILAsm" Value=".field public static literal valuetype Terminal.Gui.MouseFlags Button4Clicked = int32(1048576)" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Terminal.Gui.MouseFlags</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            The fourth button was clicked (press+release).
            </summary>
      </Docs>
    </Member>
    <Member MemberName="Button4DoubleClicked">
      <MemberSignature Language="C#" Value="Button4DoubleClicked" />
      <MemberSignature Language="ILAsm" Value=".field public static literal valuetype Terminal.Gui.MouseFlags Button4DoubleClicked = int32(2097152)" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Terminal.Gui.MouseFlags</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            The fourth button was double-clicked.
            </summary>
      </Docs>
    </Member>
    <Member MemberName="Button4Pressed">
      <MemberSignature Language="C#" Value="Button4Pressed" />
      <MemberSignature Language="ILAsm" Value=".field public static literal valuetype Terminal.Gui.MouseFlags Button4Pressed = int32(524288)" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Terminal.Gui.MouseFlags</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            The fourth mouse button was pressed.
            </summary>
      </Docs>
    </Member>
    <Member MemberName="Button4Released">
      <MemberSignature Language="C#" Value="Button4Released" />
      <MemberSignature Language="ILAsm" Value=".field public static literal valuetype Terminal.Gui.MouseFlags Button4Released = int32(262144)" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Terminal.Gui.MouseFlags</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            The fourth mouse button was released.
            </summary>
      </Docs>
    </Member>
    <Member MemberName="Button4TripleClicked">
      <MemberSignature Language="C#" Value="Button4TripleClicked" />
      <MemberSignature Language="ILAsm" Value=".field public static literal valuetype Terminal.Gui.MouseFlags Button4TripleClicked = int32(4194304)" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Terminal.Gui.MouseFlags</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            The fourth button was tripple-clicked.
            </summary>
      </Docs>
    </Member>
    <Member MemberName="ButtonAlt">
      <MemberSignature Language="C#" Value="ButtonAlt" />
      <MemberSignature Language="ILAsm" Value=".field public static literal valuetype Terminal.Gui.MouseFlags ButtonAlt = int32(67108864)" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Terminal.Gui.MouseFlags</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Flag: the alt key was pressed when the mouse button took place.
            </summary>
      </Docs>
    </Member>
    <Member MemberName="ButtonCtrl">
      <MemberSignature Language="C#" Value="ButtonCtrl" />
      <MemberSignature Language="ILAsm" Value=".field public static literal valuetype Terminal.Gui.MouseFlags ButtonCtrl = int32(16777216)" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Terminal.Gui.MouseFlags</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Flag: the shift key was pressed when the mouse button took place.
            </summary>
      </Docs>
    </Member>
    <Member MemberName="ButtonShift">
      <MemberSignature Language="C#" Value="ButtonShift" />
      <MemberSignature Language="ILAsm" Value=".field public static literal valuetype Terminal.Gui.MouseFlags ButtonShift = int32(33554432)" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Terminal.Gui.MouseFlags</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            The fourth button was pressed.
            </summary>
      </Docs>
    </Member>
    <Member MemberName="ReportMousePosition">
      <MemberSignature Language="C#" Value="ReportMousePosition" />
      <MemberSignature Language="ILAsm" Value=".field public static literal valuetype Terminal.Gui.MouseFlags ReportMousePosition = int32(134217728)" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Terminal.Gui.MouseFlags</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            The mouse position is being reported in this event.
            </summary>
      </Docs>
    </Member>
  </Members>
</Type>