~canonical-dx-team/unity/unity.fix-ql-losing-focus

// -*- Mode: C++; indent-tabs-mode: nil; tab-width: 2 -*-

/*

* Copyright (C) 2010 Canonical Ltd

*

* This program is free software: you can redistribute it and/or modify

* it under the terms of the GNU General Public License version 3 as

* published by the Free Software Foundation.

*

* 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, see <http://www.gnu.org/licenses/>.

*

* Authored by: Jay Taoko <jay.taoko@canonical.com>

* Authored by: Mirco Müller <mirco.mueller@canonical.com

*/

#include "Nux/Nux.h"

#include "Nux/VLayout.h"

#include "Nux/HLayout.h"

#include "Nux/WindowThread.h"

#include "Nux/WindowCompositor.h"

#include "Nux/BaseWindow.h"

#include "Nux/Button.h"

#include "NuxGraphics/GraphicsEngine.h"

#include "Nux/TextureArea.h"

#include "NuxImage/CairoGraphics.h"

#include "QuicklistView.h"

#include "QuicklistMenuItem.h"

#include "QuicklistMenuItemLabel.h"

#include "QuicklistMenuItemSeparator.h"

#include "QuicklistMenuItemCheckmark.h"

#include "QuicklistMenuItemRadio.h"

#include "Introspectable.h"

#include "ubus-server.h"

#include "UBusMessages.h"

NUX_IMPLEMENT_OBJECT_TYPE (QuicklistView);

QuicklistView::QuicklistView ()

{

  _name = g_strdup ("Quicklist");

  _texture_bg = 0;

  _texture_mask = 0;

  _texture_outline = 0;

  _cairo_text_has_changed = true;

  _anchorX   = 0;

  _anchorY   = 0;

  _labelText = TEXT ("QuicklistView 1234567890");

  _anchor_width   = 10;

  _anchor_height  = 18;

  _corner_radius  = 4;

  _padding        = 13;

  _top_size       = 4;

  SetGeometry (nux::Geometry (0, 0, 1, 1));

  _hlayout         = new nux::HLayout (TEXT(""), NUX_TRACKER_LOCATION);

  _vlayout         = new nux::VLayout (TEXT(""), NUX_TRACKER_LOCATION);

  _item_layout     = new nux::VLayout (TEXT(""), NUX_TRACKER_LOCATION);

  _default_item_layout = new nux::VLayout (TEXT(""), NUX_TRACKER_LOCATION);

  _left_space = new nux::SpaceLayout (_padding + _anchor_width + _corner_radius, _padding + _anchor_width + _corner_radius, 1, 1000);

  _right_space = new nux::SpaceLayout (_padding + _corner_radius, _padding + _corner_radius, 1, 1000);

  _top_space = new nux::SpaceLayout (1, 1000, _padding + _corner_radius, _padding + _corner_radius);

  _bottom_space = new nux::SpaceLayout (1, 1000, _padding + _corner_radius, _padding + _corner_radius);

  _vlayout->AddLayout (_top_space, 0);

  _vlayout->AddLayout (_item_layout, 0);

  _vlayout->AddLayout (_default_item_layout, 0);

  _vlayout->AddLayout (_bottom_space, 0);

  _hlayout->AddLayout (_left_space, 0);

  _hlayout->AddLayout (_vlayout, 0, nux::eCenter, nux::eFull);

  _hlayout->AddLayout (_right_space, 0);

  SetWindowSizeMatchLayout (true);

  SetLayout (_hlayout);

  OnMouseDownOutsideArea.connect (sigc::mem_fun (this, &QuicklistView::RecvMouseDownOutsideOfQuicklist));

  OnMouseDown.connect (sigc::mem_fun (this, &QuicklistView::RecvMouseDown));

  OnMouseUp.connect (sigc::mem_fun (this, &QuicklistView::RecvMouseUp));

  OnMouseClick.connect (sigc::mem_fun (this, &QuicklistView::RecvMouseClick));

  OnMouseMove.connect (sigc::mem_fun (this, &QuicklistView::RecvMouseMove));

  OnMouseDrag.connect (sigc::mem_fun (this, &QuicklistView::RecvMouseDrag));

  OnKeyPressed.connect (sigc::mem_fun (this, &QuicklistView::RecvKeyPressed));

  OnStartFocus.connect (sigc::mem_fun (this, &QuicklistView::RecvStartFocus));

  OnEndFocus.connect   (sigc::mem_fun (this, &QuicklistView::RecvEndFocus));

  _mouse_down = false;

  _enable_quicklist_for_testing = false;

  _compute_blur_bkg = true;

  _current_item_index = 0;

}

void

QuicklistView::RecvStartFocus ()

{

  PushToFront ();

}

void

QuicklistView::RecvEndFocus ()

{

}

void

QuicklistView::RecvKeyPressed (unsigned int  key_sym,

                               unsigned long key_code,

                               unsigned long key_state)

{

  switch (key_sym)

  {

    // up (highlight previous menu-item)

    case NUX_VK_UP:

      if (_current_item_index > 0)

      {

        GetNthItems (_current_item_index)->_prelight = false;

        _current_item_index--;

        GetNthItems (_current_item_index)->_prelight = true;

        QueueDraw ();

      }

    break;

    // down (highlight next menu-item)

    case NUX_VK_DOWN:

      if (_current_item_index < GetNumItems () - 1)

      {

        GetNthItems (_current_item_index)->_prelight = false;

        _current_item_index++;

        GetNthItems (_current_item_index)->_prelight = true;

        QueueDraw ();

      }

    break;

    // left (close quicklist, go back to laucher key-nav)

    case NUX_VK_LEFT:

      _current_item_index = 0;

      GetNthItems (_current_item_index)->_prelight = true;

      Hide ();

      // inform Launcher we switch back to Launcher key-nav

      ubus_server_send_message (ubus_server_get_default (),

                                UBUS_QUICKLIST_END_KEY_NAV,

                                NULL);

    break;

    // esc (close quicklist, exit key-nav)

    case NUX_VK_ESCAPE:

      _current_item_index = 0;

      GetNthItems (_current_item_index)->_prelight = true;

      Hide ();

      // inform UnityScreen we leave key-nav completely

      ubus_server_send_message (ubus_server_get_default (),

                                UBUS_LAUNCHER_END_KEY_NAV,

                                NULL);

    break;

    // <SPACE>, <RETURN> (activate selected menu-item)          

    case NUX_VK_SPACE:

    case NUX_VK_ENTER:

      if (_current_item_index >= 0 && _current_item_index < GetNumItems ())

      {

        dbusmenu_menuitem_handle_event (GetNthItems (_current_item_index)->_menuItem,

                                        "clicked",

                                        NULL,

                                        0);

        _current_item_index = 0;

        GetNthItems (_current_item_index)->_prelight = true;

        Hide ();

      }

    break;

    default:

    break;

  }

}

QuicklistView::~QuicklistView ()

{

  if (_name)

    g_free (_name);

  if (_texture_bg)

    _texture_bg->UnReference ();

  if (_texture_outline)

    _texture_outline->UnReference ();

    if (_texture_mask)

    _texture_mask->UnReference ();

  std::list<QuicklistMenuItem*>::iterator it;

  for (it = _item_list.begin(); it != _item_list.end(); it++)

  {

    // Remove from introspection

    RemoveChild (*it);

    (*it)->UnReference();

  }

  for (it = _default_item_list.begin(); it != _default_item_list.end(); it++)

  {

    // Remove from introspection

    RemoveChild (*it);

    (*it)->UnReference();

  }

  _default_item_list.clear ();

  _item_list.clear ();

}

void

QuicklistView::EnableQuicklistForTesting (bool enable_testing)

{

  _enable_quicklist_for_testing = enable_testing;

}

void QuicklistView::ShowQuicklistWithTipAt (int anchor_tip_x, int anchor_tip_y)

{

  _anchorX = anchor_tip_x;

  _anchorY = anchor_tip_y;

  if (!_enable_quicklist_for_testing)

  {

    if ((_item_list.size () != 0) || (_default_item_list.size () != 0))

    {

      int offscreen_size = GetBaseY () +

                           GetBaseHeight () -

                           nux::GetWindow().GetWindowHeight ();

      if (offscreen_size > 0)

        _top_size = offscreen_size;

      else

        _top_size = 4;

      int x = _anchorX - _padding;

      int y = _anchorY - _anchor_height/2 - _top_size - _corner_radius - _padding;

      SetBaseX (x);

      SetBaseY (y);

    }

    else

    {

      _top_size = 0;

      int x = _anchorX - _padding;

      int y = _anchorY - _anchor_height/2 - _top_size - _corner_radius - _padding;

      SetBaseX (x);

      SetBaseY (y);    

    }

  }

  Show ();

}

void QuicklistView::ShowWindow (bool b, bool start_modal)

{

  BaseWindow::ShowWindow (b, start_modal);

}

void QuicklistView::Show ()

{

  if (!IsVisible())

  {

    // FIXME: ShowWindow shouldn't need to be called first

    ShowWindow (true);

    PushToFront ();

    EnableInputWindow (true, "quicklist", false, true);

    //SetInputFocus ();

    GrabPointer ();

    GrabKeyboard ();

    QueueDraw ();

    _compute_blur_bkg = true;

  }

}

void QuicklistView::Hide ()

{

  if (IsVisible() && !_enable_quicklist_for_testing)

  {

    CancelItemsPrelightStatus ();

    CaptureMouseDownAnyWhereElse (false);

    ForceStopFocus (1, 1);

    UnGrabPointer ();

    EnableInputWindow (false);

    ShowWindow (false);

  }

}

long QuicklistView::ProcessEvent (nux::IEvent& ievent, long TraverseInfo, long ProcessEventInfo)

{

  long ret = TraverseInfo;

  long ProcEvInfo = 0;

  nux::IEvent window_event = ievent;

  nux::Geometry base = GetGeometry();

  window_event.e_x_root = base.x;

  window_event.e_y_root = base.y;

  // The child layout get the Mouse down button only if the MouseDown happened inside the client view Area

  nux::Geometry viewGeometry = GetGeometry();

  if (ievent.e_event == nux::NUX_MOUSE_PRESSED)

  {

    if (!viewGeometry.IsPointInside (ievent.e_x - ievent.e_x_root, ievent.e_y - ievent.e_y_root) )

    {

      ProcEvInfo = nux::eDoNotProcess;

    }

  }

  // We choose to test the quicklist items ourselves instead of processing them as it is usual in nux.

  // This is meant to be easier since the quicklist has a atypical way of working.

  if (m_layout)

  {

    ret = m_layout->ProcessEvent (window_event, ret, ProcEvInfo);

  }

  // The quicklist itself does not process the evvent. Instead we do some analysis of the event 

  // to detect the user action and perform the correct operation.

  if (ievent.e_event == nux::NUX_MOUSE_PRESSED)

  {

    if (GetGeometry ().IsPointInside (ievent.e_x, ievent.e_y))

    {

      _mouse_down = true;

    }

    else

    {

      _mouse_down = false;

      Hide ();

      return nux::eMouseEventSolved;

    }

  }

  else if ((ievent.e_event == nux::NUX_MOUSE_RELEASED) && _mouse_down)

  {

    _mouse_down = false;

    Hide ();

    return nux::eMouseEventSolved;

  }

  ret = OnEvent (ievent, ret, ProcessEventInfo);

  return ret;    

}

void QuicklistView::Draw (nux::GraphicsEngine& gfxContext, bool forceDraw)

{

  // Get the geometry of the QuicklistView on the display

  nux::Geometry base = GetGeometry();

  // Get the background of the QuicklistView and apply some 

  if (_compute_blur_bkg /* Refresh the blurred background*/)

  {

    nux::ObjectPtr<nux::IOpenGLFrameBufferObject> current_fbo = nux::GetGpuDevice ()->GetCurrentFrameBufferObject ();

    nux::GetGpuDevice ()->DeactivateFrameBuffer ();

    gfxContext.SetViewport (0, 0, gfxContext.GetWindowWidth (), gfxContext.GetWindowHeight ());

    gfxContext.SetScissor (0, 0, gfxContext.GetWindowWidth (), gfxContext.GetWindowHeight ());

    gfxContext.GetRenderStates ().EnableScissor (false);

    nux::ObjectPtr <nux::IOpenGLBaseTexture> bkg_texture = gfxContext.CreateTextureFromBackBuffer (base.x, base.y, base.width, base.height);

    nux::TexCoordXForm texxform_bkg;

    bkg_blur_texture = gfxContext.QRP_GetBlurTexture (0, 0, base.width, base.height, bkg_texture, texxform_bkg, nux::Color::White, 1.0f, 3);

    if (current_fbo.IsValid ())

    { 

      current_fbo->Activate (true);

      gfxContext.Push2DWindow (current_fbo->GetWidth (), current_fbo->GetHeight ());

    }

    else

    {

      gfxContext.SetViewport (0, 0, gfxContext.GetWindowWidth (), gfxContext.GetWindowHeight ());

      gfxContext.Push2DWindow (gfxContext.GetWindowWidth (), gfxContext.GetWindowHeight ());

      gfxContext.ApplyClippingRectangle ();

    }

    _compute_blur_bkg = false;

  }

  // the elements position inside the window are referenced to top-left window

  // corner. So bring base to (0, 0).

  base.SetX (0);

  base.SetY (0);

  gfxContext.PushClippingRectangle (base);

  nux::TexCoordXForm texxform_blur_bkg;

  //texxform_blur_bkg.SetWrap(nux::TEXWRAP_CLAMP, nux::TEXWRAP_CLAMP);

  //texxform_blur_bkg.SetTexCoordType (nux::TexCoordXForm::OFFSET_COORD);

  nux::TexCoordXForm texxform_bg;

  texxform_bg.SetWrap(nux::TEXWRAP_CLAMP, nux::TEXWRAP_CLAMP);

  texxform_bg.SetTexCoordType (nux::TexCoordXForm::OFFSET_COORD);

  nux::TexCoordXForm texxform_mask;

  texxform_mask.SetWrap(nux::TEXWRAP_CLAMP, nux::TEXWRAP_CLAMP);

  texxform_mask.SetTexCoordType (nux::TexCoordXForm::OFFSET_COORD);

  if (bkg_blur_texture.IsValid ())

  {

    gfxContext.QRP_2TexMod (

      base.x,

      base.y,

      base.width,

      base.height,

      bkg_blur_texture,

      texxform_blur_bkg,

      nux::Color::White,

      _texture_mask->GetDeviceTexture(),

      texxform_mask,

      nux::Color::White);

  }

  nux::GetGraphicsEngine ().GetRenderStates ().SetBlend (true);

  nux::GetGraphicsEngine ().GetRenderStates ().SetPremultipliedBlend (nux::SRC_OVER);

  gfxContext.QRP_2TexMod (base.x,

    base.y,

    base.width,

    base.height,

    _texture_bg->GetDeviceTexture(),

    texxform_bg,

    nux::Color(1.0f, 1.0f, 1.0f, 1.0f),

    _texture_mask->GetDeviceTexture(),

    texxform_mask,

    nux::Color(1.0f, 1.0f, 1.0f, 1.0f));

  nux::TexCoordXForm texxform;

  texxform.SetWrap(nux::TEXWRAP_CLAMP, nux::TEXWRAP_CLAMP);

  texxform.SetTexCoordType (nux::TexCoordXForm::OFFSET_COORD);

  nux::GetGraphicsEngine ().GetRenderStates ().SetBlend (true);

  nux::GetGraphicsEngine ().GetRenderStates ().SetPremultipliedBlend (nux::SRC_OVER);

  gfxContext.QRP_1Tex (base.x,

    base.y,

    base.width,

    base.height,

    _texture_outline->GetDeviceTexture(),

    texxform,

    nux::Color(1.0f, 1.0f, 1.0f, 1.0f));

  nux::GetGraphicsEngine().GetRenderStates().SetBlend (false);

  std::list<QuicklistMenuItem*>::iterator it;

  for (it = _item_list.begin(); it != _item_list.end(); it++)

  {

    if ((*it)->GetVisible())

      (*it)->ProcessDraw(gfxContext, forceDraw);

  }

  for (it = _default_item_list.begin(); it != _default_item_list.end(); it++)

  {

    if ((*it)->GetVisible())

      (*it)->ProcessDraw(gfxContext, forceDraw);

  }

  gfxContext.PopClippingRectangle ();

}

void QuicklistView::DrawContent (nux::GraphicsEngine& GfxContext, bool force_draw)

{

}

void QuicklistView::PreLayoutManagement ()

{

  int MaxItemWidth = 0;

  int TotalItemHeight = 0;

  std::list<QuicklistMenuItem*>::iterator it;

  for (it = _item_list.begin(); it != _item_list.end(); it++)

  {

    // Make sure item is in layout if it should be

    if (!(*it)->GetVisible()) {

      _item_layout->RemoveChildObject(*it);

      continue;

    }

    else if (!(*it)->GetParentObject())

      _item_layout->AddView(*it, 1, nux::eCenter, nux::eFull);

    int  textWidth  = 0;

    int  textHeight = 0;

    (*it)->GetTextExtents(textWidth, textHeight);

    if (textWidth > MaxItemWidth)

      MaxItemWidth = textWidth;

    TotalItemHeight += textHeight;

  }

  for (it = _default_item_list.begin(); it != _default_item_list.end(); it++)

  {

    // Make sure item is in layout if it should be

    if (!(*it)->GetVisible()) {

      _default_item_layout->RemoveChildObject(*it);

      continue;

    }

    else if (!(*it)->GetParentObject())

      _default_item_layout->AddView(*it, 1, nux::eCenter, nux::eFull);

    int  textWidth  = 0;

    int  textHeight = 0;

    (*it)->GetTextExtents(textWidth, textHeight);

    if (textWidth > MaxItemWidth)

      MaxItemWidth = textWidth;

    TotalItemHeight += textHeight;

  }

  if(TotalItemHeight < _anchor_height)

  {

    _top_space->SetMinMaxSize(1, (_anchor_height - TotalItemHeight)/2 +1 + _padding + _corner_radius);

    _bottom_space->SetMinMaxSize(1, (_anchor_height - TotalItemHeight)/2 +1 + _padding + _corner_radius);

  }

  else

  {

    _top_space->SetMinMaxSize(_padding + _corner_radius, _padding + _corner_radius);

    _bottom_space->SetMinMaxSize(_padding + _corner_radius, _padding + _corner_radius);

   }

  _item_layout->SetMinimumWidth(MaxItemWidth);

  _default_item_layout->SetMinimumWidth(MaxItemWidth);

  BaseWindow::PreLayoutManagement ();

}

long QuicklistView::PostLayoutManagement (long LayoutResult)

{

  long result = BaseWindow::PostLayoutManagement (LayoutResult);

  UpdateTexture ();

  int x = _padding + _anchor_width + _corner_radius;

  int y = _padding + _corner_radius;

  std::list<QuicklistMenuItem*>::iterator it;

  for (it = _item_list.begin(); it != _item_list.end(); it++)

  {

    if (!(*it)->GetVisible())

      continue;

    (*it)->SetBaseX (x);

    (*it)->SetBaseY (y);

    y += (*it)->GetBaseHeight ();

  }

  for (it = _default_item_list.begin(); it != _default_item_list.end(); it++)

  {

    if (!(*it)->GetVisible())

      continue;

    (*it)->SetBaseX (x);

    (*it)->SetBaseY (y);

    y += (*it)->GetBaseHeight ();

  }

  // We must correct the width of line separators. The rendering of the separator can be smaller than the width of the

  // quicklist. The reason for that is, the quicklist width is determined by the largest entry it contains. That size is 

  // only after MaxItemWidth is computed in QuicklistView::PreLayoutManagement.

  // The setting of the separator width is done here after the Layout cycle for this widget is over. The width of the separator 

  // has bee set correctly during the layout cycle, but the cairo rendering still need to be adjusted.

  int separator_width = nux::Max<int>(_default_item_layout->GetBaseWidth (), _item_layout->GetBaseWidth ());

  for (it = _item_list.begin(); it != _item_list.end(); it++)

  {

    QuicklistMenuItem* item = (QuicklistMenuItem*) (*it);

    if (item->GetVisible() && item->CairoSurfaceWidth () != separator_width)

    {

      // Compute textures of the item.

      item->UpdateTexture ();

    }

  }

  for (it = _default_item_list.begin(); it != _default_item_list.end(); it++)

  {

    QuicklistMenuItem* item = (QuicklistMenuItem*) (*it);

    if (item->GetVisible() && item->CairoSurfaceWidth () != separator_width)

    {

      // Compute textures of the item.

      item->UpdateTexture ();

    }

  }

  return result;

}

void QuicklistView::RecvCairoTextChanged (QuicklistMenuItem* cairo_text)

{

  _cairo_text_has_changed = true;

}

void QuicklistView::RecvCairoTextColorChanged (QuicklistMenuItem* cairo_text)

{

  NeedRedraw ();

}

void QuicklistView::RecvItemMouseClick (QuicklistMenuItem* item, int x, int y)

{

  _mouse_down = false;

  if (IsVisible ())

  {

    // Check if the mouse was released over an item and emit the signal

    CheckAndEmitItemSignal (x + item->GetBaseX (), y + item->GetBaseY ());

    Hide ();

  }

}

void QuicklistView::CheckAndEmitItemSignal (int x, int y)

{ 

  nux::Geometry geo;

  std::list<QuicklistMenuItem*>::iterator it;

  for (it = _item_list.begin(); it != _item_list.end(); it++)

  {

    if (!(*it)->GetVisible())

      continue;

    geo = (*it)->GetGeometry ();

    geo.width = _item_layout->GetBaseWidth ();

    if (geo.IsPointInside (x, y))

    {

      // An action is performed: send the signal back to the application

      if ((*it)->_menuItem)

      {

        dbusmenu_menuitem_handle_event ((*it)->_menuItem, "clicked", NULL, 0);

      }

    }

  }

  for (it = _default_item_list.begin(); it != _default_item_list.end(); it++)

  {

    if (!(*it)->GetVisible())

      continue;

    geo = (*it)->GetGeometry ();

    geo.width = _default_item_layout->GetBaseWidth ();

    if (geo.IsPointInside (x, y))

    {

      // An action is performed: send the signal back to the application

      if ((*it)->_menuItem)

      {

        dbusmenu_menuitem_handle_event ((*it)->_menuItem, "clicked", NULL, 0);

      }

    }

  } 

}

void QuicklistView::RecvItemMouseRelease (QuicklistMenuItem* item, int x, int y)

{

  _mouse_down = false;

  if (IsVisible ())

  {

    // Check if the mouse was released over an item and emit the signal

    CheckAndEmitItemSignal (x + item->GetBaseX (), y + item->GetBaseY ());

    Hide ();

  }  

}

void QuicklistView::CancelItemsPrelightStatus ()

{

  std::list<QuicklistMenuItem*>::iterator it;

  for (it = _item_list.begin(); it != _item_list.end(); it++)

  {

    (*it)->_prelight = false;

  }

  for (it = _default_item_list.begin(); it != _default_item_list.end(); it++)