Prev |  |

# SandUhr::TimerFactory

## Name

SandUhr::TimerFactory -- CORBA interface for the SandUhr factory objects

## SYNOPSIS

    module SandUhr {
      interface TimerFactory {
        exception InvalidTime { };

        AlarmBeep CreateAlarmBeep (in unsigned short Count);
        AlarmSound CreateAlarmSound (in string SoundFile);
        AlarmCommand CreateAlarmCommand (in string CommandString);

        Timer CreateTimer (in string TimeSpec, in string Message)
                                                    raises (InvalidTime);

        typedef sequence<Timer> TimerVec;
        readonly attribute TimerVec Timers;

        void ShowControl (in boolean Show);
      };
    };

## DESCRIPTION

To create Alarm and Timer objects you should use the `TimerFactory` interface. It is derived from `GNOME::ObjectFactory`. The `TimerFactory` represents the control window and all resources associated to it. `TimerFactory` objects are registered with the GNOME object activation framework OAF.

- Create alarm actions:

      AlarmBeep CreateAlarmBeep (in unsigned short Count);
      AlarmSound CreateAlarmSound (in string SoundFile);
      AlarmCommand CreateAlarmCommand (in string CommandString);

  Create an `AlarmAction` object. This may be assigned to a timer's `Alarm` attribute.

- Create timers:

      Timer CreateTimer (in string TimeSpec, in string Message)
                                                      raises (InvalidTime);

  Create a new timer object. The alarm time is described by `TimeSpec`. The format of this string is explained in the manual section called the alarm time. If `TimeSpec` is the empty string, open a window to query the user for an alarm time. If `TimeSpec` is not a valid alarm time specification, the `InvalidTime` exception is raised.

- Access existing timers:

      typedef sequence<Timer> TimerVec;
      readonly attribute TimerVec Timers;

  This is the list of timers, which are under control of the factory object.

- Display the associated window:

      void ShowControl (in boolean Show);

  Show or hide the control window, which is associated with the timer factory.

## SEE ALSO

SandUhr::Timer(3), SandUhr::AlarmAction(3)

Prev | Home |
SandUhr::AlarmAction | Up |