1- //! Defines operations allowed on PaneHandles
1+ //! Defines operations allowed on DivHandles
22//!
33//! Almost the entire library interface is defined in this module.
44
55use crate :: state;
66use crate :: * ;
77use web_sys:: { HtmlElement , Node } ;
88
9- /// External representation of a Pane .
9+ /// A light-weight key to refer to the state necessary to manipulate a div .
1010///
11- /// This is a unique identifier that will become invalid once the pane has been deleted.
12- #[ derive( Debug , Clone , PartialEq , Eq ) ]
13- pub struct PaneHandle ( pub ( crate ) usize ) ;
11+ /// This is a unique identifier that will become invalid once the div has been deleted.
12+ #[ derive( Debug , Clone , Copy , PartialEq , Eq , Hash ) ]
13+ pub struct DivHandle ( pub ( crate ) usize ) ;
1414
15- impl PaneHandle {
16- /// Hides the pane and all child nodes.
15+ impl DivHandle {
16+ /// Hides the div and all child nodes.
1717///
18- /// The pane root node is removed from the DOM but it is kept in memory.
18+ /// The div node is removed from the DOM but it is kept in memory.
1919/// Call `delete` to give up memory or call `show` later to display pane again.
2020pub fn hide ( & self ) -> Result < ( ) , DivError > {
2121 state:: exec_mut ( |state| state. hide_pane ( & self ) )
2222 }
23- /// Displays pane again after it has been hidden by calling `hide`
23+ /// Displays a div again after it has been hidden by calling `hide`
2424pub fn show ( & self ) -> Result < ( ) , DivError > {
2525 state:: exec_mut ( |state| state. show_pane ( & self ) )
2626 }
27- /// Adjust the relative position of the pane .
27+ /// Adjust the relative position of the div .
2828///
2929/// The provided parameters are taken in the original scale when initializing,
3030/// taking any calls to the global div::resize() into consideration.
3131pub fn reposition ( & self , x : u32 , y : u32 ) -> Result < ( ) , DivError > {
3232 state:: exec_mut ( |state| state. update_pane ( & self , Some ( x) , Some ( y) , None , None ) )
3333 }
34- /// Adjust the size of the pane .
34+ /// Adjust the size of the div .
3535///
3636/// The provided parameters are taken in the original scale when initializing,
3737/// taking any calls to the global div::resize() into consideration.
3838pub fn resize ( & self , w : u32 , h : u32 ) -> Result < ( ) , DivError > {
3939 state:: exec_mut ( |state| state. update_pane ( & self , None , None , Some ( w) , Some ( h) ) )
4040 }
41- /// Adjust the position and size of the pane in a single call, which is slightly more efficient than calling
41+ /// Adjust the position and size of the div in a single call, which is slightly more efficient than calling
4242/// resize and reposition separately.
4343///
4444/// The provided parameters are taken in the original scale when initializing,
@@ -47,36 +47,28 @@ impl PaneHandle {
4747 state:: exec_mut ( |state| state. update_pane ( & self , Some ( x) , Some ( y) , Some ( w) , Some ( h) ) )
4848 }
4949 /// Set CSS property of div
50- pub fn set_css ( & mut self , property : & str , value : & str ) -> Result < ( ) , DivError > {
50+ pub fn set_css ( & self , property : & str , value : & str ) -> Result < ( ) , DivError > {
5151 state:: exec ( |state| state. nodes . get ( self ) ?. set_css ( property, value) )
5252 }
5353 /// Add a CSS class to the div
54- pub fn add_class ( & mut self , css_class : & str ) -> Result < ( ) , DivError > {
54+ pub fn add_class ( & self , css_class : & str ) -> Result < ( ) , DivError > {
5555 state:: exec ( |state| state. nodes . get ( self ) ?. add_class ( css_class) )
5656 }
5757 /// Remove a CSS class to the div
58- pub fn remove_class ( & mut self , css_class : & str ) -> Result < ( ) , DivError > {
58+ pub fn remove_class ( & self , css_class : & str ) -> Result < ( ) , DivError > {
5959 state:: exec ( |state| state. nodes . get ( self ) ?. remove_class ( css_class) )
6060 }
61- /// Removes a pane from the DOM and deletes it
61+ /// Removes a div from the DOM and deletes it
6262pub fn delete ( & mut self ) -> Result < ( ) , DivError > {
6363 state:: exec_mut ( |state| state. delete_pane ( self ) )
6464 }
65- /// Get a reference to the DOM element associated with the pane .
66- /// The provided HTML when creating a new pane will be the child node(s) of the returned element.
65+ /// Get a reference to the DOM element associated with the div .
66+ /// The provided HTML when creating a new div will be the child node(s) of the returned element.
6767pub fn parent_element ( & self ) -> Result < HtmlElement , DivError > {
6868 state:: exec ( |state| state. get_node ( & self ) . map ( Clone :: clone) )
6969 }
7070 /// Get a reference to the DOM node created by the provided HTML when creating the pane.
7171/// If multiple nodes have been created, the first node is returned.
72- ///
73- /// The returned [`Node`] is from the crate [`stdweb`], allowing library users to
74- /// escape the Div crate and access the DOM directly.
75- ///
76- /// TODO: Example
77- ///
78- /// [`Node`]: https://docs.rs/stdweb/*/stdweb/web/struct.Node.html
79- /// [`stdweb`]: https://docs.rs/stdweb/*/stdweb/
8072pub fn first_inner_node ( & self ) -> Result < Node , DivError > {
8173 self . parent_element ( ) ?
8274 . first_child ( )
0 commit comments