gtkradiant/libs/generic/callback.cpp

/*
Copyright (C) 2001-2006, William Joseph.
All Rights Reserved.

This file is part of GtkRadiant.

GtkRadiant 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.

GtkRadiant is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with GtkRadiant; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
*/

#include "callback.h"

#if defined(_DEBUG) || defined(DOXYGEN)

namespace ExampleMemberCaller
{
  // MemberCaller example
  class Integer
  {
  public:
    int value;

    void printValue() const
    {
      // print this->value here;
    }

    void setValue()
    {
      value = 3;
    }
    // a typedef to make things more readable
    typedef MemberCaller<Integer, &Integer::setValue> SetValueCaller;
  };

  void example()
  {
    Integer foo = { 0 };

    {
      Callback bar = ConstMemberCaller<Integer, &Integer::printValue>(foo);

      // invoke the callback
      bar(); // foo.printValue()
    }


    {
      // use the typedef to improve readability
      Callback bar = Integer::SetValueCaller(foo);

      // invoke the callback
      bar(); // foo.setValue()
    }
  }
  // end example
}

namespace ExampleReferenceCaller
{
  // ReferenceCaller example
  void Int_printValue(const int& value)
  {
    // print value here;
  }

  void Int_setValue(int& value)
  {
    value = 3;
  }

  // a typedef to make things more readable
  typedef ReferenceCaller<int, Int_setValue> IntSetValueCaller;

  void example()
  {
    int foo = 0;

    {
      Callback bar = ConstReferenceCaller<int, Int_printValue>(foo);

      // invoke the callback
      bar(); // Int_printValue(foo)
    }


    {
      // use the typedef to improve readability
      Callback bar = IntSetValueCaller(foo);

      // invoke the callback
      bar(); // Int_setValue(foo)
    }
  }
  // end example
}

#endif