marco 1.29.1
Window manager
Loading...
Searching...
No Matches
bell.h File Reference
View source

Ring the bell or flash the screen. More...

#include <X11/Xlib.h>
#include "display-private.h"
#include "frame-private.h"
Include dependency graph for bell.h:
This graph shows which files directly or indirectly include this file:

Macros

#define __BELL_H__
 

Functions

void meta_bell_set_audible (MetaDisplay *display, gboolean audible)
 Turns the bell to audible or visual.
 
gboolean meta_bell_init (MetaDisplay *display)
 Initialises the bell subsystem.
 
void meta_bell_shutdown (MetaDisplay *display)
 Shuts down the bell subsystem.
 
void meta_bell_notify_frame_destroy (MetaFrame *frame)
 Deals with a frame being destroyed.
 

Detailed Description

Ring the bell or flash the screen.

Sometimes, X programs "ring the bell", whatever that means. Marco lets the user configure the bell to be audible or visible (aka visual), and if it's visual it can be configured to be frame-flash or fullscreen-flash. We never get told about audible bells; X handles them just fine by itself.

The visual bell was the result of a discussion in Bugzilla here: http://bugzilla.gnome.org/show_bug.cgi?id=99886.

Macro Definition Documentation

◆ __BELL_H__

#define __BELL_H__

Function Documentation

◆ meta_bell_init()

gboolean meta_bell_init ( MetaDisplay *  display)

Initialises the bell subsystem.

This involves intialising XKB (which, despite being a keyboard extension, is the place to look for bell notifications), then asking it to send us bell notifications, and then also switching off the audible bell if we're using a visual one ourselves.

Unlike most X extensions we use, we only initialise XKB here (rather than in main()). It's possible that XKB is not installed at all, but if that was known at build time we will have HAVE_XKB undefined, which will cause this function to be a no-op.

Parameters
displayThe display which is opening
Bug:
There is a line of code that's never run that tells XKB to reset the bell status after we quit. Bill H said (http://bugzilla.gnome.org/show_bug.cgi?id=99886#c12) that XFree86's implementation is broken so we shouldn't call it, but that was in 2002. Is it working now?

References FALSE, NULL, TRUE, and _MetaDisplay::xdisplay.

Referenced by meta_display_open().

◆ meta_bell_notify_frame_destroy()

void meta_bell_notify_frame_destroy ( MetaFrame *  frame)

Deals with a frame being destroyed.

This is important because if we're using a visual bell, we might be flashing the edges of the frame, and so we'd have a timeout function waiting ready to un-flash them. If the frame's going away, we can tell the timeout not to bother.

Parameters
frameThe frame which is being destroyed

References _MetaFrame::is_flashing.

Referenced by meta_window_destroy_frame().

◆ meta_bell_set_audible()

void meta_bell_set_audible ( MetaDisplay *  display,
gboolean  audible 
)

Turns the bell to audible or visual.

This tells X what to do, but not Marco; you will need to set the "visual bell" pref for that.

If the configure script found we had no XKB, this is a no-op.

Parameters
displayThe display we're configuring
audibleTrue for an audible bell, false for a visual bell

Turns the bell to audible or visual.

If the event is on a particular window, flash the screen that window is on. Otherwise, flash every screen on this display.

If the configure script found we had no XKB, this does not exist.

Parameters
displayThe display the event came in on
xkb_evThe bell event

Referenced by prefs_changed_callback().

◆ meta_bell_shutdown()

void meta_bell_shutdown ( MetaDisplay *  display)

Shuts down the bell subsystem.

Parameters
displayThe display which is closing
Bug:
This is never called! If we had XkbSetAutoResetControls enabled in meta_bell_init(), this wouldn't be a problem, but we don't.

References _MetaDisplay::xdisplay.