1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67
|
/*
* Copyright (c) 2007, 2014, Oracle and/or its affiliates. All rights reserved.
*
* 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; version 2 of the
* License.
*
* 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; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA
*/
#ifndef __REFRESH_UI_H__
#define __REFRESH_UI_H__
#include "wbpublic_public_interface.h"
#include <boost/function.hpp>
namespace bec
{
//! Class to save on typing and copy/paste of code. If you need to
//! have a refresh feedback from BE to FE just derive from RefreshUI.
class WBPUBLICBACKEND_PUBLIC_FUNC RefreshUI
{
public:
RefreshUI() {unblock_auto_refresh();}
virtual ~RefreshUI() {}
typedef boost::function<void ()> RefreshSlot;
typedef boost::function<void (const int)> PartialRefreshSlot;
void set_refresh_ui_slot(const RefreshSlot &slot);
// Refreshes a part of the editor. This is preferred over a full UI refresh and should hence
// be used most of the time.
void set_partial_refresh_ui_slot(const PartialRefreshSlot &slot);
void do_partial_ui_refresh(const int what);
void do_ui_refresh();
struct Blocker
{
Blocker(RefreshUI& o) : _obj(&o) {_obj->block_auto_refresh();}
~Blocker() {_obj->unblock_auto_refresh();}
RefreshUI *_obj;
};
void block_auto_refresh() { _partial_refresh_blocked = true; }
void unblock_auto_refresh() { _partial_refresh_blocked = false; }
private:
bool _partial_refresh_blocked;
RefreshSlot _refresh_ui;
PartialRefreshSlot _partial_refresh_ui;
};
}
#endif
|