Crate rofi_plugin_sys

source · [−]

Expand description

This crate provides raw FFI bindings to Rofi’s C plugin interface, manually written from the headers in /usr/include/rofi.

See the examples folder for examples on how to use this crate.

These bindings are raw, unsafe and very low-level so if you just want to write a Rofi plugin you’ll probably want an easier-to-use library instead, such as rofi-mode.

Re-exports

pub use cairo_sys;

pub use glib_sys;

Modules

Helper utilities.

Small helper to fetch icons. This makes use of the ‘view’ threadpool.

States returned by the rofi window.

Structs

An opaque C type from GLib.

Structure defining a switcher.

Property structure.

RofiDistanceUnit

RofiHighlightColorStyle

Theme highlight.

RofiHighlightStyle

Style of text highlight.

Internal structure for matching.

Structure to hold a range.

Represents the color in a theme.

Structure with data to process by each worker thread.

Bitflags indicating location or gravity of window.

Enums

The type of a property.

Cursor type.

RofiDistanceModifier

Theme image

Style of line.

RofiOrientation

Type of orientation.

Distance unit type.

Constants

ABI version to check if loaded plugin is compatible.

Mode to exit Rofi.

Mode to skip to the next cycle-able dialog.

PREVIOUS_DIALOG

Mode to go to the previous dialog.

Mode to reload current dialog.

Mode to reload the dialog and unset user input.

Statics

ProtypeTypeName

This array maps PropertyType to a user-readable name.

Functions

mode_destroy ^⚠

Destroy the mode.

Free the resources allocated for this mode.

mode_get_completion ^⚠

Get a string that can be used for completion. It should have no markup.

mode_get_display_name ^⚠

Get the name of the mode as it should be presented to the user.

mode_get_display_value ^⚠

Returns the string as it should be displayed for the entry and the state of how it should be displayed.

mode_get_icon ^⚠

Returns the icon for the selected line.

mode_get_message ^⚠

Query the mode for a user display.

mode_get_name ^⚠

Get the name of the mode.

mode_get_num_entries ^⚠

Get the number of entries in the mode.

mode_get_private_data ^⚠

A helper function for modes: get the private data object.

Initialize a mode.

mode_preprocess_input ^⚠

Process the input so it can be used for matching and sorting. This includes removing Pango markup.

mode_result ^⚠

Acts on the user interaction.

mode_set_config ^⚠

Adds the display-name configuration option for the mode. Should be called once for each mode.

mode_set_private_data ^⚠

A helper function for modes: set the private data object.

mode_token_match ^⚠

Match entry against the set of tokens.

Type Definitions

Destroy the current mode. Still ready to restart.

Free the switcher.

ModeGetCompletion

Obtains the string to complete.

ModeGetDisplayValue

Get the string to display for the entry.

Obtains the icon of the entry if available.

Message to show in the message bar.

ModeGetNumEntries

Get the number of entries to display (unfiltered).

Initialize the Mode.

ModePreprocessInput

Preprocess the input for sorting.

Process the result of the user selection.

Token match for the matching algorithm.

Unions