Files
Terminal.Gui/docs/api/Terminal.Gui/Terminal.Gui.MouseFlags.html
Charlie Kindel 04ab5540bf final doc update
2020-05-27 19:30:45 -06:00

311 lines
9.6 KiB
HTML

<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Enum MouseFlags
</title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Enum MouseFlags
">
<meta name="generator" content="docfx 2.54.0.0">
<link rel="shortcut icon" href="../../favicon.ico">
<link rel="stylesheet" href="../../styles/docfx.vendor.css">
<link rel="stylesheet" href="../../styles/docfx.css">
<link rel="stylesheet" href="../../styles/main.css">
<link href="https://fonts.googleapis.com/css?family=Roboto" rel="stylesheet">
<meta property="docfx:navrel" content="../../toc.html">
<meta property="docfx:tocrel" content="toc.html">
<meta property="docfx:rel" content="../../">
</head> <body data-spy="scroll" data-target="#affix" data-offset="120">
<div id="wrapper">
<header>
<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="../../index.html">
<img id="logo" class="svg" src="../../images/logo48.png" alt="">
</a>
</div>
<div class="collapse navbar-collapse" id="navbar">
<form class="navbar-form navbar-right" role="search" id="search">
<div class="form-group">
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
</div>
</form>
</div>
</div>
</nav>
<div class="subnav navbar navbar-default">
<div class="container hide-when-search" id="breadcrumb">
<ul class="breadcrumb">
<li></li>
</ul>
</div>
</div>
</header>
<div class="container body-content">
<div id="search-results">
<div class="search-list"></div>
<div class="sr-items">
<p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
</div>
<ul id="pagination"></ul>
</div>
</div>
<div role="main" class="container body-content hide-when-search">
<div class="sidenav hide-when-search">
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
<div class="sidetoggle collapse" id="sidetoggle">
<div id="sidetoc"></div>
</div>
</div>
<div class="article row grid-right">
<div class="col-md-10">
<article class="content wrap" id="_content" data-uid="Terminal.Gui.MouseFlags">
<h1 id="Terminal_Gui_MouseFlags" data-uid="Terminal.Gui.MouseFlags" class="text-break">Enum MouseFlags
</h1>
<div class="markdown level0 summary">
Mouse flags reported in <a class="xref" href="Terminal.Gui.MouseEvent.html">MouseEvent</a>.
</div>
<div class="markdown level0 conceptual"></div>
<h6><strong>Namespace</strong>: <a class="xref" href="Terminal.Gui.html">Terminal.Gui</a></h6>
<h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
<h5 id="Terminal_Gui_MouseFlags_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[Flags]
public enum MouseFlags</code></pre>
</div>
<h5 id="Terminal_Gui_MouseFlags_remarks"><strong>Remarks</strong></h5>
<div class="markdown level0 remarks">
They just happen to map to the ncurses ones.
</div>
<h3 id="fields">Fields
</h3>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Name</th>
<th>Description</th>
</tr>
<thead>
<tbody>
<tr>
<td id="Terminal_Gui_MouseFlags_AllEvents">AllEvents</td>
<td>
Mask that captures all the events.
</td>
</tr>
<tr>
<td id="Terminal_Gui_MouseFlags_Button1Clicked">Button1Clicked</td>
<td>
The first mouse button was clicked (press+release).
</td>
</tr>
<tr>
<td id="Terminal_Gui_MouseFlags_Button1DoubleClicked">Button1DoubleClicked</td>
<td>
The first mouse button was double-clicked.
</td>
</tr>
<tr>
<td id="Terminal_Gui_MouseFlags_Button1Pressed">Button1Pressed</td>
<td>
The first mouse button was pressed.
</td>
</tr>
<tr>
<td id="Terminal_Gui_MouseFlags_Button1Released">Button1Released</td>
<td>
The first mouse button was released.
</td>
</tr>
<tr>
<td id="Terminal_Gui_MouseFlags_Button1TripleClicked">Button1TripleClicked</td>
<td>
The first mouse button was triple-clicked.
</td>
</tr>
<tr>
<td id="Terminal_Gui_MouseFlags_Button2Clicked">Button2Clicked</td>
<td>
The second mouse button was clicked (press+release).
</td>
</tr>
<tr>
<td id="Terminal_Gui_MouseFlags_Button2DoubleClicked">Button2DoubleClicked</td>
<td>
The second mouse button was double-clicked.
</td>
</tr>
<tr>
<td id="Terminal_Gui_MouseFlags_Button2Pressed">Button2Pressed</td>
<td>
The second mouse button was pressed.
</td>
</tr>
<tr>
<td id="Terminal_Gui_MouseFlags_Button2Released">Button2Released</td>
<td>
The second mouse button was released.
</td>
</tr>
<tr>
<td id="Terminal_Gui_MouseFlags_Button2TripleClicked">Button2TripleClicked</td>
<td>
The second mouse button was triple-clicked.
</td>
</tr>
<tr>
<td id="Terminal_Gui_MouseFlags_Button3Clicked">Button3Clicked</td>
<td>
The third mouse button was clicked (press+release).
</td>
</tr>
<tr>
<td id="Terminal_Gui_MouseFlags_Button3DoubleClicked">Button3DoubleClicked</td>
<td>
The third mouse button was double-clicked.
</td>
</tr>
<tr>
<td id="Terminal_Gui_MouseFlags_Button3Pressed">Button3Pressed</td>
<td>
The third mouse button was pressed.
</td>
</tr>
<tr>
<td id="Terminal_Gui_MouseFlags_Button3Released">Button3Released</td>
<td>
The third mouse button was released.
</td>
</tr>
<tr>
<td id="Terminal_Gui_MouseFlags_Button3TripleClicked">Button3TripleClicked</td>
<td>
The third mouse button was triple-clicked.
</td>
</tr>
<tr>
<td id="Terminal_Gui_MouseFlags_Button4Clicked">Button4Clicked</td>
<td>
The fourth button was clicked (press+release).
</td>
</tr>
<tr>
<td id="Terminal_Gui_MouseFlags_Button4DoubleClicked">Button4DoubleClicked</td>
<td>
The fourth button was double-clicked.
</td>
</tr>
<tr>
<td id="Terminal_Gui_MouseFlags_Button4Pressed">Button4Pressed</td>
<td>
The fourth mouse button was pressed.
</td>
</tr>
<tr>
<td id="Terminal_Gui_MouseFlags_Button4Released">Button4Released</td>
<td>
The fourth mouse button was released.
</td>
</tr>
<tr>
<td id="Terminal_Gui_MouseFlags_Button4TripleClicked">Button4TripleClicked</td>
<td>
The fourth button was triple-clicked.
</td>
</tr>
<tr>
<td id="Terminal_Gui_MouseFlags_ButtonAlt">ButtonAlt</td>
<td>
Flag: the alt key was pressed when the mouse button took place.
</td>
</tr>
<tr>
<td id="Terminal_Gui_MouseFlags_ButtonCtrl">ButtonCtrl</td>
<td>
Flag: the ctrl key was pressed when the mouse button took place.
</td>
</tr>
<tr>
<td id="Terminal_Gui_MouseFlags_ButtonShift">ButtonShift</td>
<td>
Flag: the shift key was pressed when the mouse button took place.
</td>
</tr>
<tr>
<td id="Terminal_Gui_MouseFlags_ReportMousePosition">ReportMousePosition</td>
<td>
The mouse position is being reported in this event.
</td>
</tr>
<tr>
<td id="Terminal_Gui_MouseFlags_WheeledDown">WheeledDown</td>
<td>
Vertical button wheeled up.
</td>
</tr>
<tr>
<td id="Terminal_Gui_MouseFlags_WheeledUp">WheeledUp</td>
<td>
Vertical button wheeled up.
</td>
</tr>
</tbody>
</thead></thead></table>
</article>
</div>
<div class="hidden-sm col-md-2" role="complementary">
<div class="sideaffix">
<div class="contribution">
<ul class="nav">
</ul>
</div>
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
</nav>
</div>
</div>
</div>
</div>
<footer>
<div class="grad-bottom"></div>
<div class="footer">
<div class="container">
<span class="pull-right">
<a href="#top">Back to top</a>
</span>
<span>Generated by <strong>DocFX</strong></span>
</div>
</div>
</footer>
</div>
<script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
<script type="text/javascript" src="../../styles/docfx.js"></script>
<script type="text/javascript" src="../../styles/main.js"></script>
</body>
</html>