Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: button improvements #1187

Merged
merged 4 commits into from
Oct 11, 2024
Merged

feat: button improvements #1187

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6d77657
feat: add keyboard support for button presses
w-lfchen Sep 1, 2024
b98196c
chore: attribution
w-lfchen Sep 1, 2024
f6647f5
fix: activate eventbox on button release; minor fixes
w-lfchen Sep 2, 2024
48c9b68
docs: improve button and eventbox documentation
w-lfchen Sep 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ All notable changes to eww will be listed here, starting at changes since versio
- Add `min` and `max` function calls to simplexpr (By: ovalkonia)
- Add `flip-x`, `flip-y`, `vertical` options to the graph widget to determine its direction
- Add `transform-origin-x`/`transform-origin-y` properties to transform widget (By: mario-kr)
- Add keyboard support for button presses (By: julianschuler)

## [0.6.0] (21.04.2024)

Expand Down
61 changes: 36 additions & 25 deletions crates/eww/src/widgets/widget_definitions.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,16 +38,16 @@ use yuck::{
/// thus not connecting a new handler unless the condition is met.
macro_rules! connect_signal_handler {
($widget:ident, if $cond:expr, $connect_expr:expr) => {{
const KEY:&str = std::concat!("signal-handler:", std::line!());
unsafe {
let key = ::std::concat!("signal-handler:", ::std::line!());
let old = $widget.data::<gtk::glib::SignalHandlerId>(key);
let old = $widget.data::<gtk::glib::SignalHandlerId>(KEY);

if let Some(old) = old {
let a = old.as_ref().as_raw();
$widget.disconnect(gtk::glib::SignalHandlerId::from_glib(a));
}

$widget.set_data::<gtk::glib::SignalHandlerId>(key, $connect_expr);
$widget.set_data::<gtk::glib::SignalHandlerId>(KEY, $connect_expr);
}
}};
($widget:ident, $connect_expr:expr) => {{
Expand Down Expand Up @@ -494,7 +494,6 @@ fn build_gtk_input(bargs: &mut BuilderArgs) -> Result<gtk::Entry> {
prop(value: as_string) {
gtk_widget.set_text(&value);
},

// @prop onchange - Command to run when the text changes. The placeholder `{}` will be replaced by the value
// @prop timeout - timeout of the command. Default: "200ms"
prop(timeout: as_duration = Duration::from_millis(200), onchange: as_string) {
Expand All @@ -519,23 +518,30 @@ fn build_gtk_input(bargs: &mut BuilderArgs) -> Result<gtk::Entry> {

const WIDGET_NAME_BUTTON: &str = "button";
/// @widget button
/// @desc A button
/// @desc A button containing any widget as it's child. Events are triggered on release.
fn build_gtk_button(bargs: &mut BuilderArgs) -> Result<gtk::Button> {
let gtk_widget = gtk::Button::new();

def_widget!(bargs, _g, gtk_widget, {
prop(
// @prop timeout - timeout of the command. Default: "200ms"
timeout: as_duration = Duration::from_millis(200),
// @prop onclick - a command that get's run when the button is clicked
// @prop onclick - command to run when the button is activated either by leftclicking or keyboard
onclick: as_string = "",
// @prop onmiddleclick - a command that get's run when the button is middleclicked
// @prop onmiddleclick - command to run when the button is middleclicked
onmiddleclick: as_string = "",
// @prop onrightclick - a command that get's run when the button is rightclicked
// @prop onrightclick - command to run when the button is rightclicked
onrightclick: as_string = ""
) {
gtk_widget.add_events(gdk::EventMask::BUTTON_PRESS_MASK);
connect_signal_handler!(gtk_widget, gtk_widget.connect_button_press_event(move |_, evt| {
// animate button upon right-/middleclick (if gtk theme supports it)
// since we do this, we can't use `connect_clicked` as that would always run `onclick` as well
connect_signal_handler!(gtk_widget, gtk_widget.connect_button_press_event(move |button, _| {
button.emit_activate();
glib::Propagation::Proceed
}));
let onclick_ = onclick.clone();
// mouse click events
connect_signal_handler!(gtk_widget, gtk_widget.connect_button_release_event(move |_, evt| {
match evt.button() {
1 => run_command(timeout, &onclick, &[] as &[&str]),
2 => run_command(timeout, &onmiddleclick, &[] as &[&str]),
Expand All @@ -544,8 +550,18 @@ fn build_gtk_button(bargs: &mut BuilderArgs) -> Result<gtk::Button> {
}
glib::Propagation::Proceed
}));
// keyboard events
connect_signal_handler!(gtk_widget, gtk_widget.connect_key_release_event(move |_, evt| {
match evt.scancode() {
// return
36 => run_command(timeout, &onclick_, &[] as &[&str]),
// space
65 => run_command(timeout, &onclick_, &[] as &[&str]),
_ => {},
}
glib::Propagation::Proceed
}));
}

});
Ok(gtk_widget)
}
Expand Down Expand Up @@ -785,26 +801,26 @@ fn build_gtk_event_box(bargs: &mut BuilderArgs) -> Result<gtk::EventBox> {
// Support :hover selector
gtk_widget.connect_enter_notify_event(|gtk_widget, evt| {
if evt.detail() != NotifyType::Inferior {
gtk_widget.clone().set_state_flags(gtk::StateFlags::PRELIGHT, false);
gtk_widget.set_state_flags(gtk::StateFlags::PRELIGHT, false);
}
glib::Propagation::Proceed
});

gtk_widget.connect_leave_notify_event(|gtk_widget, evt| {
if evt.detail() != NotifyType::Inferior {
gtk_widget.clone().unset_state_flags(gtk::StateFlags::PRELIGHT);
gtk_widget.unset_state_flags(gtk::StateFlags::PRELIGHT);
}
glib::Propagation::Proceed
});

// Support :active selector
gtk_widget.connect_button_press_event(|gtk_widget, _| {
gtk_widget.clone().set_state_flags(gtk::StateFlags::ACTIVE, false);
gtk_widget.set_state_flags(gtk::StateFlags::ACTIVE, false);
glib::Propagation::Proceed
});

gtk_widget.connect_button_release_event(|gtk_widget, _| {
gtk_widget.clone().unset_state_flags(gtk::StateFlags::ACTIVE);
gtk_widget.unset_state_flags(gtk::StateFlags::ACTIVE);
glib::Propagation::Proceed
});

Expand Down Expand Up @@ -915,21 +931,18 @@ fn build_gtk_event_box(bargs: &mut BuilderArgs) -> Result<gtk::EventBox> {
};
}));
},

// TODO the fact that we have the same code here as for button is ugly, as we want to keep consistency

prop(
// @prop timeout - timeout of the command. Default: "200ms"
timeout: as_duration = Duration::from_millis(200),
// @prop onclick - a command that get's run when the button is clicked
// @prop onclick - command to run when the widget is clicked
onclick: as_string = "",
// @prop onmiddleclick - a command that get's run when the button is middleclicked
// @prop onmiddleclick - command to run when the widget is middleclicked
onmiddleclick: as_string = "",
// @prop onrightclick - a command that get's run when the button is rightclicked
// @prop onrightclick - command to run when the widget is rightclicked
onrightclick: as_string = ""
) {
gtk_widget.add_events(gdk::EventMask::BUTTON_PRESS_MASK);
connect_signal_handler!(gtk_widget, gtk_widget.connect_button_press_event(move |_, evt| {
connect_signal_handler!(gtk_widget, gtk_widget.connect_button_release_event(move |_, evt| {
match evt.button() {
1 => run_command(timeout, &onclick, &[] as &[&str]),
2 => run_command(timeout, &onmiddleclick, &[] as &[&str]),
Expand All @@ -940,7 +953,6 @@ fn build_gtk_event_box(bargs: &mut BuilderArgs) -> Result<gtk::EventBox> {
}));
}
});

Ok(gtk_widget)
}

Expand Down Expand Up @@ -1181,8 +1193,7 @@ fn build_gtk_stack(bargs: &mut BuilderArgs) -> Result<gtk::Stack> {

const WIDGET_NAME_TRANSFORM: &str = "transform";
/// @widget transform
/// @desc A widget that applies transformations to its content. They are applied in the following
/// order: rotate->translate->scale)
/// @desc A widget that applies transformations to its content. They are applied in the following order: rotate -> translate -> scale
fn build_transform(bargs: &mut BuilderArgs) -> Result<Transform> {
let w = Transform::new();
def_widget!(bargs, _g, w, {
Expand Down
Loading