toplevel.h

Go to the documentation of this file.

// toplevel.h                          -*-c++-*-
//
//  Copyright 2000, 2005, 2007-2008 Daniel Burrows
//
//  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 program 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 this program; see the file COPYING.  If not, write to
//  the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
//  Boston, MA 02111-1307, USA.
//
 
#ifndef TOPLEVEL_H
#define TOPLEVEL_H
 
#include <sigc++/signal.h>
 
#include <cwidget/generic/util/ref_ptr.h>
 
namespace cwidget
{
  std::string version();
 
  namespace threads
  {
    class mutex;
  }
 
  namespace widgets
  {
    class widget;
  }
 
  namespace toplevel
  {
    class event
    {
    public:
      virtual void dispatch() = 0;
      virtual ~event();
    };
 
    class slot_event : public event
    {
      sigc::slot0<void> the_slot;
    public:
      slot_event(const sigc::slot0<void> &_the_slot)
        : the_slot(_the_slot)
      {
      }
 
      void dispatch();
    };
 
    void init();
 
    void install_sighandlers();
 
    util::ref_ptr<widgets::widget> settoplevel(const util::ref_ptr<widgets::widget> &widget);
 
    void queuelayout();
 
    void layoutnow();
 
    //   Main loop handlers:
 
    void mainloop(int synch=0);
 
    void post_event(event *ev);
 
    bool poll();
 
    void exitmain();
    // Exits the main loop.
 
    void redraw();
    // Redraws the screen completely from scratch
 
    void update();
 
    void tryupdate();
 
    void updatecursor();
 
    void suspend();
 
    void suspend_without_signals();
 
    void shutdown();
 
    void resume();
 
    int addtimeout(event *ev, int msecs);
 
    void deltimeout(int id);
 
    void handleresize();
    // Does anything needed to handle a window resize event.
    // FIXME: I --think-- that this is now redundant
 
    //  Return a mutex that is held whenever the main loop is processing
    //  events or drawing the screen.  The mutex can be held by other
    //  threads that want to do their own drawing or processing, although
    //  this is highly discouraged (use the event posting system instead
    //  to run code in the main loop).
    threads::mutex &get_mutex();
 
    int get_suspend_count();
 
    extern sigc::signal0<void> main_hook;
    // Called right after we finish handling input in the mainloop.  Can
    // be used (eg) to insert extra actions to be performed after all
    // user-input (aptitude uses this to check for apt errors and pop up a
    // message about them)
  }
}
 
#endif