cppconsui/Widget.cpp

   1 // Copyright (C) 2007 Mark Pustjens <pustjens@dds.nl>
   2 // Copyright (C) 2010-2015 Petr Pavlu <setup@dagobah.cz>
   3 //
   4 // This file is part of CenterIM.
   5 //
   6 // CenterIM is free software; you can redistribute it and/or modify
   7 // it under the terms of the GNU General Public License as published by
   8 // the Free Software Foundation; either version 2 of the License, or
   9 // (at your option) any later version.
  10 //
  11 // CenterIM is distributed in the hope that it will be useful,
  12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 // GNU General Public License for more details.
  15 //
  16 // You should have received a copy of the GNU General Public License
  17 // along with CenterIM.  If not, see <http://www.gnu.org/licenses/>.
  18
  19 /// @file
  20 /// Widget class implementation.
  21 ///
  22 /// @ingroup cppconsui
  23
  24 #include "Widget.h"
  25
  26 #include "ColorScheme.h"
  27 #include "CoreManager.h"
  28
  29 #include <cassert>
  30 #include <cstring>
  31
  32 namespace CppConsUI {
  33
  34 Widget::Widget(int w, int h)
  35   : xpos_(UNSETPOS), ypos_(UNSETPOS), width_(w), height_(h),
  36     wish_width_(AUTOSIZE), wish_height_(AUTOSIZE), real_xpos_(UNSETPOS),
  37     real_ypos_(UNSETPOS), real_width_(0), real_height_(0), can_focus_(false),
  38     has_focus_(false), visible_(true), parent_(nullptr), color_scheme_(0),
  39     absolute_position_listeners_(0)
  40 {
  41 }
  42
  43 Widget::~Widget()
  44 {
  45   setVisibility(false);
  46
  47   if (parent_ != nullptr && absolute_position_listeners_.size() > 0)
  48     parent_->unregisterAbsolutePositionListener(*this);
  49 }
  50
  51 void Widget::moveResize(int newx, int newy, int neww, int newh)
  52 {
  53   if (newx == xpos_ && newy == ypos_ && neww == width_ && newh == height_)
  54     return;
  55
  56   Rect oldsize(xpos_, ypos_, width_, height_);
  57   Rect newsize(newx, newy, neww, newh);
  58
  59   xpos_ = newx;
  60   ypos_ = newy;
  61   width_ = neww;
  62   height_ = newh;
  63
  64   signalMoveResize(oldsize, newsize);
  65 }
  66
  67 Widget *Widget::getFocusWidget()
  68 {
  69   if (can_focus_)
  70     return this;
  71   return nullptr;
  72 }
  73
  74 void Widget::cleanFocus()
  75 {
  76   if (!has_focus_)
  77     return;
  78
  79   has_focus_ = false;
  80   signal_focus(*this, false);
  81   redraw();
  82 }
  83
  84 bool Widget::restoreFocus()
  85 {
  86   return grabFocus();
  87 }
  88
  89 void Widget::ungrabFocus()
  90 {
  91   if (parent_ == nullptr || !has_focus_)
  92     return;
  93
  94   has_focus_ = false;
  95   signal_focus(*this, false);
  96   redraw();
  97 }
  98
  99 bool Widget::grabFocus()
 100 {
 101   if (parent_ == nullptr || has_focus_)
 102     return false;
 103
 104   if (can_focus_ && isVisibleRecursive()) {
 105     if (parent_->setFocusChild(*this)) {
 106       has_focus_ = true;
 107       signal_focus(*this, true);
 108       redraw();
 109     }
 110     return true;
 111   }
 112
 113   return false;
 114 }
 115
 116 void Widget::setVisibility(bool new_visible)
 117 {
 118   if (new_visible == visible_)
 119     return;
 120
 121   visible_ = new_visible;
 122
 123   if (parent_ != nullptr) {
 124     parent_->updateFocusChain();
 125
 126     Container *t = getTopContainer();
 127     if (visible_) {
 128       if (!t->getFocusWidget()) {
 129         // There is no focused widget, try if this or a widget that was revealed
 130         // can grab it.
 131         t->moveFocus(Container::FOCUS_DOWN);
 132       }
 133     }
 134     else {
 135       Widget *focus = t->getFocusWidget();
 136       if (focus && !focus->isVisibleRecursive()) {
 137         // Focused widget was hidden, move the focus.
 138         t->moveFocus(Container::FOCUS_DOWN);
 139       }
 140     }
 141
 142     signalVisible(visible_);
 143   }
 144
 145   signal_visible(*this, visible_);
 146   redraw();
 147 }
 148
 149 bool Widget::isVisibleRecursive() const
 150 {
 151   if (parent_ == nullptr || !visible_)
 152     return false;
 153
 154   return parent_->isWidgetVisible(*this);
 155 }
 156
 157 void Widget::setParent(Container &new_parent)
 158 {
 159   // Changing parent widget is not supported.
 160   assert(parent_ == nullptr);
 161
 162   parent_ = &new_parent;
 163
 164   // Register this widget as an absolute position listener to its parent in case
 165   // some other widget is interested in a position of this widget.
 166   if (absolute_position_listeners_.size() > 0)
 167     parent_->registerAbsolutePositionListener(*this);
 168
 169   parent_->updateFocusChain();
 170
 171   Container *t = getTopContainer();
 172   if (!t->getFocusWidget()) {
 173     // There is no focused widget, try if this or a child widget (in case of
 174     // Container) can grab it.
 175     Widget *w = getFocusWidget();
 176     if (w != nullptr)
 177       w->grabFocus();
 178   }
 179   else {
 180     // Clean focus if this widget/container was added to a container that
 181     // already has a focused widget.
 182     cleanFocus();
 183   }
 184 }
 185
 186 // All following moveResize() wrappers should always call member methods to get
 187 // xpos_, ypos_, width_, height_ and never use member variables directly. See
 188 // getLeft(), getTop(), getWidth(), getHeight() in the Window class.
 189 void Widget::move(int newx, int newy)
 190 {
 191   moveResize(newx, newy, getWidth(), getHeight());
 192 }
 193
 194 void Widget::resize(int neww, int newh)
 195 {
 196   moveResize(getLeft(), getTop(), neww, newh);
 197 }
 198
 199 void Widget::setLeft(int newx)
 200 {
 201   moveResize(newx, getTop(), getWidth(), getHeight());
 202 }
 203
 204 void Widget::setTop(int newy)
 205 {
 206   moveResize(getLeft(), newy, getWidth(), getHeight());
 207 }
 208
 209 void Widget::setWidth(int neww)
 210 {
 211   moveResize(getLeft(), getTop(), neww, getHeight());
 212 }
 213
 214 void Widget::setHeight(int newh)
 215 {
 216   moveResize(getLeft(), getTop(), getWidth(), newh);
 217 }
 218
 219 Point Widget::getAbsolutePosition() const
 220 {
 221   if (parent_ == nullptr)
 222     return Point(0, 0);
 223
 224   return parent_->getAbsolutePosition(*this);
 225 }
 226
 227 Point Widget::getRelativePosition(const Container &ref) const
 228 {
 229   if (parent_ == nullptr)
 230     return Point(0, 0);
 231
 232   return parent_->getRelativePosition(ref, *this);
 233 }
 234
 235 void Widget::setRealPosition(int newx, int newy)
 236 {
 237   if (newx == real_xpos_ && newy == real_ypos_)
 238     return;
 239
 240   real_xpos_ = newx;
 241   real_ypos_ = newy;
 242
 243   signalAbsolutePositionChange();
 244 }
 245
 246 void Widget::setRealSize(int neww, int newh)
 247 {
 248   if (neww == real_width_ && newh == real_height_)
 249     return;
 250
 251   Size oldsize(real_width_, real_height_);
 252   Size newsize(neww, newh);
 253
 254   real_width_ = neww;
 255   real_height_ = newh;
 256
 257   updateAreaPostRealSizeChange(oldsize, newsize);
 258 }
 259
 260 void Widget::setColorScheme(int new_color_scheme)
 261 {
 262   if (new_color_scheme == color_scheme_)
 263     return;
 264
 265   color_scheme_ = new_color_scheme;
 266   redraw();
 267 }
 268
 269 int Widget::getColorScheme() const
 270 {
 271   if (color_scheme_ != 0)
 272     return color_scheme_;
 273   else if (parent_ != nullptr)
 274     return parent_->getColorScheme();
 275
 276   return 0;
 277 }
 278
 279 void Widget::registerAbsolutePositionListener(Widget &widget)
 280 {
 281   absolute_position_listeners_.push_back(&widget);
 282   if (parent_ != nullptr && absolute_position_listeners_.size() == 1)
 283     parent_->registerAbsolutePositionListener(*this);
 284 }
 285
 286 void Widget::unregisterAbsolutePositionListener(Widget &widget)
 287 {
 288   Widgets::iterator i = std::find(absolute_position_listeners_.begin(),
 289     absolute_position_listeners_.end(), &widget);
 290   assert(i != absolute_position_listeners_.end());
 291
 292   absolute_position_listeners_.erase(i);
 293   if (parent_ != nullptr && absolute_position_listeners_.size() == 0)
 294     parent_->unregisterAbsolutePositionListener(*this);
 295 }
 296
 297 void Widget::onAbsolutePositionChange(Widget & /*widget*/)
 298 {
 299   // Propagate the event to the listeners.
 300   signalAbsolutePositionChange();
 301 }
 302
 303 void Widget::signalMoveResize(const Rect &oldsize, const Rect &newsize)
 304 {
 305   if (parent_ == nullptr)
 306     return;
 307
 308   // Tell the parent about the new size so it can position the widget correctly.
 309   parent_->onChildMoveResize(*this, oldsize, newsize);
 310 }
 311
 312 void Widget::signalWishSizeChange(const Size &oldsize, const Size &newsize)
 313 {
 314   if (parent_ == nullptr)
 315     return;
 316
 317   // Tell the parent about the new wish size so it can position the widget
 318   // correctly.
 319   parent_->onChildWishSizeChange(*this, oldsize, newsize);
 320 }
 321
 322 void Widget::signalVisible(bool visible)
 323 {
 324   if (parent_ == nullptr)
 325     return;
 326
 327   // Tell the parent about the new visibility status so it can reposition its
 328   // child widgets as appropriate.
 329   parent_->onChildVisible(*this, visible);
 330 }
 331
 332 void Widget::signalAbsolutePositionChange()
 333 {
 334   for (Widget *widget : absolute_position_listeners_)
 335     widget->onAbsolutePositionChange(*this);
 336 }
 337
 338 void Widget::updateArea()
 339 {
 340   // Empty for Widget.
 341 }
 342
 343 void Widget::updateAreaPostRealSizeChange(
 344   const Size & /*oldsize*/, const Size & /*newsize*/)
 345 {
 346   // Normal widgets only need to call updateArea().
 347   updateArea();
 348 }
 349
 350 void Widget::redraw()
 351 {
 352   if (parent_ == nullptr)
 353     return;
 354
 355   parent_->redraw();
 356 }
 357
 358 void Widget::setWishSize(int neww, int newh)
 359 {
 360   if (neww == wish_width_ && newh == wish_height_)
 361     return;
 362
 363   Size oldsize(wish_width_, wish_height_);
 364   Size newsize(neww, newh);
 365
 366   wish_width_ = neww;
 367   wish_height_ = newh;
 368
 369   signalWishSizeChange(oldsize, newsize);
 370 }
 371
 372 int Widget::getAttributes(int property, int *attrs, Error &error) const
 373 {
 374   return getAttributes(property, 0, attrs, error);
 375 }
 376
 377 int Widget::getAttributes(
 378   int property, int subproperty, int *attrs, Error &error) const
 379 {
 380   return COLORSCHEME->getAttributes(
 381     getColorScheme(), property, subproperty, attrs, error);
 382 }
 383
 384 Container *Widget::getTopContainer()
 385 {
 386   if (parent_ != nullptr)
 387     return parent_->getTopContainer();
 388   return dynamic_cast<Container *>(this);
 389 }
 390
 391 } // namespace CppConsUI
 392
 393 // vim: set tabstop=2 shiftwidth=2 textwidth=80 expandtab: