pogmommy/worf
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

document missing support for x and y offset

Browse source
This commit is contained in:
Alexander Mohr 2025-06-05 20:19:24 +02:00
parent c852847ffc
commit bb3ff26161
2 changed files with 25 additions and 37 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
README.md
View file

@ -133,26 +133,24 @@ The possibilities are endless! Here are some powerful examples of what you can b
### ⚠️ Breaking Changes ### ⚠️ Breaking Changes
| Area | Change | - Runtime behaviour is not guaranteed to be the same and won't ever be, this includes error messages and themes.
|--------------|----------------------------------| - Themes in general are mostly compatible. Worf is using the same entity ids, because worf is build on GTK4 instead of GTK3 there will be differences in the look and feel.
| **Runtime** | Behavior differences | - Configuration files are not 100% compatible, Worf is using toml files instead, for most part this only means strings have to be quoted
| **Themes** | GTK4 vs GTK3 differences | - Color files are not supported
| **Config** | TOML format (quoted strings) | - line_wrap is now called line-wrap
| **Colors** | Color files not supported | - Wofi has a C-API, that is not and won't be supported, but Worf can be used as a rust library.
| **Options** | line_wrap` → `line-wrap` | - Most boolean options now need true or false as argument, as Worf is using the same struct for config and command line arguments and this is the only way to merge both data sources
| **API** | Rust library only | - Removed x,y offset and global coords as GTK4 does not support this anymore, similar results can be achieved with `--location`
| **Booleans** | Explicit `true`/`false` required | - Removed copy_exec as we are not executing a binary to copy data into the clipboard
### 🗑️ Removed Features #### Removed Command Line Arguments
#### Command Line Arguments
- `mode` → Use `show` instead - `mode` → Use `show` instead
- `dmenu` → Use `show` instead - `dmenu` → Use `show` instead
- `D` → Arguments = config now - `D` → Arguments = config now
- `dark` → Auto-detected from theme - `dark` → Auto-detected from theme
- `filter-rate` → No longer needed, Worf is fast enough - `filter-rate` → No longer needed, Worf is fast enough
#### Configuration Options #### Removed configuration Options
- `stylesheet` → Use `style` instead - `stylesheet` → Use `style` instead
- `color`/`colors` → Use GTK4 CSS instead - `color`/`colors` → Use GTK4 CSS instead

38
worf/src/lib/config.rs
View file

@ -230,12 +230,6 @@ pub struct Config {
#[clap(short = 'p', long = "prompt")] #[clap(short = 'p', long = "prompt")]
prompt: Option<String>, prompt: Option<String>,
#[clap(short = 'x', long = "xoffset")]
xoffset: Option<i32>, // todo support this
#[clap(short = 'y', long = "yoffset")]
yoffset: Option<i32>, // todo support this
/// If true a normal window instead of a layer shell will be used /// If true a normal window instead of a layer shell will be used
#[clap(short = 'n', long = "normal-window")] #[clap(short = 'n', long = "normal-window")]
#[serde(default = "default_false")] #[serde(default = "default_false")]
@ -263,7 +257,7 @@ pub struct Config {
/// * terminator /// * terminator
/// ///
/// Must be configured including the needed arguments to launch something /// Must be configured including the needed arguments to launch something
/// i.e. 'kitty -c' /// i.e. '--term "kitty -c"'
#[clap(short = 't', long = "term")] #[clap(short = 't', long = "term")]
term: Option<String>, term: Option<String>,
@ -349,25 +343,23 @@ pub struct Config {
#[clap(long = "image-size")] #[clap(long = "image-size")]
image_size: Option<u16>, image_size: Option<u16>,
key_up: Option<String>, // todo support this // key_up: Option<String>, // todo support this
key_down: Option<String>, // todo support this // key_down: Option<String>, // todo support this
key_left: Option<String>, // todo support this // key_left: Option<String>, // todo support this
key_right: Option<String>, // todo support this // key_right: Option<String>, // todo support this
key_forward: Option<String>, // todo support this // key_forward: Option<String>, // todo support this
key_backward: Option<String>, // todo support this // key_backward: Option<String>, // todo support this
key_submit: Option<String>, // todo support this // key_submit: Option<String>, // todo support this
key_exit: Option<String>, // todo support this // key_exit: Option<String>, // todo support this
key_pgup: Option<String>, // todo support this // key_pgup: Option<String>, // todo support this
key_pgdn: Option<String>, // todo support this // key_pgdn: Option<String>, // todo support this
key_expand: Option<String>, // todo support this // key_expand: Option<String>, // todo support this
key_hide_search: Option<String>, // todo support this // key_hide_search: Option<String>, // todo support this
key_copy: Option<String>, // todo support this // key_copy: Option<String>, // todo support this
// todo re-add this // todo re-add this
// #[serde(flatten)] // #[serde(flatten)]
// key_custom: Option<HashMap<String, String>>, // key_custom: Option<HashMap<String, String>>,
global_coords: Option<bool>, // todo support this
/// If set to `true` the search field willOption<> be hidden. /// If set to `true` the search field willOption<> be hidden.
#[clap(long = "hide-search")] #[clap(long = "hide-search")]
hide_search: Option<bool>, hide_search: Option<bool>,
@ -389,8 +381,6 @@ pub struct Config {
#[clap(long = "layer")] #[clap(long = "layer")]
layer: Option<Layer>, layer: Option<Layer>,
copy_exec: Option<String>, // todo support this
/// If set to `true` single click instead of double click will select /// If set to `true` single click instead of double click will select
/// Defaults to `false` /// Defaults to `false`
#[clap(long = "single-click")] #[clap(long = "single-click")]