argument_list.h

Go to the documentation of this file.

#ifndef ARGUMENT_LIST_CLASS
#define ARGUMENT_LIST_CLASS

/*****************************************************************************\
*                                                                             *
*  Name   : argument_list                                                     *
*  Author : Chris Koeritz                                                     *
*                                                                             *
*  Purpose:                                                                   *
*                                                                             *
*    This makes it easier to pass arguments to an X windows function.         *
*                                                                             *
*******************************************************************************
* Copyright (c) 1991-$now By Author.  This program is free software; you can  *
* redistribute it and/or modify it under the terms of the GNU General Public  *
* License as published by the Free Software Foundation; either version 2 of   *
* the License or (at your option) any later version.  This is online at:      *
*     http://www.fsf.org/copyleft/gpl.html                                    *
* Please send any updates to: fred@gruntose.com                               *
\*****************************************************************************/

#include "definitions_passive.h"

#include <basis/array.h>
#include <basis/object_base.h>

struct argument_holder {
  String name;
  XtArgVal argument;
};

class WP_PASSIVE_CLASS_STYLE argument_list : private array<argument_holder>
{
public:
  argument_list();
  argument_list(const argument_list &to_copy);
  virtual ~argument_list();

  IMPLEMENT_CLASS_NAME("argument_list");

  void add(String argument_name, XtArgVal contents);
  void add(String argument_name, int contents);
  void add(String argument_name, window_string contents);
  void add(String argument_name, const istring &contents);
    // Puts another X windows argument into the list.  This can be done
    // dynamically after using the set of arguments in a call to an X windows
    // function.

  void remove(String argument_name);
    // Chucks an argument out of the array.  If the "argument_name" cannot
    // be found, the argument list is not changed.

  Arg *generate();
    // Creates a list of X windows arguments that can be passed to an X windows
    // function requiring them.  This call can be used repeatedly, and more
    // arguments can be added to the list in between calls to generate.  The
    // returned value should not be destructed externally.  This can also be
    // used within an XtGetValue call; the next call to generate returns a
    // list of arguments that were manipulated by XtGetValue and that set of
    // arguments will continue to be returned by generate until the next
    // call of "add" or "remove".
    // Note: This returns NIL if no arguments are in the list.

  int number() const;
    // Returns the current number of arguments.

  void apply(window_handle to_apply_to);
    // Gathers the arguments and passes them to the windowing system for
    // the handle "to_apply_to".

  argument_list &operator = (const argument_list &to_copy);

private:
  Arg *created_list;

  void zap_created_list();
};

#endif

---