|
|
| |
 |
|
|
|
| |
|
FVWM - Perl library - FVWM::EventNames
|
|
|
|
|
|
|
FVWM::EventNames
Section: FVWM Perl library (3)
Updated: 2005-08-24
Source: FVWM/EventNames.pm
This page contents
- Return to main index
NAME
FVWM::EventNames - names and types of all FVWM event arguments
SYNOPSIS
use FVWM::EventNames;
print "All event names: ", join(", ", @{allEventNames()}), "\n";
print "All event types: ", join(", ", @{allEventTypes()}), "\n";
my $name = eventName (M_ICON_LOCATION);
my $argValues = eventArgValues(M_ICON_LOCATION, $packedStr);
my $argNames = eventArgNames (M_ICON_LOCATION, $argValues);
my $argTypes = eventArgTypes (M_ICON_LOCATION, $argValues);
my $args = eventArgs (M_ICON_LOCATION, $argValues);
DESCRIPTION
Every event send by fvwm consist of arguments. The argument names and
types vary from one event type to another. For example, event of the
type M_NEW_DESK consists of only one argument desk of type number.
M_NEW_PAGE consists of 5 numeric arguments, M_MINI_ICON consists of 10
arguments of different types.
This class provides information about all fvwm events. It provides such
services as listing all supported event types and their names,
converting event type to event name, listing the event argument names/types,
constructing event argument values from the plain packet data.
Usually you do not need to work with this class directly, but, instead, with
FVWM::Event objects. Hovewer, you may need this class source as a
reference for the names of the event arguments and their types.
PUBLIC FUNCTIONS
- eventName type
-
Returns the string representation of the numeric event type constant,
like M_RAISE_WINDOW or MX_ENTER_WINDOW.
- eventArgValues type packedStr
-
Constructs array ref of argument values for the event type
from the packedStr (as received from fvwm).
If the last argument type of the event is string, for convenience,
everything past the first null (or newline) is automatically stripped
from the last argument value.
- eventArgNames type argValues
-
Returns array ref of argument names of the event type.
argValues is either the real array ref of values (as returned by
eventArgValues) or a number of actual values.
The returned array has the same number of elements.
- eventArgTypes type argValues
-
Returns array ref of argument types of the event type.
argValues is either the real array ref of values (as returned by
eventArgValues) or a number of actual values.
The returned array has the same number of elements.
- eventLoopArgNames type argValues
-
Returns array ref of looped argument names of the event type (or undef).
- eventLoopArgTypes type argValues
-
Returns array ref of looped argument types of the event type (or undef).
- eventArgs type argValues
-
Constructs hash ref of the named arguments for the event type
from the argValues array ref (as returned by eventArgValues).
- eventArgAliases type
-
This method is provided for backward compatibility when argument names
are changed. For example, in the past the argument name of M_NEW_DESK
was desk, but now it is desk_n. Using this method it is possible
to make both names supported. Returns hash ref (old-name => new-name).
- allEventNames
-
Returns array ref of all known event names (strings).
In the list context returns list of these names.
- allEventTypes
-
Returns array ref of all known event types (numbers).
In the list context returns list of these types.
- allEventTypeNames
-
Returns hash ref of all known event names and types (type => name).
SEE ALSO
FVWM::Event.
Index
- NAME
-
- SYNOPSIS
-
- DESCRIPTION
-
- PUBLIC FUNCTIONS
-
- SEE ALSO
-
This document was created by
man2html,
using the manual pages.
Time: 00:51:26 GMT, August 27, 2005
Last modified on August 26, 2005
