v0.10.2 - more examples

Author: ahqsoftwares

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "win32_notif"
-version = "0.10.1"
+version = "0.10.2"
 edition = "2021"
 description = "Wrapper around Windows UWP XAML (WinRT) Notification api"
 license = "MIT"

Cargo.toml

@@ -0,0 +1,39 @@
+use std::{thread::sleep, time::Duration};
+
+use win32_notif::{
+  NotificationBuilder, NotificationDataSet, ToastsNotifier, notification::{
+    AdaptiveText, Scenario, visual::{
+      Progress, Text, progress::ProgressValue
+    }
+  }
+};
+
+pub fn main() {
+  let notifier = ToastsNotifier::new("Microsoft.Windows.Explorer").unwrap();
+
+  let notification = NotificationBuilder::new()
+    .with_scenario(Scenario::IncomingCall)
+    .with_use_button_style(true)
+    .visual(
+      Text::create_binded(1, "status")
+    )
+    .visual(
+      Progress::create(AdaptiveText::BindTo("typeof"), ProgressValue::BindTo("value"))
+    )
+    .value("status", "AHQ Store")
+    .value("typeof", "Downloading...")
+    .value("value", "indeterminate")
+    .build(1, &notifier, "a", "ahq")
+    .expect("Error");
+
+  notification.show().expect("Not Sent");
+
+  let data = NotificationDataSet::new().unwrap();
+  for perc in 1..=100 {
+    data.insert("value", format!("{}", perc as f32 / 100.0).as_str()).unwrap();
+
+    _ = notifier.update(&data, "ahq", "a");
+
+    sleep(Duration::from_millis(100));
+  }
+}

examples/downloading.rs

@@ -0,0 +1,45 @@
+use std::time::Duration;
+
+use win32_notif::{NotificationActivatedEventHandler, NotificationBuilder, ToastsNotifier, notification::{actions::{ActionButton, Input, action::ActivationType}, visual::Text}};
+// Input Example
+
+
+fn main() {
+  let notifier = ToastsNotifier::new("Microsoft.Windows.Explorer").unwrap();
+
+  let notification = NotificationBuilder::new()
+    .visual(
+      Text::create(0, "Enter your name")
+    )
+    .action(
+      Input::create_text_input("0", "Name", "AHQ")
+    )
+    .action(
+      ActionButton::create("Submit")
+        .with_input_id("0")
+        // Required or else it would go to file explorer
+        .with_activation_type(ActivationType::Foreground)
+    )
+    .on_activated(NotificationActivatedEventHandler::new(|_notif, data| {
+      let data = data.unwrap();
+
+      println!("{:#?}", data);
+
+      Ok(())
+    }))
+    // Notification will be gone after 5 secs
+    .with_expiry(Duration::from_secs(5))
+    // sequence: a custom defined id (never used)
+    // tag, group: Unique notification identifier
+    // Notifier, ofc you its the notifier
+    .build(0, &notifier, "01", "input")
+    .unwrap();
+
+  notification.show()
+    .unwrap();
+
+  // App should be running
+  loop {
+    std::thread::sleep(Duration::from_secs(2));
+  }
+}

examples/input.rs

@@ -13,14 +13,14 @@ fn main() {
   let notif = NotificationBuilder::new()
     .visual(
       Text::create(0, "Welcome to \"win32_notif\"!! 👋")
-        .align_center(true)
-        .wrap(true)
+        .with_align_center(true)
+        .with_wrap(true)
         .with_style(HintStyle::Title)
     )
     .visual(
       Text::create_binded(1, "desc")
-        .align_center(true)
-        .wrap(true)
+        .with_align_center(true)
+        .with_wrap(true)
         .with_style(HintStyle::Body)
     )
     .visual(

examples/readme.rs

@@ -0,0 +1,54 @@
+use std::time::Duration;
+
+use win32_notif::{NotificationActivatedEventHandler, NotificationBuilder, ToastsNotifier, notification::{actions::{ActionButton, Input, action::ActivationType, input::Selection}, visual::Text}};
+// Input Selection Example
+
+
+fn main() {
+  let notifier = ToastsNotifier::new("Microsoft.Windows.Explorer").unwrap();
+
+  let notification = NotificationBuilder::new()
+    .visual(
+      Text::create(0, "Enter your name")
+    )
+    .action(
+      Input::create_selection_input(
+        "0", 
+        "Name", 
+        "AHQ",
+      vec![
+          Selection::new("1", "AHQ Novel"),
+          Selection::new("2", "AHQ Soft"),
+          Selection::new("3", "Wings of Fire")
+        ]
+      )
+    )
+    .action(
+      ActionButton::create("Submit")
+        .with_input_id("0")
+        // Required or else it would go to file explorer
+        .with_activation_type(ActivationType::Foreground)
+    )
+    .on_activated(NotificationActivatedEventHandler::new(|_notif, data| {
+      let data = data.unwrap();
+
+      println!("{:#?}", data);
+
+      Ok(())
+    }))
+    // Notification will be gone after 5 secs
+    .with_expiry(Duration::from_secs(5))
+    // sequence: a custom defined id (never used)
+    // tag, group: Unique notification identifier
+    // Notifier, ofc you its the notifier
+    .build(0, &notifier, "01", "input")
+    .unwrap();
+
+  notification.show()
+    .unwrap();
+
+  // App should be running
+  loop {
+    std::thread::sleep(Duration::from_secs(2));
+  }
+}

examples/select.rs

@@ -70,6 +70,7 @@ impl ToXML for SubGroup {
       .collect::<Vec<_>>()
       .join("\n");
 
+    // XML Formatting
     format!(
       "
       <subgroup {wt} {stack}>

src/structs/notification/widgets/group/subgroup.rs

@@ -112,9 +112,12 @@ impl Image {
     )
   }
 
-  /// The `src` should be the either of the following following
-  /// - `https://url or http://url`
-  /// - `file:///path/to/file`
+  /// The `src` should be in the form of `file:///path/to/file`
+  /// 
+  /// Technically `https://` and `http://` too should work according to the
+  /// C# Windows UWP Notifications, but we were not able to replicate that.
+  /// 
+  /// We still allow setting http or https including others of windows C# API
   ///
   /// If none of the above is provided, the `src` will be set to `file:///path/to/file`
   pub fn new(

src/structs/notification/widgets/visual/image.rs

@@ -50,7 +50,7 @@ impl Progress {
     self
   }
 
-  pub fn override_value_string(mut self, value: AdaptiveText) -> Self {
+  pub fn with_override_value(mut self, value: AdaptiveText) -> Self {
     self.value_string_override = Some(value.to_string());
     self
   }

src/structs/notification/widgets/visual/progress.rs

@@ -130,22 +130,27 @@ impl Text {
   }
 
   /// Only for IncomingCall scenarios
-  pub fn align_center(mut self, center: bool) -> Self {
-    self.callScenarioCenterAlign = center;
+  pub fn with_align_center(mut self, shall_it_align_center: bool) -> Self {
+    self.callScenarioCenterAlign = shall_it_align_center;
     self
   }
 
-  pub fn wrap(mut self, wrap: bool) -> Self {
+  pub fn with_wrap(mut self, wrap: bool) -> Self {
     self.wrap = wrap;
     self
   }
 
-  pub fn max_lines(mut self, max_lines: u32) -> Self {
+  #[deprecated(since="0.10.2", note="Use [Self::with_wrap] instead")]
+  pub fn wrap(self, wrap: bool) -> Self {
+    self.with_wrap(wrap)
+  }
+
+  pub fn with_max_lines(mut self, max_lines: u32) -> Self {
     self.maxLines = max_lines;
     self
   }
 
-  pub fn min_lines(mut self, min_lines: u32) -> Self {
+  pub fn with_min_lines(mut self, min_lines: u32) -> Self {
     self.minLines = min_lines;
     self
   }