-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add documentation comments to
bevy_window
(#4333)
# Objective - Add documentation comments and `#![warn(missing_docs)]` to `bevy_window`. - Part of #3492
- Loading branch information
Showing
4 changed files
with
184 additions
and
39 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,39 +1,80 @@ | ||
/// The icon to display for a window's cursor | ||
/// The icon to display for a window's cursor. | ||
/// | ||
/// Examples of all of these cursors can be found [here](https://www.w3schools.com/cssref/playit.asp?filename=playcss_cursor). | ||
/// This `enum` is simply a copy of a similar `enum` found in [`winit`](https://docs.rs/winit/latest/winit/window/enum.CursorIcon.html). | ||
/// `winit`, in turn, mostly copied cursor types avilable in the browser. | ||
#[derive(Debug, Hash, PartialEq, Eq, Clone, Copy)] | ||
pub enum CursorIcon { | ||
/// The platform-dependent default cursor. | ||
Default, | ||
/// A simple crosshair. | ||
Crosshair, | ||
/// A hand (often used to indicate links in web browsers). | ||
Hand, | ||
/// An arrow. This is the default cursor on most systems. | ||
Arrow, | ||
/// Indicates something is to be moved. | ||
Move, | ||
/// Indicates text that may be selected or edited. | ||
Text, | ||
/// Program busy indicator. | ||
Wait, | ||
/// Help indicator (often rendered as a "?") | ||
Help, | ||
/// Progress indicator. Shows that processing is being done. But in contrast | ||
/// with "Wait" the user may still interact with the program. Often rendered | ||
/// as a spinning beach ball, or an arrow with a watch or hourglass. | ||
Progress, | ||
/// Cursor showing that something cannot be done. | ||
NotAllowed, | ||
/// Indicates that a context menu is available | ||
ContextMenu, | ||
/// Indicates that a cell (or set of cells) may be selected | ||
Cell, | ||
/// Indicates vertical text that may be selected or edited | ||
VerticalText, | ||
/// Indicates that an alias of something is to be created | ||
Alias, | ||
/// Indicates something is to be copied | ||
Copy, | ||
/// Indicates that the dragged item cannot be dropped here | ||
NoDrop, | ||
/// Indicates that something can be grabbed | ||
Grab, | ||
/// Indicates that something is grabbed. | ||
Grabbing, | ||
/// Indicates that the user can scroll by dragging the mouse. | ||
AllScroll, | ||
/// Indicates that the user can zoom in | ||
ZoomIn, | ||
/// Indicates that the user can zoom out | ||
ZoomOut, | ||
/// Indicates that an edge of a box is to be moved right (east) | ||
EResize, | ||
/// Indicates that an edge of a box is to be moved up (north) | ||
NResize, | ||
/// Indicates that an edge of a box is to be moved up and right (north/east) | ||
NeResize, | ||
/// indicates that an edge of a box is to be moved up and left (north/west) | ||
NwResize, | ||
/// Indicates that an edge of a box is to be moved down (south) | ||
SResize, | ||
/// The cursor indicates that an edge of a box is to be moved down and right (south/east) | ||
SeResize, | ||
/// The cursor indicates that an edge of a box is to be moved down and left (south/west) | ||
SwResize, | ||
/// Indicates that an edge of a box is to be moved left (west) | ||
WResize, | ||
/// Indicates a bidirectional resize cursor | ||
EwResize, | ||
/// Indicates a bidirectional resize cursor | ||
NsResize, | ||
/// Indicates a bidirectional resize cursor | ||
NeswResize, | ||
/// Indicates a bidirectional resize cursor | ||
NwseResize, | ||
/// Indicates that a column can be resized horizontally | ||
ColResize, | ||
/// Indicates that the row can be resized vertically | ||
RowResize, | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.