commit 86d19624efbf704a105656f3d74bebdf7b86d099 Author: Julian Ospald Date: Sat Jul 15 01:24:09 2017 +0200 Initial gh-pages commit diff --git a/alsa_card/AlsaCard.t.html b/alsa_card/AlsaCard.t.html new file mode 100644 index 000000000..1596a90f3 --- /dev/null +++ b/alsa_card/AlsaCard.t.html @@ -0,0 +1,10 @@ + + + + + + +

Redirecting to struct.AlsaCard.html...

+ + + \ No newline at end of file diff --git a/alsa_card/AlsaEvent.t.html b/alsa_card/AlsaEvent.t.html new file mode 100644 index 000000000..aea91e90a --- /dev/null +++ b/alsa_card/AlsaEvent.t.html @@ -0,0 +1,10 @@ + + + + + + +

Redirecting to enum.AlsaEvent.html...

+ + + \ No newline at end of file diff --git a/alsa_card/enum.AlsaEvent.html b/alsa_card/enum.AlsaEvent.html new file mode 100644 index 000000000..c3d58392c --- /dev/null +++ b/alsa_card/enum.AlsaEvent.html @@ -0,0 +1,130 @@ + + + + + + + + + + pnmixerlib::alsa_card::AlsaEvent - Rust + + + + + + + + + + + + + + + + + + +
+

Enum pnmixerlib::alsa_card::AlsaEvent + + [−] + + [src]

+
pub enum AlsaEvent {
+    AlsaCardError,
+    AlsaCardDiconnected,
+    AlsaCardValuesChanged,
+}

An "external" alsa card event, potentially triggered by anything.

+

Variants

+

An error.

+

Alsa card is disconnected.

+

The values of the mixer changed, including mute state.

+

Trait Implementations

impl Clone for AlsaEvent
[src]

+

+

Returns a copy of the value. Read more

+

+

Performs copy-assignment from source. Read more

+

impl Copy for AlsaEvent
[src]

+

impl Debug for AlsaEvent
[src]

+

+

Formats the value using the given formatter.

+
+ + +
+ + + + + + + + + + \ No newline at end of file diff --git a/alsa_card/index.html b/alsa_card/index.html new file mode 100644 index 000000000..eca17c950 --- /dev/null +++ b/alsa_card/index.html @@ -0,0 +1,135 @@ + + + + + + + + + + pnmixerlib::alsa_card - Rust + + + + + + + + + + + + + + + + + + +
+

Module pnmixerlib::alsa_card + + [−] + + [src]

+

Alsa audio subsystem.

+ +

This mod mainly defines the AlsaCard struct, which is the only data +structure interacting directly with the alsa library. +No other struct should directly interact with the alsa bindings.

+

Structs

+ + + + +
AlsaCard +

A fairly high-level alsa card struct. We save some redundant +information in order to access it more easily, in addition to +some information that is not purely alsa related (like callbacks).

+

Enums

+ + + + +
AlsaEvent +

An "external" alsa card event, potentially triggered by anything.

+
+ + +
+ + + + + + + + + + \ No newline at end of file diff --git a/alsa_card/sidebar-items.js b/alsa_card/sidebar-items.js new file mode 100644 index 000000000..98dced8c3 --- /dev/null +++ b/alsa_card/sidebar-items.js @@ -0,0 +1 @@ +initSidebarItems({"enum":[["AlsaEvent","An \"external\" alsa card event, potentially triggered by anything."]],"struct":[["AlsaCard","A fairly high-level alsa card struct. We save some redundant information in order to access it more easily, in addition to some information that is not purely alsa related (like callbacks)."]]}); \ No newline at end of file diff --git a/alsa_card/struct.AlsaCard.html b/alsa_card/struct.AlsaCard.html new file mode 100644 index 000000000..fcef4f3da --- /dev/null +++ b/alsa_card/struct.AlsaCard.html @@ -0,0 +1,200 @@ + + + + + + + + + + pnmixerlib::alsa_card::AlsaCard - Rust + + + + + + + + + + + + + + + + + + +
+

Struct pnmixerlib::alsa_card::AlsaCard + + [−] + + [src]

+
pub struct AlsaCard {
+    pub card: Card,
+    pub mixer: Mixer,
+    pub selem_id: SelemId,
+    pub watch_ids: Cell<Vec<u32>>,
+    pub cb: Rc<Fn(AlsaEvent)>,
+    // some fields omitted
+}

A fairly high-level alsa card struct. We save some redundant +information in order to access it more easily, in addition to +some information that is not purely alsa related (like callbacks).

+

Fields

+

The raw alsa card.

+
+

The raw mixer.

+
+

The simple element ID. Selem doesn't implement the Copy trait +so we save the ID instead and can get the Selem by lookup.

+
+

Watch IDs from polling the alsa card. We need them when we +drop the card, so we can unregister the polling.

+
+

Callback for the various AlsaEvents.

+

Methods

impl AlsaCard
[src]

+

+

Create a new alsa card. Tries very hard to get a valid, playable +card and mixer, so this is not a 'strict' function.

+ +

card_name

+

If a card name is provided, it will be tried. If None is provided +or the given card name does not exist or is not playable, any other +playable card is tried.

+ +

elem_name

+

If an elem name is provided, it will be tried. If None is provided +or the given elem name does not exist or is not playable, any other +playable elem is tried.

+ +

cb

+

Callback for the various AlsaEvents.

+ +

Returns

+

Ok(Box<AlsaCard>) on success, Err(error) otherwise.

+

+

Get the name of the alsa card.

+

+

Get the name of the channel.

+

+

Get the Selem, looked up by the SelemId.

+

+

Get the current volume. The returned value corresponds to the +volume range and might need to be interpreted (such as converting +to percentage). This always gets +the volume of the FrontRight channel, because the seems to be +the safest bet.

+

+

Sets the volume of the current card configuration.

+ +

new_vol

+

The volume corresponding to the volume range of the Selem. This +might need to be translated properly first from other formats +(like percentage).

+

+

Gets the volume range of the currently selected card configuration.

+ +

Returns

+

(min, max)

+

+

Whether the current card configuration can be muted.

+

+

Get the mute state of the current card configuration.

+

+

Set the mute state of the current card configuration.

+ +

mute

+

Passing true here means the card will be muted.

+

Trait Implementations

impl Drop for AlsaCard
[src]

+

+

Destructs the watch IDs corresponding to the current poll descriptors.

+
+ + +
+ + + + + + + + + + \ No newline at end of file diff --git a/app_state/AppS.t.html b/app_state/AppS.t.html new file mode 100644 index 000000000..bd8da6ea2 --- /dev/null +++ b/app_state/AppS.t.html @@ -0,0 +1,10 @@ + + + + + + +

Redirecting to struct.AppS.html...

+ + + \ No newline at end of file diff --git a/app_state/index.html b/app_state/index.html new file mode 100644 index 000000000..e03fdceb0 --- /dev/null +++ b/app_state/index.html @@ -0,0 +1,121 @@ + + + + + + + + + + pnmixerlib::app_state - Rust + + + + + + + + + + + + + + + + + + +
+

Module pnmixerlib::app_state + + [−] + + [src]

+

Global application state.

+

Structs

+ + + + +
AppS +

The global application state struct.

+
+ + +
+ + + + + + + + + + \ No newline at end of file diff --git a/app_state/sidebar-items.js b/app_state/sidebar-items.js new file mode 100644 index 000000000..36f307f0b --- /dev/null +++ b/app_state/sidebar-items.js @@ -0,0 +1 @@ +initSidebarItems({"struct":[["AppS","The global application state struct."]]}); \ No newline at end of file diff --git a/app_state/struct.AppS.html b/app_state/struct.AppS.html new file mode 100644 index 000000000..0345bf72b --- /dev/null +++ b/app_state/struct.AppS.html @@ -0,0 +1,148 @@ + + + + + + + + + + pnmixerlib::app_state::AppS - Rust + + + + + + + + + + + + + + + + + + +
+

Struct pnmixerlib::app_state::AppS + + [−] + + [src]

+
pub struct AppS {
+    pub gui: Gui,
+    pub audio: Audio,
+    pub prefs: RefCell<Prefs>,
+    pub notif: Notif,
+    // some fields omitted
+}

The global application state struct.

+

Fields

+

Mostly static GUI state.

+
+

Audio state.

+
+

Preferences state.

+
+

Notification state.

+

Methods

impl AppS
[src]

+

+

Create an application state instance. There should really only be one.

+

+

Update the tray icon state.

+

+

Update the Popup Window state.

+

+

Update the notification state.

+

+

Update the audio state.

+

+

Update the config file.

+
+ + +
+ + + + + + + + + + \ No newline at end of file diff --git a/audio/Audio.t.html b/audio/Audio.t.html new file mode 100644 index 000000000..3823439c6 --- /dev/null +++ b/audio/Audio.t.html @@ -0,0 +1,10 @@ + + + + + + +

Redirecting to struct.Audio.html...

+ + + \ No newline at end of file diff --git a/audio/AudioSignal.t.html b/audio/AudioSignal.t.html new file mode 100644 index 000000000..5314a57ee --- /dev/null +++ b/audio/AudioSignal.t.html @@ -0,0 +1,10 @@ + + + + + + +

Redirecting to enum.AudioSignal.html...

+ + + \ No newline at end of file diff --git a/audio/AudioUser.t.html b/audio/AudioUser.t.html new file mode 100644 index 000000000..2571fcf1a --- /dev/null +++ b/audio/AudioUser.t.html @@ -0,0 +1,10 @@ + + + + + + +

Redirecting to enum.AudioUser.html...

+ + + \ No newline at end of file diff --git a/audio/Handlers.t.html b/audio/Handlers.t.html new file mode 100644 index 000000000..aad66d631 --- /dev/null +++ b/audio/Handlers.t.html @@ -0,0 +1,10 @@ + + + + + + +

Redirecting to struct.Handlers.html...

+ + + \ No newline at end of file diff --git a/audio/VolLevel.t.html b/audio/VolLevel.t.html new file mode 100644 index 000000000..a47346e3c --- /dev/null +++ b/audio/VolLevel.t.html @@ -0,0 +1,10 @@ + + + + + + +

Redirecting to enum.VolLevel.html...

+ + + \ No newline at end of file diff --git a/audio/enum.AudioSignal.html b/audio/enum.AudioSignal.html new file mode 100644 index 000000000..a1760e5c2 --- /dev/null +++ b/audio/enum.AudioSignal.html @@ -0,0 +1,131 @@ + + + + + + + + + + pnmixerlib::audio::AudioSignal - Rust + + + + + + + + + + + + + + + + + + +
+

Enum pnmixerlib::audio::AudioSignal + + [−] + + [src]

+
pub enum AudioSignal {
+    NoCard,
+    CardInitialized,
+    CardCleanedUp,
+    CardDisconnected,
+    CardError,
+    ValuesChanged,
+}

An audio signal. This will be used to connect callbacks to the +audio system and react appropriately.

+

Variants

+

Trait Implementations

impl Clone for AudioSignal
[src]

+

+

Returns a copy of the value. Read more

+

+

Performs copy-assignment from source. Read more

+

impl Copy for AudioSignal
[src]

+

impl Debug for AudioSignal
[src]

+

+

Formats the value using the given formatter.

+
+ + +
+ + + + + + + + + + \ No newline at end of file diff --git a/audio/enum.AudioUser.html b/audio/enum.AudioUser.html new file mode 100644 index 000000000..8aaae4719 --- /dev/null +++ b/audio/enum.AudioUser.html @@ -0,0 +1,129 @@ + + + + + + + + + + pnmixerlib::audio::AudioUser - Rust + + + + + + + + + + + + + + + + + + +
+

Enum pnmixerlib::audio::AudioUser + + [−] + + [src]

+
pub enum AudioUser {
+    Unknown,
+    Popup,
+    TrayIcon,
+    Hotkeys,
+    PrefsWindow,
+}

An audio user, used to determine from where a signal originated.

+

Variants

+

Trait Implementations

impl Clone for AudioUser
[src]

+

+

Returns a copy of the value. Read more

+

+

Performs copy-assignment from source. Read more

+

impl Copy for AudioUser
[src]

+

impl Debug for AudioUser
[src]

+

+

Formats the value using the given formatter.

+
+ + +
+ + + + + + + + + + \ No newline at end of file diff --git a/audio/enum.VolLevel.html b/audio/enum.VolLevel.html new file mode 100644 index 000000000..781ed4dd7 --- /dev/null +++ b/audio/enum.VolLevel.html @@ -0,0 +1,129 @@ + + + + + + + + + + pnmixerlib::audio::VolLevel - Rust + + + + + + + + + + + + + + + + + + +
+

Enum pnmixerlib::audio::VolLevel + + [−] + + [src]

+
pub enum VolLevel {
+    Muted,
+    Low,
+    Medium,
+    High,
+    Off,
+}

The volume level of the current audio configuration.

+

Variants

+

Trait Implementations

impl Clone for VolLevel
[src]

+

+

Returns a copy of the value. Read more

+

+

Performs copy-assignment from source. Read more

+

impl Copy for VolLevel
[src]

+

impl Debug for VolLevel
[src]

+

+

Formats the value using the given formatter.

+
+ + +
+ + + + + + + + + + \ No newline at end of file diff --git a/audio/index.html b/audio/index.html new file mode 100644 index 000000000..13d5f73b6 --- /dev/null +++ b/audio/index.html @@ -0,0 +1,157 @@ + + + + + + + + + + pnmixerlib::audio - Rust + + + + + + + + + + + + + + + + + + +
+

Module pnmixerlib::audio + + [−] + + [src]

+

High-level audio subsystem.

+ +

This is the middleman between the low-level audio backend (alsa), +and the high-level ui code. +This abstraction layer allows the high-level code to be completely unaware +of the underlying audio implementation, may it be alsa or whatever.

+

Structs

+ + + + + + + + +
Audio +

High-level Audio struct, which could theoretically be backend +agnostic.

+
Handlers +

Convenience struct to make handling this madness easier.

+

Enums

+ + + + + + + + + + + + +
AudioSignal +

An audio signal. This will be used to connect callbacks to the +audio system and react appropriately.

+
AudioUser +

An audio user, used to determine from where a signal originated.

+
VolLevel +

The volume level of the current audio configuration.

+
+ + +
+ + + + + + + + + + \ No newline at end of file diff --git a/audio/sidebar-items.js b/audio/sidebar-items.js new file mode 100644 index 000000000..b3d217146 --- /dev/null +++ b/audio/sidebar-items.js @@ -0,0 +1 @@ +initSidebarItems({"enum":[["AudioSignal","An audio signal. This will be used to connect callbacks to the audio system and react appropriately."],["AudioUser","An audio user, used to determine from where a signal originated."],["VolLevel","The volume level of the current audio configuration."]],"struct":[["Audio","High-level Audio struct, which could theoretically be backend agnostic."],["Handlers","Convenience struct to make handling this madness easier."]]}); \ No newline at end of file diff --git a/audio/struct.Audio.html b/audio/struct.Audio.html new file mode 100644 index 000000000..cffe5cf64 --- /dev/null +++ b/audio/struct.Audio.html @@ -0,0 +1,213 @@ + + + + + + + + + + pnmixerlib::audio::Audio - Rust + + + + + + + + + + + + + + + + + + +
+

Struct pnmixerlib::audio::Audio + + [−] + + [src]

+
pub struct Audio {
+    pub acard: RefCell<Box<AlsaCard>>,
+    pub last_action_timestamp: Rc<RefCell<i64>>,
+    pub handlers: Handlers,
+    pub scroll_step: Cell<u32>,
+    // some fields omitted
+}

High-level Audio struct, which could theoretically be backend +agnostic.

+

Fields

+

The alsa card.

+
+

Last timestamp of an internal action we triggered, e.g. +by setting the volume or the mute state.

+
+

A set of handlers that react to audio signals. We can +connect to these.

+
+

The step at which to increase/decrease the volume. +This value is basically from the preferences.

+

Methods

impl Audio
[src]

+

+

Create a new Audio instance. This tries very hard to get +a working configuration from the backend.

+ +

card_name

+

If a card name is provided, it will be tried. If None is provided +or the given card name does not exist or is not playable, any other +playable card is tried.

+ +

elem_name

+

If an elem name is provided, it will be tried. If None is provided +or the given elem name does not exist or is not playable, any other +playable elem is tried.

+ +

Returns

+

Ok(Audio) on success, Err(error) otherwise.

+

+

Switches the current alsa card. Behaves the same way in regards to +card_name and elem_name as the Audio::new() method.

+ +

user

+

Where the card switch originates from.

+

+

Current volume.

+

+

Current volume level, nicely usable for e.g. selecting from a set +of images.

+

+

Set the current volume.

+ +

new_vol

+

Set the volume to this value.

+ +

user

+

Where the card switch originates from.

+ +

dir

+

The "direction" of the volume change, e.g. is it a decrease +or increase. This helps with rounding problems.

+ +

auto_unmute

+

Whether to automatically unmute if the volume changes.

+

+

Increase the volume. The step to increasy by is taken from +self.scroll_step.

+ +

user

+

Where the card switch originates from.

+

+

Decrease the volume. The step to decrease by is taken from +self.scroll_step.

+ +

user

+

Where the card switch originates from.

+

+

Whether the current audio configuration can be muted.

+

+

Get the mute state of the current audio configuration.

+

+

Set the mute state of the current audio configuration.

+

+

Toggle the mute state of the current audio configuration.

+

+

Connect a signal handler to the audio subsystem. This can +be done from anywhere, e.g. in the UI code to react to +certain signals. Multiple handlers for the same signals are fine, +they will be executed in order.

+

+

Get the current card name.

+

+

Get the currently playable channel names.

+

+

Get the current active channel name.

+
+ + +
+ + + + + + + + + + \ No newline at end of file diff --git a/audio/struct.Handlers.html b/audio/struct.Handlers.html new file mode 100644 index 000000000..ad4d3705d --- /dev/null +++ b/audio/struct.Handlers.html @@ -0,0 +1,118 @@ + + + + + + + + + + pnmixerlib::audio::Handlers - Rust + + + + + + + + + + + + + + + + + + +
+

Struct pnmixerlib::audio::Handlers + + [−] + + [src]

+
pub struct Handlers { /* fields omitted */ }

Convenience struct to make handling this madness easier.

+

Trait Implementations

impl Clone for Handlers
[src]

+

+

Returns a copy of the value. Read more

+

+

Performs copy-assignment from source. Read more

+
+ + +
+ + + + + + + + + + \ No newline at end of file diff --git a/create_builder_item.m.html b/create_builder_item.m.html new file mode 100644 index 000000000..1cfd234ba --- /dev/null +++ b/create_builder_item.m.html @@ -0,0 +1,10 @@ + + + + + + +

Redirecting to macro.create_builder_item.html...

+ + + \ No newline at end of file diff --git a/errors/Error.t.html b/errors/Error.t.html new file mode 100644 index 000000000..423d0a498 --- /dev/null +++ b/errors/Error.t.html @@ -0,0 +1,10 @@ + + + + + + +

Redirecting to struct.Error.html...

+ + + \ No newline at end of file diff --git a/errors/ErrorKind.t.html b/errors/ErrorKind.t.html new file mode 100644 index 000000000..2608a61c7 --- /dev/null +++ b/errors/ErrorKind.t.html @@ -0,0 +1,10 @@ + + + + + + +

Redirecting to enum.ErrorKind.html...

+ + + \ No newline at end of file diff --git a/errors/Result.t.html b/errors/Result.t.html new file mode 100644 index 000000000..865910f9b --- /dev/null +++ b/errors/Result.t.html @@ -0,0 +1,10 @@ + + + + + + +

Redirecting to type.Result.html...

+ + + \ No newline at end of file diff --git a/errors/ResultExt.t.html b/errors/ResultExt.t.html new file mode 100644 index 000000000..f4c1577be --- /dev/null +++ b/errors/ResultExt.t.html @@ -0,0 +1,10 @@ + + + + + + +

Redirecting to trait.ResultExt.html...

+ + + \ No newline at end of file diff --git a/errors/enum.ErrorKind.html b/errors/enum.ErrorKind.html new file mode 100644 index 000000000..8570c8a2c --- /dev/null +++ b/errors/enum.ErrorKind.html @@ -0,0 +1,139 @@ + + + + + + + + + + pnmixerlib::errors::ErrorKind - Rust + + + + + + + + + + + + + + + + + + +
+

Enum pnmixerlib::errors::ErrorKind + + [−] + +

+
pub enum ErrorKind {
+    Msg(String),
+    Alsa(Error),
+    IO(Error),
+    Toml(Error),
+    Png(DecodingError),
+}

The kind of an error.

+

Variants

+

A convenient variant for String.

+

Methods

impl ErrorKind

+

+

A string describing the error kind.

+

Trait Implementations

impl Debug for ErrorKind

+

+

Formats the value using the given formatter.

+

impl Display for ErrorKind

+

+

Formats the value using the given formatter. Read more

+

impl<'a> From<&'a str> for ErrorKind

+

+

Performs the conversion.

+

impl From<String> for ErrorKind

+

+

Performs the conversion.

+

impl From<Error> for ErrorKind

+

+

Performs the conversion.

+
+ + +
+ + + + + + + + + + \ No newline at end of file diff --git a/errors/index.html b/errors/index.html new file mode 100644 index 000000000..7dda2c96e --- /dev/null +++ b/errors/index.html @@ -0,0 +1,144 @@ + + + + + + + + + + pnmixerlib::errors - Rust + + + + + + + + + + + + + + + + + + +
+

Module pnmixerlib::errors + + [−] + + [src]

+

Structs

+ + + + +
Error +

The Error type.

+

Enums

+ + + + +
ErrorKind +

The kind of an error.

+

Traits

+ + + + +
ResultExt +

Additional methods for Result, for easy interaction with this crate.

+

Type Definitions

+ + + + +
Result +

Convenient wrapper around std::Result.

+
+ + +
+ + + + + + + + + + \ No newline at end of file diff --git a/errors/sidebar-items.js b/errors/sidebar-items.js new file mode 100644 index 000000000..d3dad4cdd --- /dev/null +++ b/errors/sidebar-items.js @@ -0,0 +1 @@ +initSidebarItems({"enum":[["ErrorKind","The kind of an error."]],"struct":[["Error","The Error type."]],"trait":[["ResultExt","Additional methods for `Result`, for easy interaction with this crate."]],"type":[["Result","Convenient wrapper around `std::Result`."]]}); \ No newline at end of file diff --git a/errors/struct.Error.html b/errors/struct.Error.html new file mode 100644 index 000000000..4214e35b7 --- /dev/null +++ b/errors/struct.Error.html @@ -0,0 +1,197 @@ + + + + + + + + + + pnmixerlib::errors::Error - Rust + + + + + + + + + + + + + + + + + + +
+

Struct pnmixerlib::errors::Error + + [−] + +

+
pub struct Error(pub ErrorKind, _);

The Error type.

+ +

This tuple struct is made of two elements:

+ +
    +
  • an ErrorKind which is used to determine the type of the error.
    • +
  • An internal State, not meant for direct use outside of error_chain +internals, containing: + +
      +
    • a backtrace, generated when the error is created.
      • +
    • an error chain, used for the implementation of Error::cause().
      • +
    • +
+

Methods

impl Error

+

+

Constructs an error from a kind, and generates a backtrace.

+

+

Constructs a chained error from another error and a kind, and generates a backtrace.

+

+

Returns the kind of the error.

+

+

Iterates over the error chain.

+

+

Returns the backtrace associated with this error.

+

+

Extends the error chain with a new entry.

+

Methods from Deref<Target = ErrorKind>

+

A string describing the error kind.

+

Trait Implementations

impl Debug for Error

+

+

Formats the value using the given formatter.

+

impl ChainedError for Error

+

+

Associated kind type.

+

+

+

Constructs an error from a kind, and generates a backtrace.

+

+

Constructs a chained error from another error and a kind, and generates a backtrace.

+

+

Returns the kind of the error.

+

+

Iterates over the error chain.

+

+

Extends the error chain with a new entry.

+

+

Returns the backtrace associated with this error.

+

+

+

Returns an object which implements Display for printing the full context of this error. Read more

+

impl Error for Error

+

+

A short description of the error. Read more

+

+

The lower-level cause of this error, if any. Read more

+

impl Display for Error

+

+

Formats the value using the given formatter. Read more

+

impl From<Error> for Error

+

+

Performs the conversion.

+

impl From<Error> for Error

+

+

Performs the conversion.

+

impl From<Error> for Error

+

+

Performs the conversion.

+

impl From<DecodingError> for Error

+

+

Performs the conversion.

+

impl From<ErrorKind> for Error

+

+

Performs the conversion.

+

impl<'a> From<&'a str> for Error

+

+

Performs the conversion.

+

impl From<String> for Error

+

+

Performs the conversion.

+

impl Deref for Error

+

+

The resulting type after dereferencing

+

+

The method called to dereference a value

+
+ + +
+ + + + + + + + + + \ No newline at end of file diff --git a/errors/trait.ResultExt.html b/errors/trait.ResultExt.html new file mode 100644 index 000000000..6438a8c77 --- /dev/null +++ b/errors/trait.ResultExt.html @@ -0,0 +1,132 @@ + + + + + + + + + + pnmixerlib::errors::ResultExt - Rust + + + + + + + + + + + + + + + + + + +
+

Trait pnmixerlib::errors::ResultExt + + [−] + +

+
pub trait ResultExt<T, E> {
+    fn chain_err<F, EK>(self, callback: F) -> Result<T, Error>
    where
        F: FnOnce() -> EK,
        EK: Into<ErrorKind>;
+    fn from_err(self) -> Result<T, Error>
    where
        Error: From<E>;
+}

Additional methods for Result, for easy interaction with this crate.

+
+

Required Methods

+
+

If the Result is an Err then chain_err evaluates the closure, +which returns some type that can be converted to ErrorKind, boxes +the original error to store as the cause, then returns a new error +containing the original error.

+

Converts a convertible error via From::from to +the result error. Useful to turn e.g. std::io::Error +into our own Error type.

+
+

Implementors

+
+ + +
+ + + + + + + + + + \ No newline at end of file diff --git a/errors/type.Result.html b/errors/type.Result.html new file mode 100644 index 000000000..d96b546b6 --- /dev/null +++ b/errors/type.Result.html @@ -0,0 +1,113 @@ + + + + + + + + + + pnmixerlib::errors::Result - Rust + + + + + + + + + + + + + + + + + + +
+

Type Definition pnmixerlib::errors::Result + + [−] + +

+
type Result<T> = Result<T, Error>;

Convenient wrapper around std::Result.

+
+ + +
+ + + + + + + + + + \ No newline at end of file diff --git a/glade_helpers/index.html b/glade_helpers/index.html new file mode 100644 index 000000000..abc48549e --- /dev/null +++ b/glade_helpers/index.html @@ -0,0 +1,112 @@ + + + + + + + + + + pnmixerlib::glade_helpers - Rust + + + + + + + + + + + + + + + + + + +
+

Module pnmixerlib::glade_helpers + + [−] + + [src]

+
+ + +
+ + + + + + + + + + \ No newline at end of file diff --git a/glade_helpers/sidebar-items.js b/glade_helpers/sidebar-items.js new file mode 100644 index 000000000..48333d31f --- /dev/null +++ b/glade_helpers/sidebar-items.js @@ -0,0 +1 @@ +initSidebarItems({}); \ No newline at end of file diff --git a/index.html b/index.html new file mode 100644 index 000000000..4be4f8f14 --- /dev/null +++ b/index.html @@ -0,0 +1,278 @@ + + + + + + + + + + pnmixerlib - Rust + + + + + + + + + + + + + + + + + + +
+

Crate pnmixerlib + + [−] + + [src]

+

Reexports

+
pub extern crate flexi_logger;
pub extern crate log;
pub extern crate error_chain;
pub extern crate serde_derive;
pub extern crate toml;
pub extern crate serde;
pub extern crate alsa;
pub extern crate alsa_sys;
pub extern crate ffi;
pub extern crate gdk;
pub extern crate gdk_pixbuf;
pub extern crate gdk_pixbuf_sys;
pub extern crate gdk_sys;
pub extern crate gio;
pub extern crate glib;
pub extern crate glib_sys;
pub extern crate gobject_sys;
pub extern crate gtk;
pub extern crate gtk_sys;
pub extern crate libc;
pub extern crate png;
pub extern crate which;
pub extern crate xdg;
pub extern crate libnotify;

Modules

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
alsa_card +

Alsa audio subsystem.

+
app_state +

Global application state.

+
audio +

High-level audio subsystem.

+
errors + +
glade_helpers + +
notif +

The notification subsystem.

+
prefs +

The preferences subsystem.

+
support_alsa +

Alsa audio helper functions.

+
support_audio +

Helper functions of the audio subsystem.

+
support_cmd +

Helper functions for invoking system commands.

+
support_ui +

Helper functions for the UI, mostly pixbuf functions.

+
ui_entry +

Global GUI state.

+
ui_popup_menu +

The popup menu subsystem when the user right-clicks on the tray icon.

+
ui_popup_window +

The popup window subsystem when the user left-clicks on the tray icon.

+
ui_prefs_dialog +

The preferences window subsystem, when the user clicks the "Preferences" +menu item on the popup menu.

+
ui_tray_icon +

The tray icon subsystem.

+

Macros

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
create_builder_item + +
pixbuf_new_from_png +

Create a pixbuf from the given PNG file. Includes the file as bytes +in the binary and decodes it.

+
try_e + +
try_er + +
try_r + +
try_w + +
try_wr + +
+ + +
+ + + + + + + + + + \ No newline at end of file diff --git a/macro.create_builder_item!.html b/macro.create_builder_item!.html new file mode 100644 index 000000000..1cfd234ba --- /dev/null +++ b/macro.create_builder_item!.html @@ -0,0 +1,10 @@ + + + + + + +

Redirecting to macro.create_builder_item.html...

+ + + \ No newline at end of file diff --git a/macro.create_builder_item.html b/macro.create_builder_item.html new file mode 100644 index 000000000..b12949da6 --- /dev/null +++ b/macro.create_builder_item.html @@ -0,0 +1,116 @@ + + + + + + + + + + pnmixerlib::create_builder_item - Rust + + + + + + + + + + + + + + + + + + +
+

Macro pnmixerlib::create_builder_item + + [−] + + [src]

+
+macro_rules! create_builder_item {
+    ($sname:ident, $($element: ident: $ty: ty),+) => { ... };
+}
+
+ + +
+ + + + + + + + + + \ No newline at end of file diff --git a/macro.pixbuf_new_from_file!.html b/macro.pixbuf_new_from_file!.html new file mode 100644 index 000000000..46c64f783 --- /dev/null +++ b/macro.pixbuf_new_from_file!.html @@ -0,0 +1,10 @@ + + + + + + +

Redirecting to macro.pixbuf_new_from_file.html...

+ + + \ No newline at end of file diff --git a/macro.pixbuf_new_from_file.html b/macro.pixbuf_new_from_file.html new file mode 100644 index 000000000..952ecbb99 --- /dev/null +++ b/macro.pixbuf_new_from_file.html @@ -0,0 +1,116 @@ + + + + + + + + + + pnmixerlib::pixbuf_new_from_file - Rust + + + + + + + + + + + + + + + + + + +
+

Macro pnmixerlib::pixbuf_new_from_file + + [−] + + [src]

+
+macro_rules! pixbuf_new_from_file {
+    ($name:expr) => { ... };
+}
+
+ + +
+ + + + + + + + + + \ No newline at end of file diff --git a/macro.pixbuf_new_from_png!.html b/macro.pixbuf_new_from_png!.html new file mode 100644 index 000000000..0d3ceb44f --- /dev/null +++ b/macro.pixbuf_new_from_png!.html @@ -0,0 +1,10 @@ + + + + + + +

Redirecting to macro.pixbuf_new_from_png.html...

+ + + \ No newline at end of file diff --git a/macro.pixbuf_new_from_png.html b/macro.pixbuf_new_from_png.html new file mode 100644 index 000000000..fd50f5a9a --- /dev/null +++ b/macro.pixbuf_new_from_png.html @@ -0,0 +1,118 @@ + + + + + + + + + + pnmixerlib::pixbuf_new_from_png - Rust + + + + + + + + + + + + + + + + + + +
+

Macro pnmixerlib::pixbuf_new_from_png + + [−] + + [src]

+
+macro_rules! pixbuf_new_from_png {
+    ($name:expr) => { ... };
+}
+

Create a pixbuf from the given PNG file. Includes the file as bytes +in the binary and decodes it.

+
+ + +
+ + + + + + + + + + \ No newline at end of file diff --git a/macro.try_e!.html b/macro.try_e!.html new file mode 100644 index 000000000..32d0e962f --- /dev/null +++ b/macro.try_e!.html @@ -0,0 +1,10 @@ + + + + + + +

Redirecting to macro.try_e.html...

+ + + \ No newline at end of file diff --git a/macro.try_e.html b/macro.try_e.html new file mode 100644 index 000000000..32c708f49 --- /dev/null +++ b/macro.try_e.html @@ -0,0 +1,118 @@ + + + + + + + + + + pnmixerlib::try_e - Rust + + + + + + + + + + + + + + + + + + +
+

Macro pnmixerlib::try_e + + [−] + + [src]

+
+macro_rules! try_e {
+    ($expr:expr) => { ... };
+    ($expr:expr, $fmt:expr, $($arg:tt)+) => { ... };
+    ($expr:expr, $fmt:expr) => { ... };
+}
+
+ + +
+ + + + + + + + + + \ No newline at end of file diff --git a/macro.try_er!.html b/macro.try_er!.html new file mode 100644 index 000000000..a97ab9d12 --- /dev/null +++ b/macro.try_er!.html @@ -0,0 +1,10 @@ + + + + + + +

Redirecting to macro.try_er.html...

+ + + \ No newline at end of file diff --git a/macro.try_er.html b/macro.try_er.html new file mode 100644 index 000000000..74715a03a --- /dev/null +++ b/macro.try_er.html @@ -0,0 +1,118 @@ + + + + + + + + + + pnmixerlib::try_er - Rust + + + + + + + + + + + + + + + + + + +
+

Macro pnmixerlib::try_er + + [−] + + [src]

+
+macro_rules! try_er {
+    ($expr:expr, $ret:expr) => { ... };
+    ($expr:expr, $ret:expr, $fmt:expr) => { ... };
+    ($expr:expr, $ret:expr, $fmt:expr, $($arg:tt)+) => { ... };
+}
+
+ + +
+ + + + + + + + + + \ No newline at end of file diff --git a/macro.try_r!.html b/macro.try_r!.html new file mode 100644 index 000000000..b076b6f4f --- /dev/null +++ b/macro.try_r!.html @@ -0,0 +1,10 @@ + + + + + + +

Redirecting to macro.try_r.html...

+ + + \ No newline at end of file diff --git a/macro.try_r.html b/macro.try_r.html new file mode 100644 index 000000000..ea5a85d54 --- /dev/null +++ b/macro.try_r.html @@ -0,0 +1,116 @@ + + + + + + + + + + pnmixerlib::try_r - Rust + + + + + + + + + + + + + + + + + + +
+

Macro pnmixerlib::try_r + + [−] + + [src]

+
+macro_rules! try_r {
+    ($expr:expr, $ret:expr) => { ... };
+}
+
+ + +
+ + + + + + + + + + \ No newline at end of file diff --git a/macro.try_w!.html b/macro.try_w!.html new file mode 100644 index 000000000..4158d0449 --- /dev/null +++ b/macro.try_w!.html @@ -0,0 +1,10 @@ + + + + + + +

Redirecting to macro.try_w.html...

+ + + \ No newline at end of file diff --git a/macro.try_w.html b/macro.try_w.html new file mode 100644 index 000000000..c50a3793f --- /dev/null +++ b/macro.try_w.html @@ -0,0 +1,118 @@ + + + + + + + + + + pnmixerlib::try_w - Rust + + + + + + + + + + + + + + + + + + +
+

Macro pnmixerlib::try_w + + [−] + + [src]

+
+macro_rules! try_w {
+    ($expr:expr) => { ... };
+    ($expr:expr, $fmt:expr, $($arg:tt)+) => { ... };
+    ($expr:expr, $fmt:expr) => { ... };
+}
+
+ + +
+ + + + + + + + + + \ No newline at end of file diff --git a/macro.try_wr!.html b/macro.try_wr!.html new file mode 100644 index 000000000..ec049d105 --- /dev/null +++ b/macro.try_wr!.html @@ -0,0 +1,10 @@ + + + + + + +

Redirecting to macro.try_wr.html...

+ + + \ No newline at end of file diff --git a/macro.try_wr.html b/macro.try_wr.html new file mode 100644 index 000000000..7e6a05631 --- /dev/null +++ b/macro.try_wr.html @@ -0,0 +1,118 @@ + + + + + + + + + + pnmixerlib::try_wr - Rust + + + + + + + + + + + + + + + + + + +
+

Macro pnmixerlib::try_wr + + [−] + + [src]

+
+macro_rules! try_wr {
+    ($expr:expr, $ret:expr) => { ... };
+    ($expr:expr, $ret:expr, $fmt:expr) => { ... };
+    ($expr:expr, $ret:expr, $fmt:expr, $($arg:tt)+) => { ... };
+}
+
+ + +
+ + + + + + + + + + \ No newline at end of file diff --git a/notif/Notif.t.html b/notif/Notif.t.html new file mode 100644 index 000000000..0de6c0911 --- /dev/null +++ b/notif/Notif.t.html @@ -0,0 +1,10 @@ + + + + + + +

Redirecting to struct.Notif.html...

+ + + \ No newline at end of file diff --git a/notif/fn.init_notify.html b/notif/fn.init_notify.html new file mode 100644 index 000000000..a5007d180 --- /dev/null +++ b/notif/fn.init_notify.html @@ -0,0 +1,113 @@ + + + + + + + + + + pnmixerlib::notif::init_notify - Rust + + + + + + + + + + + + + + + + + + +
+

Function pnmixerlib::notif::init_notify + + [−] + + [src]

+
pub fn init_notify(appstate: Rc<AppS>)

Initialize the notification subsystem.

+
+ + +
+ + + + + + + + + + \ No newline at end of file diff --git a/notif/index.html b/notif/index.html new file mode 100644 index 000000000..8d29633d4 --- /dev/null +++ b/notif/index.html @@ -0,0 +1,133 @@ + + + + + + + + + + pnmixerlib::notif - Rust + + + + + + + + + + + + + + + + + + +
+

Module pnmixerlib::notif + + [−] + + [src]

+

The notification subsystem.

+ +

This subsystem utilizes libnotify to send notifications as popups +to the desktop.

+

Structs

+ + + + +
Notif +

An expression of our notification system. Holds all the relevant information +needed by Gtk+ callbacks to interact with libnotify.

+

Functions

+ + + + +
init_notify +

Initialize the notification subsystem.

+
+ + +
+ + + + + + + + + + \ No newline at end of file diff --git a/notif/init_notify.v.html b/notif/init_notify.v.html new file mode 100644 index 000000000..9be5c9598 --- /dev/null +++ b/notif/init_notify.v.html @@ -0,0 +1,10 @@ + + + + + + +

Redirecting to fn.init_notify.html...

+ + + \ No newline at end of file diff --git a/notif/sidebar-items.js b/notif/sidebar-items.js new file mode 100644 index 000000000..896425395 --- /dev/null +++ b/notif/sidebar-items.js @@ -0,0 +1 @@ +initSidebarItems({"fn":[["init_notify","Initialize the notification subsystem."]],"struct":[["Notif","An expression of our notification system. Holds all the relevant information needed by Gtk+ callbacks to interact with libnotify."]]}); \ No newline at end of file diff --git a/notif/struct.Notif.html b/notif/struct.Notif.html new file mode 100644 index 000000000..029980070 --- /dev/null +++ b/notif/struct.Notif.html @@ -0,0 +1,124 @@ + + + + + + + + + + pnmixerlib::notif::Notif - Rust + + + + + + + + + + + + + + + + + + +
+

Struct pnmixerlib::notif::Notif + + [−] + + [src]

+
pub struct Notif { /* fields omitted */ }

An expression of our notification system. Holds all the relevant information +needed by Gtk+ callbacks to interact with libnotify.

+

Methods

impl Notif
[src]

+

+

Create a new notification instance from the current preferences.

+

+

Reload the notification instance from the current +preferences.

+

+

Shows a volume notification, e.g. for volume or mute state change.

+

+

Shows a text notification, e.g. for warnings or errors.

+
+ + +
+ + + + + + + + + + \ No newline at end of file diff --git a/pixbuf_new_from_file.m.html b/pixbuf_new_from_file.m.html new file mode 100644 index 000000000..46c64f783 --- /dev/null +++ b/pixbuf_new_from_file.m.html @@ -0,0 +1,10 @@ + + + + + + +

Redirecting to macro.pixbuf_new_from_file.html...

+ + + \ No newline at end of file diff --git a/pixbuf_new_from_png.m.html b/pixbuf_new_from_png.m.html new file mode 100644 index 000000000..0d3ceb44f --- /dev/null +++ b/pixbuf_new_from_png.m.html @@ -0,0 +1,10 @@ + + + + + + +

Redirecting to macro.pixbuf_new_from_png.html...

+ + + \ No newline at end of file diff --git a/prefs/BehaviorPrefs.t.html b/prefs/BehaviorPrefs.t.html new file mode 100644 index 000000000..3aebf26a6 --- /dev/null +++ b/prefs/BehaviorPrefs.t.html @@ -0,0 +1,10 @@ + + + + + + +

Redirecting to struct.BehaviorPrefs.html...

+ + + \ No newline at end of file diff --git a/prefs/DevicePrefs.t.html b/prefs/DevicePrefs.t.html new file mode 100644 index 000000000..37561c5e1 --- /dev/null +++ b/prefs/DevicePrefs.t.html @@ -0,0 +1,10 @@ + + + + + + +

Redirecting to struct.DevicePrefs.html...

+ + + \ No newline at end of file diff --git a/prefs/MiddleClickAction.t.html b/prefs/MiddleClickAction.t.html new file mode 100644 index 000000000..669bbde3f --- /dev/null +++ b/prefs/MiddleClickAction.t.html @@ -0,0 +1,10 @@ + + + + + + +

Redirecting to enum.MiddleClickAction.html...

+ + + \ No newline at end of file diff --git a/prefs/NotifyPrefs.t.html b/prefs/NotifyPrefs.t.html new file mode 100644 index 000000000..efd3b6e7b --- /dev/null +++ b/prefs/NotifyPrefs.t.html @@ -0,0 +1,10 @@ + + + + + + +

Redirecting to struct.NotifyPrefs.html...

+ + + \ No newline at end of file diff --git a/prefs/Prefs.t.html b/prefs/Prefs.t.html new file mode 100644 index 000000000..a2536cdd9 --- /dev/null +++ b/prefs/Prefs.t.html @@ -0,0 +1,10 @@ + + + + + + +

Redirecting to struct.Prefs.html...

+ + + \ No newline at end of file diff --git a/prefs/ViewPrefs.t.html b/prefs/ViewPrefs.t.html new file mode 100644 index 000000000..2bcf3e418 --- /dev/null +++ b/prefs/ViewPrefs.t.html @@ -0,0 +1,10 @@ + + + + + + +

Redirecting to struct.ViewPrefs.html...

+ + + \ No newline at end of file diff --git a/prefs/VolColor.t.html b/prefs/VolColor.t.html new file mode 100644 index 000000000..97a2fad2b --- /dev/null +++ b/prefs/VolColor.t.html @@ -0,0 +1,10 @@ + + + + + + +

Redirecting to struct.VolColor.html...

+ + + \ No newline at end of file diff --git a/prefs/enum.MiddleClickAction.html b/prefs/enum.MiddleClickAction.html new file mode 100644 index 000000000..522579351 --- /dev/null +++ b/prefs/enum.MiddleClickAction.html @@ -0,0 +1,134 @@ + + + + + + + + + + pnmixerlib::prefs::MiddleClickAction - Rust + + + + + + + + + + + + + + + + + + +
+

Enum pnmixerlib::prefs::MiddleClickAction + + [−] + + [src]

+
pub enum MiddleClickAction {
+    ToggleMute,
+    ShowPreferences,
+    VolumeControl,
+    CustomCommand,
+}

When the tray icon is middle-clicked.

+

Variants

+

Trait Implementations

impl Debug for MiddleClickAction
[src]

+

+

Formats the value using the given formatter.

+

impl Clone for MiddleClickAction
[src]

+

+

Returns a copy of the value. Read more

+

+

Performs copy-assignment from source. Read more

+

impl Copy for MiddleClickAction
[src]

+

impl Default for MiddleClickAction
[src]

+

+

Returns the "default value" for a type. Read more

+

impl From<i32> for MiddleClickAction
[src]

+

+

Performs the conversion.

+
+ + +
+ + + + + + + + + + \ No newline at end of file diff --git a/prefs/index.html b/prefs/index.html new file mode 100644 index 000000000..9ee256b3d --- /dev/null +++ b/prefs/index.html @@ -0,0 +1,168 @@ + + + + + + + + + + pnmixerlib::prefs - Rust + + + + + + + + + + + + + + + + + + +
+

Module pnmixerlib::prefs + + [−] + + [src]

+

The preferences subsystem.

+ +

These are the global application preferences, which can be set +by the user. They read from a file in TOML format, presented +in the preferences dialog and saved back to the file on request.

+

Structs

+ + + + + + + + + + + + + + + + + + + + + + + + +
BehaviorPrefs +

Behavior preferences tab.

+
DevicePrefs +

Device preferences tab.

+
NotifyPrefs +

Notifications preferences tab.

+
Prefs +

Main preferences struct, holding all sub-preferences.

+
ViewPrefs +

View preferences tab.

+
VolColor +

Volume color setting in the view preferences tab.

+

Enums

+ + + + +
MiddleClickAction +

When the tray icon is middle-clicked.

+
+ + +
+ + + + + + + + + + \ No newline at end of file diff --git a/prefs/sidebar-items.js b/prefs/sidebar-items.js new file mode 100644 index 000000000..2eaab2413 --- /dev/null +++ b/prefs/sidebar-items.js @@ -0,0 +1 @@ +initSidebarItems({"enum":[["MiddleClickAction","When the tray icon is middle-clicked."]],"struct":[["BehaviorPrefs","Behavior preferences tab."],["DevicePrefs","Device preferences tab."],["NotifyPrefs","Notifications preferences tab."],["Prefs","Main preferences struct, holding all sub-preferences."],["ViewPrefs","View preferences tab."],["VolColor","Volume color setting in the view preferences tab."]]}); \ No newline at end of file diff --git a/prefs/struct.BehaviorPrefs.html b/prefs/struct.BehaviorPrefs.html new file mode 100644 index 000000000..56826d6e5 --- /dev/null +++ b/prefs/struct.BehaviorPrefs.html @@ -0,0 +1,144 @@ + + + + + + + + + + pnmixerlib::prefs::BehaviorPrefs - Rust + + + + + + + + + + + + + + + + + + +
+

Struct pnmixerlib::prefs::BehaviorPrefs + + [−] + + [src]

+
pub struct BehaviorPrefs {
+    pub unmute_on_vol_change: bool,
+    pub vol_control_cmd: Option<String>,
+    pub vol_scroll_step: f64,
+    pub vol_fine_scroll_step: f64,
+    pub middle_click_action: MiddleClickAction,
+    pub custom_command: Option<String>,
+}

Behavior preferences tab.

+

Fields

+ + + + + +

Trait Implementations

impl Debug for BehaviorPrefs
[src]

+

+

Formats the value using the given formatter.

+

impl Default for BehaviorPrefs
[src]

+

+

Returns the "default value" for a type. Read more

+
+ + +
+ + + + + + + + + + \ No newline at end of file diff --git a/prefs/struct.DevicePrefs.html b/prefs/struct.DevicePrefs.html new file mode 100644 index 000000000..2444ab7e6 --- /dev/null +++ b/prefs/struct.DevicePrefs.html @@ -0,0 +1,128 @@ + + + + + + + + + + pnmixerlib::prefs::DevicePrefs - Rust + + + + + + + + + + + + + + + + + + +
+

Struct pnmixerlib::prefs::DevicePrefs + + [−] + + [src]

+
pub struct DevicePrefs {
+    pub card: String,
+    pub channel: String,
+}

Device preferences tab.

+

Fields

+ +

Trait Implementations

impl Debug for DevicePrefs
[src]

+

+

Formats the value using the given formatter.

+

impl Default for DevicePrefs
[src]

+

+

Returns the "default value" for a type. Read more

+
+ + +
+ + + + + + + + + + \ No newline at end of file diff --git a/prefs/struct.NotifyPrefs.html b/prefs/struct.NotifyPrefs.html new file mode 100644 index 000000000..29319614c --- /dev/null +++ b/prefs/struct.NotifyPrefs.html @@ -0,0 +1,140 @@ + + + + + + + + + + pnmixerlib::prefs::NotifyPrefs - Rust + + + + + + + + + + + + + + + + + + +
+

Struct pnmixerlib::prefs::NotifyPrefs + + [−] + + [src]

+
pub struct NotifyPrefs {
+    pub enable_notifications: bool,
+    pub notifcation_timeout: i64,
+    pub notify_mouse_scroll: bool,
+    pub notify_popup: bool,
+    pub notify_external: bool,
+}

Notifications preferences tab.

+

Fields

+ + + + +

Trait Implementations

impl Debug for NotifyPrefs
[src]

+

+

Formats the value using the given formatter.

+

impl Default for NotifyPrefs
[src]

+

+

Returns the "default value" for a type. Read more

+
+ + +
+ + + + + + + + + + \ No newline at end of file diff --git a/prefs/struct.Prefs.html b/prefs/struct.Prefs.html new file mode 100644 index 000000000..90534fc1f --- /dev/null +++ b/prefs/struct.Prefs.html @@ -0,0 +1,152 @@ + + + + + + + + + + pnmixerlib::prefs::Prefs - Rust + + + + + + + + + + + + + + + + + + +
+

Struct pnmixerlib::prefs::Prefs + + [−] + + [src]

+
pub struct Prefs {
+    pub device_prefs: DevicePrefs,
+    pub view_prefs: ViewPrefs,
+    pub behavior_prefs: BehaviorPrefs,
+    pub notify_prefs: NotifyPrefs,
+}

Main preferences struct, holding all sub-preferences.

+

Fields

+ + + +

Methods

impl Prefs
[src]

+

+

+

Reload the current preferences from the config file.

+

+

Store the current preferences to the config file.

+

+

Conver the current preferences to a viewable String.

+

+

Get an available volume control command, which must exist in $PATH. +Tries hard to fine one, +starting with the given preference setting and falling back to the +VOL_CONTROL_COMMANDS slice.

+

Trait Implementations

impl Debug for Prefs
[src]

+

+

Formats the value using the given formatter.

+

impl Default for Prefs
[src]

+

+

Returns the "default value" for a type. Read more

+

impl Display for Prefs
[src]

+

+

Formats the value using the given formatter. Read more

+
+ + +
+ + + + + + + + + + \ No newline at end of file diff --git a/prefs/struct.ViewPrefs.html b/prefs/struct.ViewPrefs.html new file mode 100644 index 000000000..de29aed39 --- /dev/null +++ b/prefs/struct.ViewPrefs.html @@ -0,0 +1,136 @@ + + + + + + + + + + pnmixerlib::prefs::ViewPrefs - Rust + + + + + + + + + + + + + + + + + + +
+

Struct pnmixerlib::prefs::ViewPrefs + + [−] + + [src]

+
pub struct ViewPrefs {
+    pub draw_vol_meter: bool,
+    pub vol_meter_offset: i32,
+    pub system_theme: bool,
+    pub vol_meter_color: VolColor,
+}

View preferences tab.

+

Fields

+ + + +

Trait Implementations

impl Debug for ViewPrefs
[src]

+

+

Formats the value using the given formatter.

+

impl Default for ViewPrefs
[src]

+

+

Returns the "default value" for a type. Read more

+
+ + +
+ + + + + + + + + + \ No newline at end of file diff --git a/prefs/struct.VolColor.html b/prefs/struct.VolColor.html new file mode 100644 index 000000000..c3e952ab7 --- /dev/null +++ b/prefs/struct.VolColor.html @@ -0,0 +1,132 @@ + + + + + + + + + + pnmixerlib::prefs::VolColor - Rust + + + + + + + + + + + + + + + + + + +
+

Struct pnmixerlib::prefs::VolColor + + [−] + + [src]

+
pub struct VolColor {
+    pub red: f64,
+    pub green: f64,
+    pub blue: f64,
+}

Volume color setting in the view preferences tab.

+

Fields

+ + +

Trait Implementations

impl Debug for VolColor
[src]

+

+

Formats the value using the given formatter.

+

impl Default for VolColor
[src]

+

+

Returns the "default value" for a type. Read more

+
+ + +
+ + + + + + + + + + \ No newline at end of file diff --git a/sidebar-items.js b/sidebar-items.js new file mode 100644 index 000000000..d1b192d93 --- /dev/null +++ b/sidebar-items.js @@ -0,0 +1 @@ +initSidebarItems({"macro":[["create_builder_item",""],["pixbuf_new_from_png","Create a pixbuf from the given PNG file. Includes the file as bytes in the binary and decodes it."],["try_e",""],["try_er",""],["try_r",""],["try_w",""],["try_wr",""]],"mod":[["alsa_card","Alsa audio subsystem."],["app_state","Global application state."],["audio","High-level audio subsystem."],["errors",""],["glade_helpers",""],["notif","The notification subsystem."],["prefs","The preferences subsystem."],["support_alsa","Alsa audio helper functions."],["support_audio","Helper functions of the audio subsystem."],["support_cmd","Helper functions for invoking system commands."],["support_ui","Helper functions for the UI, mostly pixbuf functions."],["ui_entry","Global GUI state."],["ui_popup_menu","The popup menu subsystem when the user right-clicks on the tray icon."],["ui_popup_window","The popup window subsystem when the user left-clicks on the tray icon."],["ui_prefs_dialog","The preferences window subsystem, when the user clicks the \"Preferences\" menu item on the popup menu."],["ui_tray_icon","The tray icon subsystem."]]}); \ No newline at end of file diff --git a/support_alsa/alsa_card_has_playable_selem.v.html b/support_alsa/alsa_card_has_playable_selem.v.html new file mode 100644 index 000000000..0b11dd9d9 --- /dev/null +++ b/support_alsa/alsa_card_has_playable_selem.v.html @@ -0,0 +1,10 @@ + + + + + + +

Redirecting to fn.alsa_card_has_playable_selem.html...

+ + + \ No newline at end of file diff --git a/support_alsa/fn.alsa_card_has_playable_selem.html b/support_alsa/fn.alsa_card_has_playable_selem.html new file mode 100644 index 000000000..1aea41f09 --- /dev/null +++ b/support_alsa/fn.alsa_card_has_playable_selem.html @@ -0,0 +1,113 @@ + + + + + + + + + + pnmixerlib::support_alsa::alsa_card_has_playable_selem - Rust + + + + + + + + + + + + + + + + + + +
+

Function pnmixerlib::support_alsa::alsa_card_has_playable_selem + + [−] + + [src]

+
pub fn alsa_card_has_playable_selem(card: &Card) -> bool

Check whether the given alsa card as a playable Selem.

+
+ + +
+ + + + + + + + + + \ No newline at end of file diff --git a/support_alsa/fn.get_alsa_card_by_id.html b/support_alsa/fn.get_alsa_card_by_id.html new file mode 100644 index 000000000..a7896725d --- /dev/null +++ b/support_alsa/fn.get_alsa_card_by_id.html @@ -0,0 +1,113 @@ + + + + + + + + + + pnmixerlib::support_alsa::get_alsa_card_by_id - Rust + + + + + + + + + + + + + + + + + + +
+

Function pnmixerlib::support_alsa::get_alsa_card_by_id + + [−] + + [src]

+
pub fn get_alsa_card_by_id(index: c_int) -> Card

Get an alsa card corresponding to the given ID.

+
+ + +
+ + + + + + + + + + \ No newline at end of file diff --git a/support_alsa/fn.get_alsa_card_by_name.html b/support_alsa/fn.get_alsa_card_by_name.html new file mode 100644 index 000000000..98ecf1a4c --- /dev/null +++ b/support_alsa/fn.get_alsa_card_by_name.html @@ -0,0 +1,113 @@ + + + + + + + + + + pnmixerlib::support_alsa::get_alsa_card_by_name - Rust + + + + + + + + + + + + + + + + + + +
+

Function pnmixerlib::support_alsa::get_alsa_card_by_name + + [−] + + [src]

+
pub fn get_alsa_card_by_name(name: String) -> Result<Card>

Get an alsa card by the given name.

+
+ + +
+ + + + + + + + + + \ No newline at end of file diff --git a/support_alsa/fn.get_alsa_cards.html b/support_alsa/fn.get_alsa_cards.html new file mode 100644 index 000000000..8ed6574e9 --- /dev/null +++ b/support_alsa/fn.get_alsa_cards.html @@ -0,0 +1,113 @@ + + + + + + + + + + pnmixerlib::support_alsa::get_alsa_cards - Rust + + + + + + + + + + + + + + + + + + +
+

Function pnmixerlib::support_alsa::get_alsa_cards + + [−] + + [src]

+
pub fn get_alsa_cards() -> Iter

Get all available alsa cards.

+
+ + +
+ + + + + + + + + + \ No newline at end of file diff --git a/support_alsa/fn.get_default_alsa_card.html b/support_alsa/fn.get_default_alsa_card.html new file mode 100644 index 000000000..8ccb92be0 --- /dev/null +++ b/support_alsa/fn.get_default_alsa_card.html @@ -0,0 +1,113 @@ + + + + + + + + + + pnmixerlib::support_alsa::get_default_alsa_card - Rust + + + + + + + + + + + + + + + + + + +
+

Function pnmixerlib::support_alsa::get_default_alsa_card + + [−] + + [src]

+
pub fn get_default_alsa_card() -> Card

Get the default alsa card. This is the one with the ID 0.

+
+ + +
+ + + + + + + + + + \ No newline at end of file diff --git a/support_alsa/fn.get_first_playable_alsa_card.html b/support_alsa/fn.get_first_playable_alsa_card.html new file mode 100644 index 000000000..d6c31e353 --- /dev/null +++ b/support_alsa/fn.get_first_playable_alsa_card.html @@ -0,0 +1,113 @@ + + + + + + + + + + pnmixerlib::support_alsa::get_first_playable_alsa_card - Rust + + + + + + + + + + + + + + + + + + +
+

Function pnmixerlib::support_alsa::get_first_playable_alsa_card + + [−] + + [src]

+
pub fn get_first_playable_alsa_card() -> Result<Card>

Get the first playable alsa card.

+
+ + +
+ + + + + + + + + + \ No newline at end of file diff --git a/support_alsa/fn.get_first_playable_selem.html b/support_alsa/fn.get_first_playable_selem.html new file mode 100644 index 000000000..5adae9f70 --- /dev/null +++ b/support_alsa/fn.get_first_playable_selem.html @@ -0,0 +1,113 @@ + + + + + + + + + + pnmixerlib::support_alsa::get_first_playable_selem - Rust + + + + + + + + + + + + + + + + + + +
+

Function pnmixerlib::support_alsa::get_first_playable_selem + + [−] + + [src]

+
pub fn get_first_playable_selem(mixer: &Mixer) -> Result<Selem>

Get the first playable Selem.

+
+ + +
+ + + + + + + + + + \ No newline at end of file diff --git a/support_alsa/fn.get_mixer.html b/support_alsa/fn.get_mixer.html new file mode 100644 index 000000000..b7eec1337 --- /dev/null +++ b/support_alsa/fn.get_mixer.html @@ -0,0 +1,113 @@ + + + + + + + + + + pnmixerlib::support_alsa::get_mixer - Rust + + + + + + + + + + + + + + + + + + +
+

Function pnmixerlib::support_alsa::get_mixer + + [−] + + [src]

+
pub fn get_mixer(card: &Card) -> Result<Mixer>

Get the Mixer for the given alsa card.

+
+ + +
+ + + + + + + + + + \ No newline at end of file diff --git a/support_alsa/fn.get_playable_alsa_card_names.html b/support_alsa/fn.get_playable_alsa_card_names.html new file mode 100644 index 000000000..2135db88a --- /dev/null +++ b/support_alsa/fn.get_playable_alsa_card_names.html @@ -0,0 +1,113 @@ + + + + + + + + + + pnmixerlib::support_alsa::get_playable_alsa_card_names - Rust + + + + + + + + + + + + + + + + + + +
+

Function pnmixerlib::support_alsa::get_playable_alsa_card_names + + [−] + + [src]

+
pub fn get_playable_alsa_card_names() -> Vec<String>

Get the names of all playable alsa cards.

+
+ + +
+ + + + + + + + + + \ No newline at end of file diff --git a/support_alsa/fn.get_playable_selem_by_name.html b/support_alsa/fn.get_playable_selem_by_name.html new file mode 100644 index 000000000..57d8288d4 --- /dev/null +++ b/support_alsa/fn.get_playable_selem_by_name.html @@ -0,0 +1,113 @@ + + + + + + + + + + pnmixerlib::support_alsa::get_playable_selem_by_name - Rust + + + + + + + + + + + + + + + + + + +
+

Function pnmixerlib::support_alsa::get_playable_selem_by_name + + [−] + + [src]

+
pub fn get_playable_selem_by_name(mixer: &Mixer, name: String) -> Result<Selem>

Get a playable Selem by the given name.

+
+ + +
+ + + + + + + + + + \ No newline at end of file diff --git a/support_alsa/fn.get_playable_selem_names.html b/support_alsa/fn.get_playable_selem_names.html new file mode 100644 index 000000000..5a9ce2548 --- /dev/null +++ b/support_alsa/fn.get_playable_selem_names.html @@ -0,0 +1,113 @@ + + + + + + + + + + pnmixerlib::support_alsa::get_playable_selem_names - Rust + + + + + + + + + + + + + + + + + + +
+

Function pnmixerlib::support_alsa::get_playable_selem_names + + [−] + + [src]

+
pub fn get_playable_selem_names(mixer: &Mixer) -> Vec<String>

Get the names from all playable Selems.

+
+ + +
+ + + + + + + + + + \ No newline at end of file diff --git a/support_alsa/fn.get_playable_selems.html b/support_alsa/fn.get_playable_selems.html new file mode 100644 index 000000000..c28aa1a93 --- /dev/null +++ b/support_alsa/fn.get_playable_selems.html @@ -0,0 +1,113 @@ + + + + + + + + + + pnmixerlib::support_alsa::get_playable_selems - Rust + + + + + + + + + + + + + + + + + + +
+

Function pnmixerlib::support_alsa::get_playable_selems + + [−] + + [src]

+
pub fn get_playable_selems(mixer: &Mixer) -> Vec<Selem>

Get all playable Selems.

+
+ + +
+ + + + + + + + + + \ No newline at end of file diff --git a/support_alsa/fn.get_selem.html b/support_alsa/fn.get_selem.html new file mode 100644 index 000000000..cd50c6310 --- /dev/null +++ b/support_alsa/fn.get_selem.html @@ -0,0 +1,113 @@ + + + + + + + + + + pnmixerlib::support_alsa::get_selem - Rust + + + + + + + + + + + + + + + + + + +
+

Function pnmixerlib::support_alsa::get_selem + + [−] + + [src]

+
pub fn get_selem(elem: Elem) -> Selem

Get the Selem from the given Elem.

+
+ + +
+ + + + + + + + + + \ No newline at end of file diff --git a/support_alsa/fn.selem_is_playable.html b/support_alsa/fn.selem_is_playable.html new file mode 100644 index 000000000..43042168a --- /dev/null +++ b/support_alsa/fn.selem_is_playable.html @@ -0,0 +1,113 @@ + + + + + + + + + + pnmixerlib::support_alsa::selem_is_playable - Rust + + + + + + + + + + + + + + + + + + +
+

Function pnmixerlib::support_alsa::selem_is_playable + + [−] + + [src]

+
pub fn selem_is_playable(selem: &Selem) -> bool

Check whether the given Selem is playable.

+
+ + +
+ + + + + + + + + + \ No newline at end of file diff --git a/support_alsa/get_alsa_card_by_id.v.html b/support_alsa/get_alsa_card_by_id.v.html new file mode 100644 index 000000000..3960d2d7a --- /dev/null +++ b/support_alsa/get_alsa_card_by_id.v.html @@ -0,0 +1,10 @@ + + + + + + +

Redirecting to fn.get_alsa_card_by_id.html...

+ + + \ No newline at end of file diff --git a/support_alsa/get_alsa_card_by_name.v.html b/support_alsa/get_alsa_card_by_name.v.html new file mode 100644 index 000000000..704ffd519 --- /dev/null +++ b/support_alsa/get_alsa_card_by_name.v.html @@ -0,0 +1,10 @@ + + + + + + +

Redirecting to fn.get_alsa_card_by_name.html...

+ + + \ No newline at end of file diff --git a/support_alsa/get_alsa_cards.v.html b/support_alsa/get_alsa_cards.v.html new file mode 100644 index 000000000..b9457cb59 --- /dev/null +++ b/support_alsa/get_alsa_cards.v.html @@ -0,0 +1,10 @@ + + + + + + +

Redirecting to fn.get_alsa_cards.html...

+ + + \ No newline at end of file diff --git a/support_alsa/get_default_alsa_card.v.html b/support_alsa/get_default_alsa_card.v.html new file mode 100644 index 000000000..8cbc39578 --- /dev/null +++ b/support_alsa/get_default_alsa_card.v.html @@ -0,0 +1,10 @@ + + + + + + +

Redirecting to fn.get_default_alsa_card.html...

+ + + \ No newline at end of file diff --git a/support_alsa/get_first_playable_alsa_card.v.html b/support_alsa/get_first_playable_alsa_card.v.html new file mode 100644 index 000000000..eb8edf1de --- /dev/null +++ b/support_alsa/get_first_playable_alsa_card.v.html @@ -0,0 +1,10 @@ + + + + + + +

Redirecting to fn.get_first_playable_alsa_card.html...

+ + + \ No newline at end of file diff --git a/support_alsa/get_first_playable_selem.v.html b/support_alsa/get_first_playable_selem.v.html new file mode 100644 index 000000000..44a7b66de --- /dev/null +++ b/support_alsa/get_first_playable_selem.v.html @@ -0,0 +1,10 @@ + + + + + + +

Redirecting to fn.get_first_playable_selem.html...

+ + + \ No newline at end of file diff --git a/support_alsa/get_mixer.v.html b/support_alsa/get_mixer.v.html new file mode 100644 index 000000000..7dac8c96b --- /dev/null +++ b/support_alsa/get_mixer.v.html @@ -0,0 +1,10 @@ + + + + + + +

Redirecting to fn.get_mixer.html...

+ + + \ No newline at end of file diff --git a/support_alsa/get_playable_alsa_card_names.v.html b/support_alsa/get_playable_alsa_card_names.v.html new file mode 100644 index 000000000..fc5d4c1ff --- /dev/null +++ b/support_alsa/get_playable_alsa_card_names.v.html @@ -0,0 +1,10 @@ + + + + + + +

Redirecting to fn.get_playable_alsa_card_names.html...

+ + + \ No newline at end of file diff --git a/support_alsa/get_playable_selem_by_name.v.html b/support_alsa/get_playable_selem_by_name.v.html new file mode 100644 index 000000000..43037a329 --- /dev/null +++ b/support_alsa/get_playable_selem_by_name.v.html @@ -0,0 +1,10 @@ + + + + + + +

Redirecting to fn.get_playable_selem_by_name.html...

+ + + \ No newline at end of file diff --git a/support_alsa/get_playable_selem_names.v.html b/support_alsa/get_playable_selem_names.v.html new file mode 100644 index 000000000..f0baa75b7 --- /dev/null +++ b/support_alsa/get_playable_selem_names.v.html @@ -0,0 +1,10 @@ + + + + + + +

Redirecting to fn.get_playable_selem_names.html...

+ + + \ No newline at end of file diff --git a/support_alsa/get_playable_selems.v.html b/support_alsa/get_playable_selems.v.html new file mode 100644 index 000000000..9fb82b3c0 --- /dev/null +++ b/support_alsa/get_playable_selems.v.html @@ -0,0 +1,10 @@ + + + + + + +

Redirecting to fn.get_playable_selems.html...

+ + + \ No newline at end of file diff --git a/support_alsa/get_selem.v.html b/support_alsa/get_selem.v.html new file mode 100644 index 000000000..8f8e473c7 --- /dev/null +++ b/support_alsa/get_selem.v.html @@ -0,0 +1,10 @@ + + + + + + +

Redirecting to fn.get_selem.html...

+ + + \ No newline at end of file diff --git a/support_alsa/index.html b/support_alsa/index.html new file mode 100644 index 000000000..3238bad95 --- /dev/null +++ b/support_alsa/index.html @@ -0,0 +1,215 @@ + + + + + + + + + + pnmixerlib::support_alsa - Rust + + + + + + + + + + + + + + + + + + +
+

Module pnmixerlib::support_alsa + + [−] + + [src]

+

Alsa audio helper functions.

+ +

This mod wraps around a few low-level alsa functions and abstracts +out the details we don't care about.

+

Functions

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
alsa_card_has_playable_selem +

Check whether the given alsa card as a playable Selem.

+
get_alsa_card_by_id +

Get an alsa card corresponding to the given ID.

+
get_alsa_card_by_name +

Get an alsa card by the given name.

+
get_alsa_cards +

Get all available alsa cards.

+
get_default_alsa_card +

Get the default alsa card. This is the one with the ID 0.

+
get_first_playable_alsa_card +

Get the first playable alsa card.

+
get_first_playable_selem +

Get the first playable Selem.

+
get_mixer +

Get the Mixer for the given alsa card.

+
get_playable_alsa_card_names +

Get the names of all playable alsa cards.

+
get_playable_selem_by_name +

Get a playable Selem by the given name.

+
get_playable_selem_names +

Get the names from all playable Selems.

+
get_playable_selems +

Get all playable Selems.

+
get_selem +

Get the Selem from the given Elem.

+
selem_is_playable +

Check whether the given Selem is playable.

+
+ + +
+ + + + + + + + + + \ No newline at end of file diff --git a/support_alsa/selem_is_playable.v.html b/support_alsa/selem_is_playable.v.html new file mode 100644 index 000000000..c04bf90df --- /dev/null +++ b/support_alsa/selem_is_playable.v.html @@ -0,0 +1,10 @@ + + + + + + +

Redirecting to fn.selem_is_playable.html...

+ + + \ No newline at end of file diff --git a/support_alsa/sidebar-items.js b/support_alsa/sidebar-items.js new file mode 100644 index 000000000..5d764b7b2 --- /dev/null +++ b/support_alsa/sidebar-items.js @@ -0,0 +1 @@ +initSidebarItems({"fn":[["alsa_card_has_playable_selem","Check whether the given alsa card as a playable `Selem`."],["get_alsa_card_by_id","Get an alsa card corresponding to the given ID."],["get_alsa_card_by_name","Get an alsa card by the given name."],["get_alsa_cards","Get all available alsa cards."],["get_default_alsa_card","Get the default alsa card. This is the one with the ID `0`."],["get_first_playable_alsa_card","Get the first playable alsa card."],["get_first_playable_selem","Get the first playable `Selem`."],["get_mixer","Get the `Mixer` for the given alsa card."],["get_playable_alsa_card_names","Get the names of all playable alsa cards."],["get_playable_selem_by_name","Get a playable `Selem` by the given name."],["get_playable_selem_names","Get the names from all playable `Selem`s."],["get_playable_selems","Get all playable `Selem`s."],["get_selem","Get the `Selem` from the given `Elem`."],["selem_is_playable","Check whether the given `Selem` is playable."]]}); \ No newline at end of file diff --git a/support_audio/VolDir.t.html b/support_audio/VolDir.t.html new file mode 100644 index 000000000..bb09da24f --- /dev/null +++ b/support_audio/VolDir.t.html @@ -0,0 +1,10 @@ + + + + + + +

Redirecting to enum.VolDir.html...

+ + + \ No newline at end of file diff --git a/support_audio/audio_reload.v.html b/support_audio/audio_reload.v.html new file mode 100644 index 000000000..bc161f9dc --- /dev/null +++ b/support_audio/audio_reload.v.html @@ -0,0 +1,10 @@ + + + + + + +

Redirecting to fn.audio_reload.html...

+ + + \ No newline at end of file diff --git a/support_audio/enum.VolDir.html b/support_audio/enum.VolDir.html new file mode 100644 index 000000000..ed105ac13 --- /dev/null +++ b/support_audio/enum.VolDir.html @@ -0,0 +1,127 @@ + + + + + + + + + + pnmixerlib::support_audio::VolDir - Rust + + + + + + + + + + + + + + + + + + +
+

Enum pnmixerlib::support_audio::VolDir + + [−] + + [src]

+
pub enum VolDir {
+    Up,
+    Down,
+    Unknown,
+}

The direction of a volume change.

+

Variants

+

Trait Implementations

impl Clone for VolDir
[src]

+

+

Returns a copy of the value. Read more

+

+

Performs copy-assignment from source. Read more

+

impl Copy for VolDir
[src]

+

impl Debug for VolDir
[src]

+

+

Formats the value using the given formatter.

+
+ + +
+ + + + + + + + + + \ No newline at end of file diff --git a/support_audio/fn.audio_reload.html b/support_audio/fn.audio_reload.html new file mode 100644 index 000000000..4a56b7b86 --- /dev/null +++ b/support_audio/fn.audio_reload.html @@ -0,0 +1,113 @@ + + + + + + + + + + pnmixerlib::support_audio::audio_reload - Rust + + + + + + + + + + + + + + + + + + +
+

Function pnmixerlib::support_audio::audio_reload + + [−] + + [src]

+
pub fn audio_reload(audio: &Audio, prefs: &Prefs, user: AudioUser) -> Result<()>

Reload the audio system.

+
+ + +
+ + + + + + + + + + \ No newline at end of file diff --git a/support_audio/fn.get_playable_card_names.html b/support_audio/fn.get_playable_card_names.html new file mode 100644 index 000000000..2d80d6631 --- /dev/null +++ b/support_audio/fn.get_playable_card_names.html @@ -0,0 +1,113 @@ + + + + + + + + + + pnmixerlib::support_audio::get_playable_card_names - Rust + + + + + + + + + + + + + + + + + + +
+

Function pnmixerlib::support_audio::get_playable_card_names + + [−] + + [src]

+
pub fn get_playable_card_names() -> Vec<String>

Get all playable card names.

+
+ + +
+ + + + + + + + + + \ No newline at end of file diff --git a/support_audio/fn.get_playable_chan_names.html b/support_audio/fn.get_playable_chan_names.html new file mode 100644 index 000000000..4f71c13d5 --- /dev/null +++ b/support_audio/fn.get_playable_chan_names.html @@ -0,0 +1,113 @@ + + + + + + + + + + pnmixerlib::support_audio::get_playable_chan_names - Rust + + + + + + + + + + + + + + + + + + +
+

Function pnmixerlib::support_audio::get_playable_chan_names + + [−] + + [src]

+
pub fn get_playable_chan_names(card_name: String) -> Vec<String>

Get all playable channel names.

+
+ + +
+ + + + + + + + + + \ No newline at end of file diff --git a/support_audio/fn.lrint.html b/support_audio/fn.lrint.html new file mode 100644 index 000000000..5667b91ed --- /dev/null +++ b/support_audio/fn.lrint.html @@ -0,0 +1,115 @@ + + + + + + + + + + pnmixerlib::support_audio::lrint - Rust + + + + + + + + + + + + + + + + + + +
+

Function pnmixerlib::support_audio::lrint + + [−] + + [src]

+
pub fn lrint(v: f64, dir: VolDir) -> f64

Kinda mimics lrint from libm. If the direction of the volume change +is Up then calls ceil(), if it's Down, then calls floor(), otherwise +returns the value unchanged.

+
+ + +
+ + + + + + + + + + \ No newline at end of file diff --git a/support_audio/fn.percent_to_vol.html b/support_audio/fn.percent_to_vol.html new file mode 100644 index 000000000..43017599b --- /dev/null +++ b/support_audio/fn.percent_to_vol.html @@ -0,0 +1,115 @@ + + + + + + + + + + pnmixerlib::support_audio::percent_to_vol - Rust + + + + + + + + + + + + + + + + + + +
+

Function pnmixerlib::support_audio::percent_to_vol + + [−] + + [src]

+
pub fn percent_to_vol(vol: f64, range: (i64, i64), dir: VolDir) -> Result<i64>

Converts the percentage of the volume level (0-100) back to the actual +low-level representation of the volume, which depends on the volume +range.

+
+ + +
+ + + + + + + + + + \ No newline at end of file diff --git a/support_audio/fn.vol_change_to_voldir.html b/support_audio/fn.vol_change_to_voldir.html new file mode 100644 index 000000000..3a6ef6c32 --- /dev/null +++ b/support_audio/fn.vol_change_to_voldir.html @@ -0,0 +1,122 @@ + + + + + + + + + + pnmixerlib::support_audio::vol_change_to_voldir - Rust + + + + + + + + + + + + + + + + + + +
+

Function pnmixerlib::support_audio::vol_change_to_voldir + + [−] + + [src]

+
pub fn vol_change_to_voldir(old: f64, new: f64) -> VolDir

Convert a volume change to the VolDir type.

+ +

old

+

The old volume value.

+ +

new

+

The new volume value.

+ +

Returns

+

The direction of the volume change as Voldir.

+
+ + +
+ + + + + + + + + + \ No newline at end of file diff --git a/support_audio/fn.vol_to_percent.html b/support_audio/fn.vol_to_percent.html new file mode 100644 index 000000000..bc5995b5c --- /dev/null +++ b/support_audio/fn.vol_to_percent.html @@ -0,0 +1,115 @@ + + + + + + + + + + pnmixerlib::support_audio::vol_to_percent - Rust + + + + + + + + + + + + + + + + + + +
+

Function pnmixerlib::support_audio::vol_to_percent + + [−] + + [src]

+
pub fn vol_to_percent(vol: i64, range: (i64, i64)) -> Result<f64>

Converts the actual volume of the audio configuration, which depends +on the volume range, to a scale of 0-100, reprenting the percentage +of the volume level.

+
+ + +
+ + + + + + + + + + \ No newline at end of file diff --git a/support_audio/get_playable_card_names.v.html b/support_audio/get_playable_card_names.v.html new file mode 100644 index 000000000..a7079e115 --- /dev/null +++ b/support_audio/get_playable_card_names.v.html @@ -0,0 +1,10 @@ + + + + + + +

Redirecting to fn.get_playable_card_names.html...

+ + + \ No newline at end of file diff --git a/support_audio/get_playable_chan_names.v.html b/support_audio/get_playable_chan_names.v.html new file mode 100644 index 000000000..924747593 --- /dev/null +++ b/support_audio/get_playable_chan_names.v.html @@ -0,0 +1,10 @@ + + + + + + +

Redirecting to fn.get_playable_chan_names.html...

+ + + \ No newline at end of file diff --git a/support_audio/index.html b/support_audio/index.html new file mode 100644 index 000000000..e0c22bcac --- /dev/null +++ b/support_audio/index.html @@ -0,0 +1,180 @@ + + + + + + + + + + pnmixerlib::support_audio - Rust + + + + + + + + + + + + + + + + + + +
+

Module pnmixerlib::support_audio + + [−] + + [src]

+

Helper functions of the audio subsystem.

+ +

These functions are not directly connected to the Audio struct, +but are important helpers.

+

Enums

+ + + + +
VolDir +

The direction of a volume change.

+

Functions

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
audio_reload +

Reload the audio system.

+
get_playable_card_names +

Get all playable card names.

+
get_playable_chan_names +

Get all playable channel names.

+
lrint +

Kinda mimics lrint from libm. If the direction of the volume change +is Up then calls ceil(), if it's Down, then calls floor(), otherwise +returns the value unchanged.

+
percent_to_vol +

Converts the percentage of the volume level (0-100) back to the actual +low-level representation of the volume, which depends on the volume +range.

+
vol_change_to_voldir +

Convert a volume change to the VolDir type.

+
vol_to_percent +

Converts the actual volume of the audio configuration, which depends +on the volume range, to a scale of 0-100, reprenting the percentage +of the volume level.

+
+ + +
+ + + + + + + + + + \ No newline at end of file diff --git a/support_audio/lrint.v.html b/support_audio/lrint.v.html new file mode 100644 index 000000000..10f6f960f --- /dev/null +++ b/support_audio/lrint.v.html @@ -0,0 +1,10 @@ + + + + + + +

Redirecting to fn.lrint.html...

+ + + \ No newline at end of file diff --git a/support_audio/percent_to_vol.v.html b/support_audio/percent_to_vol.v.html new file mode 100644 index 000000000..8e7b7f23b --- /dev/null +++ b/support_audio/percent_to_vol.v.html @@ -0,0 +1,10 @@ + + + + + + +

Redirecting to fn.percent_to_vol.html...

+ + + \ No newline at end of file diff --git a/support_audio/sidebar-items.js b/support_audio/sidebar-items.js new file mode 100644 index 000000000..5ca6e354a --- /dev/null +++ b/support_audio/sidebar-items.js @@ -0,0 +1 @@ +initSidebarItems({"enum":[["VolDir","The direction of a volume change."]],"fn":[["audio_reload","Reload the audio system."],["get_playable_card_names","Get all playable card names."],["get_playable_chan_names","Get all playable channel names."],["lrint","Kinda mimics `lrint` from libm. If the direction of the volume change is `Up` then calls `ceil()`, if it's `Down`, then calls `floor()`, otherwise returns the value unchanged."],["percent_to_vol","Converts the percentage of the volume level (0-100) back to the actual low-level representation of the volume, which depends on the volume range."],["vol_change_to_voldir","Convert a volume change to the `VolDir` type. ## `old` The old volume value. ## `new` The new volume value."],["vol_to_percent","Converts the actual volume of the audio configuration, which depends on the volume range, to a scale of 0-100, reprenting the percentage of the volume level."]]}); \ No newline at end of file diff --git a/support_audio/vol_change_to_voldir.v.html b/support_audio/vol_change_to_voldir.v.html new file mode 100644 index 000000000..5cf63b987 --- /dev/null +++ b/support_audio/vol_change_to_voldir.v.html @@ -0,0 +1,10 @@ + + + + + + +

Redirecting to fn.vol_change_to_voldir.html...

+ + + \ No newline at end of file diff --git a/support_audio/vol_to_percent.v.html b/support_audio/vol_to_percent.v.html new file mode 100644 index 000000000..c8c496d18 --- /dev/null +++ b/support_audio/vol_to_percent.v.html @@ -0,0 +1,10 @@ + + + + + + +

Redirecting to fn.vol_to_percent.html...

+ + + \ No newline at end of file diff --git a/support_cmd/execute_command.v.html b/support_cmd/execute_command.v.html new file mode 100644 index 000000000..9e41bdf08 --- /dev/null +++ b/support_cmd/execute_command.v.html @@ -0,0 +1,10 @@ + + + + + + +

Redirecting to fn.execute_command.html...

+ + + \ No newline at end of file diff --git a/support_cmd/execute_vol_control_command.v.html b/support_cmd/execute_vol_control_command.v.html new file mode 100644 index 000000000..70a7cef10 --- /dev/null +++ b/support_cmd/execute_vol_control_command.v.html @@ -0,0 +1,10 @@ + + + + + + +

Redirecting to fn.execute_vol_control_command.html...

+ + + \ No newline at end of file diff --git a/support_cmd/fn.execute_command.html b/support_cmd/fn.execute_command.html new file mode 100644 index 000000000..8afbadbc6 --- /dev/null +++ b/support_cmd/fn.execute_command.html @@ -0,0 +1,113 @@ + + + + + + + + + + pnmixerlib::support_cmd::execute_command - Rust + + + + + + + + + + + + + + + + + + +
+

Function pnmixerlib::support_cmd::execute_command + + [−] + + [src]

+
pub fn execute_command(cmd: &str) -> Result<()>

Try to execute the given command asynchronously via gtk.

+
+ + +
+ + + + + + + + + + \ No newline at end of file diff --git a/support_cmd/fn.execute_vol_control_command.html b/support_cmd/fn.execute_vol_control_command.html new file mode 100644 index 000000000..fd40047c1 --- /dev/null +++ b/support_cmd/fn.execute_vol_control_command.html @@ -0,0 +1,115 @@ + + + + + + + + + + pnmixerlib::support_cmd::execute_vol_control_command - Rust + + + + + + + + + + + + + + + + + + +
+

Function pnmixerlib::support_cmd::execute_vol_control_command + + [−] + + [src]

+
pub fn execute_vol_control_command(prefs: &Prefs) -> Result<()>

Execute an available volume control command asynchronously, starting with +the preferences and using some fallback values. If none of these +are valid executables in $PATH, then return Err(err).

+
+ + +
+ + + + + + + + + + \ No newline at end of file diff --git a/support_cmd/index.html b/support_cmd/index.html new file mode 100644 index 000000000..92a70b5fb --- /dev/null +++ b/support_cmd/index.html @@ -0,0 +1,130 @@ + + + + + + + + + + pnmixerlib::support_cmd - Rust + + + + + + + + + + + + + + + + + + +
+

Module pnmixerlib::support_cmd + + [−] + + [src]

+

Helper functions for invoking system commands.

+

Functions

+ + + + + + + + +
execute_command +

Try to execute the given command asynchronously via gtk.

+
execute_vol_control_command +

Execute an available volume control command asynchronously, starting with +the preferences and using some fallback values. If none of these +are valid executables in $PATH, then return Err(err).

+
+ + +
+ + + + + + + + + + \ No newline at end of file diff --git a/support_cmd/sidebar-items.js b/support_cmd/sidebar-items.js new file mode 100644 index 000000000..61f739178 --- /dev/null +++ b/support_cmd/sidebar-items.js @@ -0,0 +1 @@ +initSidebarItems({"fn":[["execute_command","Try to execute the given command asynchronously via gtk."],["execute_vol_control_command","Execute an available volume control command asynchronously, starting with the preferences and using some fallback values. If none of these are valid executables in `$PATH`, then return `Err(err)`."]]}); \ No newline at end of file diff --git a/support_ui/copy_pixbuf.v.html b/support_ui/copy_pixbuf.v.html new file mode 100644 index 000000000..498a26ee2 --- /dev/null +++ b/support_ui/copy_pixbuf.v.html @@ -0,0 +1,10 @@ + + + + + + +

Redirecting to fn.copy_pixbuf.html...

+ + + \ No newline at end of file diff --git a/support_ui/fn.copy_pixbuf.html b/support_ui/fn.copy_pixbuf.html new file mode 100644 index 000000000..0031c8122 --- /dev/null +++ b/support_ui/fn.copy_pixbuf.html @@ -0,0 +1,114 @@ + + + + + + + + + + pnmixerlib::support_ui::copy_pixbuf - Rust + + + + + + + + + + + + + + + + + + +
+

Function pnmixerlib::support_ui::copy_pixbuf + + [−] + + [src]

+
pub fn copy_pixbuf(pixbuf: &Pixbuf) -> Pixbuf

Copy a Pixbuf explicitly, since they don't implement the Copy trait. +Currently does not call gdk_pixbuf_copy_options().

+
+ + +
+ + + + + + + + + + \ No newline at end of file diff --git a/support_ui/fn.pixbuf_new_from_theme.html b/support_ui/fn.pixbuf_new_from_theme.html new file mode 100644 index 000000000..d58dd1881 --- /dev/null +++ b/support_ui/fn.pixbuf_new_from_theme.html @@ -0,0 +1,114 @@ + + + + + + + + + + pnmixerlib::support_ui::pixbuf_new_from_theme - Rust + + + + + + + + + + + + + + + + + + +
+

Function pnmixerlib::support_ui::pixbuf_new_from_theme + + [−] + + [src]

+
pub fn pixbuf_new_from_theme(
    icon_name: &str, 
    size: i32, 
    theme: &IconTheme
) -> Result<Pixbuf>

Get a pixbuf by name from the given theme with the requested size. +Note that the size is not enforced, but rather a hint.

+
+ + +
+ + + + + + + + + + \ No newline at end of file diff --git a/support_ui/index.html b/support_ui/index.html new file mode 100644 index 000000000..fa29f1caf --- /dev/null +++ b/support_ui/index.html @@ -0,0 +1,130 @@ + + + + + + + + + + pnmixerlib::support_ui - Rust + + + + + + + + + + + + + + + + + + +
+

Module pnmixerlib::support_ui + + [−] + + [src]

+

Helper functions for the UI, mostly pixbuf functions.

+

Functions

+ + + + + + + + +
copy_pixbuf +

Copy a Pixbuf explicitly, since they don't implement the Copy trait. +Currently does not call gdk_pixbuf_copy_options().

+
pixbuf_new_from_theme +

Get a pixbuf by name from the given theme with the requested size. +Note that the size is not enforced, but rather a hint.

+
+ + +
+ + + + + + + + + + \ No newline at end of file diff --git a/support_ui/pixbuf_new_from_theme.v.html b/support_ui/pixbuf_new_from_theme.v.html new file mode 100644 index 000000000..997c43254 --- /dev/null +++ b/support_ui/pixbuf_new_from_theme.v.html @@ -0,0 +1,10 @@ + + + + + + +

Redirecting to fn.pixbuf_new_from_theme.html...

+ + + \ No newline at end of file diff --git a/support_ui/sidebar-items.js b/support_ui/sidebar-items.js new file mode 100644 index 000000000..84082a46e --- /dev/null +++ b/support_ui/sidebar-items.js @@ -0,0 +1 @@ +initSidebarItems({"fn":[["copy_pixbuf","Copy a `Pixbuf` explicitly, since they don't implement the `Copy` trait. Currently does not call `gdk_pixbuf_copy_options()`."],["pixbuf_new_from_theme","Get a pixbuf by name from the given theme with the requested size. Note that the size is not enforced, but rather a hint."]]}); \ No newline at end of file diff --git a/try_e.m.html b/try_e.m.html new file mode 100644 index 000000000..32d0e962f --- /dev/null +++ b/try_e.m.html @@ -0,0 +1,10 @@ + + + + + + +

Redirecting to macro.try_e.html...

+ + + \ No newline at end of file diff --git a/try_er.m.html b/try_er.m.html new file mode 100644 index 000000000..a97ab9d12 --- /dev/null +++ b/try_er.m.html @@ -0,0 +1,10 @@ + + + + + + +

Redirecting to macro.try_er.html...

+ + + \ No newline at end of file diff --git a/try_r.m.html b/try_r.m.html new file mode 100644 index 000000000..b076b6f4f --- /dev/null +++ b/try_r.m.html @@ -0,0 +1,10 @@ + + + + + + +

Redirecting to macro.try_r.html...

+ + + \ No newline at end of file diff --git a/try_w.m.html b/try_w.m.html new file mode 100644 index 000000000..4158d0449 --- /dev/null +++ b/try_w.m.html @@ -0,0 +1,10 @@ + + + + + + +

Redirecting to macro.try_w.html...

+ + + \ No newline at end of file diff --git a/try_wr.m.html b/try_wr.m.html new file mode 100644 index 000000000..ec049d105 --- /dev/null +++ b/try_wr.m.html @@ -0,0 +1,10 @@ + + + + + + +

Redirecting to macro.try_wr.html...

+ + + \ No newline at end of file diff --git a/ui_entry/Gui.t.html b/ui_entry/Gui.t.html new file mode 100644 index 000000000..9b43f9547 --- /dev/null +++ b/ui_entry/Gui.t.html @@ -0,0 +1,10 @@ + + + + + + +

Redirecting to struct.Gui.html...

+ + + \ No newline at end of file diff --git a/ui_entry/fn.init.html b/ui_entry/fn.init.html new file mode 100644 index 000000000..cea664d6a --- /dev/null +++ b/ui_entry/fn.init.html @@ -0,0 +1,113 @@ + + + + + + + + + + pnmixerlib::ui_entry::init - Rust + + + + + + + + + + + + + + + + + + +
+

Function pnmixerlib::ui_entry::init + + [−] + + [src]

+
pub fn init(appstate: Rc<AppS>)

Initialize the GUI system.

+
+ + +
+ + + + + + + + + + \ No newline at end of file diff --git a/ui_entry/index.html b/ui_entry/index.html new file mode 100644 index 000000000..220113c89 --- /dev/null +++ b/ui_entry/index.html @@ -0,0 +1,130 @@ + + + + + + + + + + pnmixerlib::ui_entry - Rust + + + + + + + + + + + + + + + + + + +
+

Module pnmixerlib::ui_entry + + [−] + + [src]

+

Global GUI state.

+

Structs

+ + + + +
Gui +

The GUI struct mostly describing the main widgets (mostly wrapped) +the user interacts with.

+

Functions

+ + + + +
init +

Initialize the GUI system.

+
+ + +
+ + + + + + + + + + \ No newline at end of file diff --git a/ui_entry/init.v.html b/ui_entry/init.v.html new file mode 100644 index 000000000..3be617d49 --- /dev/null +++ b/ui_entry/init.v.html @@ -0,0 +1,10 @@ + + + + + + +

Redirecting to fn.init.html...

+ + + \ No newline at end of file diff --git a/ui_entry/sidebar-items.js b/ui_entry/sidebar-items.js new file mode 100644 index 000000000..47ea6893d --- /dev/null +++ b/ui_entry/sidebar-items.js @@ -0,0 +1 @@ +initSidebarItems({"fn":[["init","Initialize the GUI system."]],"struct":[["Gui","The GUI struct mostly describing the main widgets (mostly wrapped) the user interacts with."]]}); \ No newline at end of file diff --git a/ui_entry/struct.Gui.html b/ui_entry/struct.Gui.html new file mode 100644 index 000000000..09efda8d1 --- /dev/null +++ b/ui_entry/struct.Gui.html @@ -0,0 +1,139 @@ + + + + + + + + + + pnmixerlib::ui_entry::Gui - Rust + + + + + + + + + + + + + + + + + + +
+

Struct pnmixerlib::ui_entry::Gui + + [−] + + [src]

+
pub struct Gui {
+    pub tray_icon: TrayIcon,
+    pub popup_window: PopupWindow,
+    pub popup_menu: PopupMenu,
+    pub prefs_dialog: RefCell<Option<PrefsDialog>>,
+    // some fields omitted
+}

The GUI struct mostly describing the main widgets (mostly wrapped) +the user interacts with.

+

Fields

+

The tray icon.

+
+

The popup window.

+
+

The popup menu.

+
+

The preferences dialog.

+

Methods

impl Gui
[src]

+

+

Constructor. The prefs dialog is initialized as None.

+
+ + +
+ + + + + + + + + + \ No newline at end of file diff --git a/ui_popup_menu/PopupMenu.t.html b/ui_popup_menu/PopupMenu.t.html new file mode 100644 index 000000000..f22ded46b --- /dev/null +++ b/ui_popup_menu/PopupMenu.t.html @@ -0,0 +1,10 @@ + + + + + + +

Redirecting to struct.PopupMenu.html...

+ + + \ No newline at end of file diff --git a/ui_popup_menu/fn.init_popup_menu.html b/ui_popup_menu/fn.init_popup_menu.html new file mode 100644 index 000000000..9c8d2a2a2 --- /dev/null +++ b/ui_popup_menu/fn.init_popup_menu.html @@ -0,0 +1,113 @@ + + + + + + + + + + pnmixerlib::ui_popup_menu::init_popup_menu - Rust + + + + + + + + + + + + + + + + + + +
+

Function pnmixerlib::ui_popup_menu::init_popup_menu + + [−] + + [src]

+
pub fn init_popup_menu(appstate: Rc<AppS>)

Initialize the popup menu subsystem, registering all callbacks.

+
+ + +
+ + + + + + + + + + \ No newline at end of file diff --git a/ui_popup_menu/index.html b/ui_popup_menu/index.html new file mode 100644 index 000000000..12bf30c50 --- /dev/null +++ b/ui_popup_menu/index.html @@ -0,0 +1,140 @@ + + + + + + + + + + pnmixerlib::ui_popup_menu - Rust + + + + + + + + + + + + + + + + + + +
+

Module pnmixerlib::ui_popup_menu + + [−] + + [src]

+

The popup menu subsystem when the user right-clicks on the tray icon.

+ +

Shows the menu with the following entries:

+ +
    +
  • Mute
    • +
  • Volume Control
    • +
  • Preferences
    • +
  • Reload Sound
    • +
  • About
    • +
  • Quit
    • +
+

Structs

+ + + + +
PopupMenu + +

Functions

+ + + + +
init_popup_menu +

Initialize the popup menu subsystem, registering all callbacks.

+
+ + +
+ + + + + + + + + + \ No newline at end of file diff --git a/ui_popup_menu/init_popup_menu.v.html b/ui_popup_menu/init_popup_menu.v.html new file mode 100644 index 000000000..de20c1279 --- /dev/null +++ b/ui_popup_menu/init_popup_menu.v.html @@ -0,0 +1,10 @@ + + + + + + +

Redirecting to fn.init_popup_menu.html...

+ + + \ No newline at end of file diff --git a/ui_popup_menu/sidebar-items.js b/ui_popup_menu/sidebar-items.js new file mode 100644 index 000000000..7ad712825 --- /dev/null +++ b/ui_popup_menu/sidebar-items.js @@ -0,0 +1 @@ +initSidebarItems({"fn":[["init_popup_menu","Initialize the popup menu subsystem, registering all callbacks."]],"struct":[["PopupMenu",""]]}); \ No newline at end of file diff --git a/ui_popup_menu/struct.PopupMenu.html b/ui_popup_menu/struct.PopupMenu.html new file mode 100644 index 000000000..ed7bd4459 --- /dev/null +++ b/ui_popup_menu/struct.PopupMenu.html @@ -0,0 +1,155 @@ + + + + + + + + + + pnmixerlib::ui_popup_menu::PopupMenu - Rust + + + + + + + + + + + + + + + + + + +
+

Struct pnmixerlib::ui_popup_menu::PopupMenu + + [−] + + [src]

+
pub struct PopupMenu {
+    pub menu_window: Window,
+    pub menubar: MenuBar,
+    pub menu: Menu,
+    pub about_item: MenuItem,
+    pub mixer_item: MenuItem,
+    pub mute_item: MenuItem,
+    pub mute_check: CheckButton,
+    pub prefs_item: MenuItem,
+    pub quit_item: MenuItem,
+    pub reload_item: MenuItem,
+}

Fields

+ + + + + + + + + +

Methods

impl PopupMenu
[src]

+

+
+ + +
+ + + + + + + + + + \ No newline at end of file diff --git a/ui_popup_window/PopupWindow.t.html b/ui_popup_window/PopupWindow.t.html new file mode 100644 index 000000000..ba7b3727a --- /dev/null +++ b/ui_popup_window/PopupWindow.t.html @@ -0,0 +1,10 @@ + + + + + + +

Redirecting to struct.PopupWindow.html...

+ + + \ No newline at end of file diff --git a/ui_popup_window/fn.init_popup_window.html b/ui_popup_window/fn.init_popup_window.html new file mode 100644 index 000000000..73419b7fc --- /dev/null +++ b/ui_popup_window/fn.init_popup_window.html @@ -0,0 +1,113 @@ + + + + + + + + + + pnmixerlib::ui_popup_window::init_popup_window - Rust + + + + + + + + + + + + + + + + + + +
+

Function pnmixerlib::ui_popup_window::init_popup_window + + [−] + + [src]

+
pub fn init_popup_window(appstate: Rc<AppS>)

Initialize the popup window subsystem.

+
+ + +
+ + + + + + + + + + \ No newline at end of file diff --git a/ui_popup_window/fn.set_slider.html b/ui_popup_window/fn.set_slider.html new file mode 100644 index 000000000..e69d6418e --- /dev/null +++ b/ui_popup_window/fn.set_slider.html @@ -0,0 +1,113 @@ + + + + + + + + + + pnmixerlib::ui_popup_window::set_slider - Rust + + + + + + + + + + + + + + + + + + +
+

Function pnmixerlib::ui_popup_window::set_slider + + [−] + + [src]

+
pub fn set_slider(vol_scale_adj: &Adjustment, scale: f64)

Set the volume slider to the given value.

+
+ + +
+ + + + + + + + + + \ No newline at end of file diff --git a/ui_popup_window/index.html b/ui_popup_window/index.html new file mode 100644 index 000000000..f20744de9 --- /dev/null +++ b/ui_popup_window/index.html @@ -0,0 +1,140 @@ + + + + + + + + + + pnmixerlib::ui_popup_window - Rust + + + + + + + + + + + + + + + + + + +
+

Module pnmixerlib::ui_popup_window + + [−] + + [src]

+

The popup window subsystem when the user left-clicks on the tray icon.

+ +

This shows the manipulatable volume slider with the current volume and +the mute checkbox.

+

Structs

+ + + + +
PopupWindow +

The main struct for the popup window, holding all relevant sub-widgets +and some mutable state.

+

Functions

+ + + + + + + + +
init_popup_window +

Initialize the popup window subsystem.

+
set_slider +

Set the volume slider to the given value.

+
+ + +
+ + + + + + + + + + \ No newline at end of file diff --git a/ui_popup_window/init_popup_window.v.html b/ui_popup_window/init_popup_window.v.html new file mode 100644 index 000000000..8aca30d6f --- /dev/null +++ b/ui_popup_window/init_popup_window.v.html @@ -0,0 +1,10 @@ + + + + + + +

Redirecting to fn.init_popup_window.html...

+ + + \ No newline at end of file diff --git a/ui_popup_window/set_slider.v.html b/ui_popup_window/set_slider.v.html new file mode 100644 index 000000000..8b3aba2ca --- /dev/null +++ b/ui_popup_window/set_slider.v.html @@ -0,0 +1,10 @@ + + + + + + +

Redirecting to fn.set_slider.html...

+ + + \ No newline at end of file diff --git a/ui_popup_window/sidebar-items.js b/ui_popup_window/sidebar-items.js new file mode 100644 index 000000000..490659a7f --- /dev/null +++ b/ui_popup_window/sidebar-items.js @@ -0,0 +1 @@ +initSidebarItems({"fn":[["init_popup_window","Initialize the popup window subsystem."],["set_slider","Set the volume slider to the given value."]],"struct":[["PopupWindow","The main struct for the popup window, holding all relevant sub-widgets and some mutable state."]]}); \ No newline at end of file diff --git a/ui_popup_window/struct.PopupWindow.html b/ui_popup_window/struct.PopupWindow.html new file mode 100644 index 000000000..3223db1d0 --- /dev/null +++ b/ui_popup_window/struct.PopupWindow.html @@ -0,0 +1,149 @@ + + + + + + + + + + pnmixerlib::ui_popup_window::PopupWindow - Rust + + + + + + + + + + + + + + + + + + +
+

Struct pnmixerlib::ui_popup_window::PopupWindow + + [−] + + [src]

+
pub struct PopupWindow {
+    pub popup_window: Window,
+    pub vol_scale_adj: Adjustment,
+    pub vol_scale: Scale,
+    pub mute_check: CheckButton,
+    pub mixer_button: Button,
+    // some fields omitted
+}

The main struct for the popup window, holding all relevant sub-widgets +and some mutable state.

+

Fields

+

The main window for the popup window widget.

+
+

The volume scale adjustment.

+
+

The volume scale.

+
+

The mute check button.

+
+

The button to start the external mixer.

+

Methods

impl PopupWindow
[src]

+

+

Constructor.

+

+

Update the popup window state, including the slider +and the mute checkbutton.

+

+

Update the mute checkbutton.

+
+ + +
+ + + + + + + + + + \ No newline at end of file diff --git a/ui_prefs_dialog/PrefsDialog.t.html b/ui_prefs_dialog/PrefsDialog.t.html new file mode 100644 index 000000000..837412493 --- /dev/null +++ b/ui_prefs_dialog/PrefsDialog.t.html @@ -0,0 +1,10 @@ + + + + + + +

Redirecting to struct.PrefsDialog.html...

+ + + \ No newline at end of file diff --git a/ui_prefs_dialog/fn.init_prefs_callback.html b/ui_prefs_dialog/fn.init_prefs_callback.html new file mode 100644 index 000000000..7c5a45dba --- /dev/null +++ b/ui_prefs_dialog/fn.init_prefs_callback.html @@ -0,0 +1,114 @@ + + + + + + + + + + pnmixerlib::ui_prefs_dialog::init_prefs_callback - Rust + + + + + + + + + + + + + + + + + + +
+

Function pnmixerlib::ui_prefs_dialog::init_prefs_callback + + [−] + + [src]

+
pub fn init_prefs_callback(appstate: Rc<AppS>)

Initialize the internal prefs dialog handler that connects to the audio +system.

+
+ + +
+ + + + + + + + + + \ No newline at end of file diff --git a/ui_prefs_dialog/fn.show_prefs_dialog.html b/ui_prefs_dialog/fn.show_prefs_dialog.html new file mode 100644 index 000000000..90b80c5a7 --- /dev/null +++ b/ui_prefs_dialog/fn.show_prefs_dialog.html @@ -0,0 +1,114 @@ + + + + + + + + + + pnmixerlib::ui_prefs_dialog::show_prefs_dialog - Rust + + + + + + + + + + + + + + + + + + +
+

Function pnmixerlib::ui_prefs_dialog::show_prefs_dialog + + [−] + + [src]

+
pub fn show_prefs_dialog(appstate: &Rc<AppS>)

Show the preferences dialog. This is created and destroyed dynamically +and not persistent across the application lifetime.

+
+ + +
+ + + + + + + + + + \ No newline at end of file diff --git a/ui_prefs_dialog/index.html b/ui_prefs_dialog/index.html new file mode 100644 index 000000000..4852bbce5 --- /dev/null +++ b/ui_prefs_dialog/index.html @@ -0,0 +1,140 @@ + + + + + + + + + + pnmixerlib::ui_prefs_dialog - Rust + + + + + + + + + + + + + + + + + + +
+

Module pnmixerlib::ui_prefs_dialog + + [−] + + [src]

+

The preferences window subsystem, when the user clicks the "Preferences" +menu item on the popup menu.

+

Structs

+ + + + +
PrefsDialog +

The main preferences dialog, holding all the relevant subwidgets we +need to convert its state to preferences and back.

+

Functions

+ + + + + + + + +
init_prefs_callback +

Initialize the internal prefs dialog handler that connects to the audio +system.

+
show_prefs_dialog +

Show the preferences dialog. This is created and destroyed dynamically +and not persistent across the application lifetime.

+
+ + +
+ + + + + + + + + + \ No newline at end of file diff --git a/ui_prefs_dialog/init_prefs_callback.v.html b/ui_prefs_dialog/init_prefs_callback.v.html new file mode 100644 index 000000000..24c213b54 --- /dev/null +++ b/ui_prefs_dialog/init_prefs_callback.v.html @@ -0,0 +1,10 @@ + + + + + + +

Redirecting to fn.init_prefs_callback.html...

+ + + \ No newline at end of file diff --git a/ui_prefs_dialog/show_prefs_dialog.v.html b/ui_prefs_dialog/show_prefs_dialog.v.html new file mode 100644 index 000000000..516e68925 --- /dev/null +++ b/ui_prefs_dialog/show_prefs_dialog.v.html @@ -0,0 +1,10 @@ + + + + + + +

Redirecting to fn.show_prefs_dialog.html...

+ + + \ No newline at end of file diff --git a/ui_prefs_dialog/sidebar-items.js b/ui_prefs_dialog/sidebar-items.js new file mode 100644 index 000000000..c5c967df8 --- /dev/null +++ b/ui_prefs_dialog/sidebar-items.js @@ -0,0 +1 @@ +initSidebarItems({"fn":[["init_prefs_callback","Initialize the internal prefs dialog handler that connects to the audio system."],["show_prefs_dialog","Show the preferences dialog. This is created and destroyed dynamically and not persistent across the application lifetime."]],"struct":[["PrefsDialog","The main preferences dialog, holding all the relevant subwidgets we need to convert its state to preferences and back."]]}); \ No newline at end of file diff --git a/ui_prefs_dialog/struct.PrefsDialog.html b/ui_prefs_dialog/struct.PrefsDialog.html new file mode 100644 index 000000000..5ea2b97d3 --- /dev/null +++ b/ui_prefs_dialog/struct.PrefsDialog.html @@ -0,0 +1,114 @@ + + + + + + + + + + pnmixerlib::ui_prefs_dialog::PrefsDialog - Rust + + + + + + + + + + + + + + + + + + +
+

Struct pnmixerlib::ui_prefs_dialog::PrefsDialog + + [−] + + [src]

+
pub struct PrefsDialog { /* fields omitted */ }

The main preferences dialog, holding all the relevant subwidgets we +need to convert its state to preferences and back.

+
+ + +
+ + + + + + + + + + \ No newline at end of file diff --git a/ui_tray_icon/AudioPix.t.html b/ui_tray_icon/AudioPix.t.html new file mode 100644 index 000000000..cc5d720de --- /dev/null +++ b/ui_tray_icon/AudioPix.t.html @@ -0,0 +1,10 @@ + + + + + + +

Redirecting to struct.AudioPix.html...

+ + + \ No newline at end of file diff --git a/ui_tray_icon/TrayIcon.t.html b/ui_tray_icon/TrayIcon.t.html new file mode 100644 index 000000000..74d0ca901 --- /dev/null +++ b/ui_tray_icon/TrayIcon.t.html @@ -0,0 +1,10 @@ + + + + + + +

Redirecting to struct.TrayIcon.html...

+ + + \ No newline at end of file diff --git a/ui_tray_icon/VolMeter.t.html b/ui_tray_icon/VolMeter.t.html new file mode 100644 index 000000000..c10ed6058 --- /dev/null +++ b/ui_tray_icon/VolMeter.t.html @@ -0,0 +1,10 @@ + + + + + + +

Redirecting to struct.VolMeter.html...

+ + + \ No newline at end of file diff --git a/ui_tray_icon/fn.init_tray_icon.html b/ui_tray_icon/fn.init_tray_icon.html new file mode 100644 index 000000000..905833ba5 --- /dev/null +++ b/ui_tray_icon/fn.init_tray_icon.html @@ -0,0 +1,113 @@ + + + + + + + + + + pnmixerlib::ui_tray_icon::init_tray_icon - Rust + + + + + + + + + + + + + + + + + + +
+

Function pnmixerlib::ui_tray_icon::init_tray_icon + + [−] + + [src]

+
pub fn init_tray_icon(appstate: Rc<AppS>)

Initialize the tray icon subsystem.

+
+ + +
+ + + + + + + + + + \ No newline at end of file diff --git a/ui_tray_icon/index.html b/ui_tray_icon/index.html new file mode 100644 index 000000000..dfe9036b4 --- /dev/null +++ b/ui_tray_icon/index.html @@ -0,0 +1,147 @@ + + + + + + + + + + pnmixerlib::ui_tray_icon - Rust + + + + + + + + + + + + + + + + + + +
+

Module pnmixerlib::ui_tray_icon + + [−] + + [src]

+

The tray icon subsystem.

+ +

This manages the tray icon Pixbuf as well as the callbacks on left and +right-click.

+

Structs

+ + + + + + + + + + + + +
AudioPix +

The actual tray icon Pixbuf, which depends on the current volume level.

+
TrayIcon +

The tray icon struct, describing the complete visual state.

+
VolMeter +

The volume meter, describes by its colors, offset and width/row +properties.

+

Functions

+ + + + +
init_tray_icon +

Initialize the tray icon subsystem.

+
+ + +
+ + + + + + + + + + \ No newline at end of file diff --git a/ui_tray_icon/init_tray_icon.v.html b/ui_tray_icon/init_tray_icon.v.html new file mode 100644 index 000000000..52e8d74cb --- /dev/null +++ b/ui_tray_icon/init_tray_icon.v.html @@ -0,0 +1,10 @@ + + + + + + +

Redirecting to fn.init_tray_icon.html...

+ + + \ No newline at end of file diff --git a/ui_tray_icon/sidebar-items.js b/ui_tray_icon/sidebar-items.js new file mode 100644 index 000000000..4b0e2a587 --- /dev/null +++ b/ui_tray_icon/sidebar-items.js @@ -0,0 +1 @@ +initSidebarItems({"fn":[["init_tray_icon","Initialize the tray icon subsystem."]],"struct":[["AudioPix","The actual tray icon Pixbuf, which depends on the current volume level."],["TrayIcon","The tray icon struct, describing the complete visual state."],["VolMeter","The volume meter, describes by its colors, offset and width/row properties."]]}); \ No newline at end of file diff --git a/ui_tray_icon/struct.AudioPix.html b/ui_tray_icon/struct.AudioPix.html new file mode 100644 index 000000000..6065348df --- /dev/null +++ b/ui_tray_icon/struct.AudioPix.html @@ -0,0 +1,124 @@ + + + + + + + + + + pnmixerlib::ui_tray_icon::AudioPix - Rust + + + + + + + + + + + + + + + + + + +
+

Struct pnmixerlib::ui_tray_icon::AudioPix + + [−] + + [src]

+
pub struct AudioPix { /* fields omitted */ }

The actual tray icon Pixbuf, which depends on the current volume level.

+

Trait Implementations

impl Clone for AudioPix
[src]

+

+

Returns a copy of the value. Read more

+

+

Performs copy-assignment from source. Read more

+

impl Debug for AudioPix
[src]

+

+

Formats the value using the given formatter.

+

impl Default for AudioPix
[src]

+

+

Returns the "default value" for a type. Read more

+
+ + +
+ + + + + + + + + + \ No newline at end of file diff --git a/ui_tray_icon/struct.TrayIcon.html b/ui_tray_icon/struct.TrayIcon.html new file mode 100644 index 000000000..19d654491 --- /dev/null +++ b/ui_tray_icon/struct.TrayIcon.html @@ -0,0 +1,142 @@ + + + + + + + + + + pnmixerlib::ui_tray_icon::TrayIcon - Rust + + + + + + + + + + + + + + + + + + +
+

Struct pnmixerlib::ui_tray_icon::TrayIcon + + [−] + + [src]

+
pub struct TrayIcon {
+    pub volmeter: RefCell<Option<VolMeter>>,
+    pub audio_pix: RefCell<AudioPix>,
+    pub status_icon: StatusIcon,
+    pub icon_size: Cell<i32>,
+    // some fields omitted
+}

The tray icon struct, describing the complete visual state.

+

Fields

+

The volume meter to draw on the actual Pixbuf, if requested.

+
+

The actual Pixbuf tray icon.

+
+

The gtk StatusIcon widget, used to register callbacks.

+
+

The current icon size.

+

Methods

impl TrayIcon
[src]

+

+

Constructor. audio_pix is initialized as empty GdkPixbuf, to save +one iteration of png decoding (update_all() is triggered immediately +on startup through tray_icon.connect_size_changed.

+

+

Update the whole tray icon state.

+
+ + +
+ + + + + + + + + + \ No newline at end of file diff --git a/ui_tray_icon/struct.VolMeter.html b/ui_tray_icon/struct.VolMeter.html new file mode 100644 index 000000000..079d256bf --- /dev/null +++ b/ui_tray_icon/struct.VolMeter.html @@ -0,0 +1,114 @@ + + + + + + + + + + pnmixerlib::ui_tray_icon::VolMeter - Rust + + + + + + + + + + + + + + + + + + +
+

Struct pnmixerlib::ui_tray_icon::VolMeter + + [−] + + [src]

+
pub struct VolMeter { /* fields omitted */ }

The volume meter, describes by its colors, offset and width/row +properties.

+
+ + +
+ + + + + + + + + + \ No newline at end of file