Display all platform-specific documentation on docs.rs (#3076)

src/platform_impl/linux/x11/mod.rs

@@ -14,11 +14,9 @@ mod xdisplay;
 pub(crate) use self::{
     monitor::{MonitorHandle, VideoModeHandle},
     window::UnownedWindow,
-    xdisplay::XConnection,
+    xdisplay::{XConnection, XError, XNotSupported},
 };
 
-pub use self::xdisplay::{XError, XNotSupported};
-
 use calloop::generic::Generic;
 use calloop::EventLoop as Loop;
 use calloop::{ping::Ping, Readiness};

src/platform_impl/linux/x11/util/hint.rs

@@ -1,8 +1,6 @@
+use crate::platform::x11::WindowType;
 use std::sync::Arc;
 
-#[cfg(feature = "serde")]
-use serde::{Deserialize, Serialize};
-
 use super::*;
 
 #[derive(Debug)]
@@ -23,50 +21,6 @@ impl From<bool> for StateOperation {
     }
 }
 
-/// X window type. Maps directly to
-/// [`_NET_WM_WINDOW_TYPE`](https://specifications.freedesktop.org/wm-spec/wm-spec-1.5.html).
-#[derive(Debug, Default, Copy, Clone, PartialEq, Eq, Hash)]
-#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
-pub enum WindowType {
-    /// A desktop feature. This can include a single window containing desktop icons with the same dimensions as the
-    /// screen, allowing the desktop environment to have full control of the desktop, without the need for proxying
-    /// root window clicks.
-    Desktop,
-    /// A dock or panel feature. Typically a Window Manager would keep such windows on top of all other windows.
-    Dock,
-    /// Toolbar windows. "Torn off" from the main application.
-    Toolbar,
-    /// Pinnable menu windows. "Torn off" from the main application.
-    Menu,
-    /// A small persistent utility window, such as a palette or toolbox.
-    Utility,
-    /// The window is a splash screen displayed as an application is starting up.
-    Splash,
-    /// This is a dialog window.
-    Dialog,
-    /// A dropdown menu that usually appears when the user clicks on an item in a menu bar.
-    /// This property is typically used on override-redirect windows.
-    DropdownMenu,
-    /// A popup menu that usually appears when the user right clicks on an object.
-    /// This property is typically used on override-redirect windows.
-    PopupMenu,
-    /// A tooltip window. Usually used to show additional information when hovering over an object with the cursor.
-    /// This property is typically used on override-redirect windows.
-    Tooltip,
-    /// The window is a notification.
-    /// This property is typically used on override-redirect windows.
-    Notification,
-    /// This should be used on the windows that are popped up by combo boxes.
-    /// This property is typically used on override-redirect windows.
-    Combo,
-    /// This indicates the the window is being dragged.
-    /// This property is typically used on override-redirect windows.
-    Dnd,
-    /// This is a normal, top-level window.
-    #[default]
-    Normal,
-}
-
 impl WindowType {
     pub(crate) fn as_atom(&self, xconn: &Arc<XConnection>) -> xproto::Atom {
         use self::WindowType::*;

src/platform_impl/linux/x11/window.rs

@@ -26,6 +26,7 @@ use crate::{
     error::{ExternalError, NotSupportedError, OsError as RootOsError},
     event::{Event, InnerSizeWriter, WindowEvent},
     event_loop::AsyncRequestSerial,
+    platform::x11::WindowType,
     platform_impl::{
         x11::{
             atoms::*, xinput_fp1616_to_float, MonitorHandle as X11MonitorHandle, WakeSender,
@@ -635,10 +636,7 @@ impl UnownedWindow {
         flusher.map(Some)
     }
 
-    fn set_window_types(
-        &self,
-        window_types: Vec<util::WindowType>,
-    ) -> Result<VoidCookie<'_>, X11Error> {
+    fn set_window_types(&self, window_types: Vec<WindowType>) -> Result<VoidCookie<'_>, X11Error> {
         let atoms = self.xconn.atoms();
         let hint_atom = atoms[_NET_WM_WINDOW_TYPE];
         let atoms: Vec<_> = window_types

src/platform_impl/linux/x11/xdisplay.rs

@@ -260,7 +260,7 @@ impl fmt::Display for XError {
 
 /// Error returned if this system doesn't have XLib or can't create an X connection.
 #[derive(Clone, Debug)]
-pub enum XNotSupported {
+pub(crate) enum XNotSupported {
     /// Failed to load one or several shared libraries.
     LibraryOpenError(ffi::OpenError),