]> git.saurik.com Git - wxWidgets.git/blobdiff - samples/richedit/wxlwindow.cpp
Couple more Unicode fixes.
[wxWidgets.git] / samples / richedit / wxlwindow.cpp
index 98239d518464e10a6ba38d567b3a8857e7c86527..7a00a5b0ad64366e29ac9cc16c0ade9fd6c368cf 100644 (file)
@@ -6,9 +6,9 @@
  * $Id$
  *******************************************************************/
 
-// ===========================================================================
+// ============================================================================
 // declarations
-// ===========================================================================
+// ============================================================================
 
 // ----------------------------------------------------------------------------
 // headers
@@ -84,14 +84,18 @@ static const int Y_SCROLL_PAGE = 20;
 // ----------------------------------------------------------------------------
 
 BEGIN_EVENT_TABLE(wxLayoutWindow,wxScrolledWindow)
+   EVT_SIZE    (wxLayoutWindow::OnSize)
+
    EVT_PAINT    (wxLayoutWindow::OnPaint)
 
    EVT_CHAR     (wxLayoutWindow::OnChar)
    EVT_KEY_UP   (wxLayoutWindow::OnKeyUp)
 
-   EVT_LEFT_DOWN(wxLayoutWindow::OnLeftMouseClick)
+   EVT_LEFT_DOWN(wxLayoutWindow::OnLeftMouseDown)
+   EVT_LEFT_UP(wxLayoutWindow::OnLeftMouseUp)
    EVT_RIGHT_DOWN(wxLayoutWindow::OnRightMouseClick)
    EVT_LEFT_DCLICK(wxLayoutWindow::OnMouseDblClick)
+   EVT_MIDDLE_DOWN(wxLayoutWindow::OnMiddleMouseDown)
    EVT_MOTION    (wxLayoutWindow::OnMouseMove)
 
    EVT_UPDATE_UI(WXLOWIN_MENU_UNDERLINE, wxLayoutWindow::OnUpdateMenuUnderline)
@@ -103,9 +107,16 @@ BEGIN_EVENT_TABLE(wxLayoutWindow,wxScrolledWindow)
    EVT_KILL_FOCUS(wxLayoutWindow::OnKillFocus)
 END_EVENT_TABLE()
 
-// ===========================================================================
+// ----------------------------------------------------------------------------
+// function prototypes
+// ----------------------------------------------------------------------------
+
+/// returns TRUE if keyCode is one of arrows/home/end/page{up|down} keys
+static bool IsDirectionKey(long keyCode);
+
+// ============================================================================
 // implementation
-// ===========================================================================
+// ============================================================================
 
 /* LEAVE IT HERE UNTIL WXGTK WORKS AGAIN!!! */
 #ifdef __WXGTK__
@@ -129,7 +140,8 @@ wxLayoutWindow::wxLayoutWindow(wxWindow *parent)
                                  wxDefaultPosition, wxDefaultSize,
                                  wxHSCROLL | wxVSCROLL |
                                  wxBORDER |
-                                 wxWANTS_CHARS)
+                                 wxWANTS_CHARS),
+                m_llist(NULL)
 {
    SetStatusBar(NULL); // don't use statusbar
    m_Editable = false;
@@ -141,16 +153,25 @@ wxLayoutWindow::wxLayoutWindow(wxWindow *parent)
    m_bitmap = new wxBitmap(4,4);
    m_bitmapSize = wxPoint(4,4);
    m_llist = new wxLayoutList();
-
+   SetAutoDeleteSelection(false);
    m_BGbitmap = NULL;
    m_ScrollToCursor = false;
    SetWrapMargin(0);
+
+   // initially the list is empty, so why would we need the scrollbars?
+#if 0
    wxPoint max = m_llist->GetSize();
    SetScrollbars(X_SCROLL_PAGE, Y_SCROLL_PAGE,
                  max.x / X_SCROLL_PAGE + 1, max.y / Y_SCROLL_PAGE + 1);
    EnableScrolling(true, true);
    m_maxx = max.x + X_SCROLL_PAGE;
    m_maxy = max.y + Y_SCROLL_PAGE;
+#endif // 0
+
+   // no scrollbars initially
+   m_hasHScrollbar =
+   m_hasVScrollbar = false;
+
    m_Selecting = false;
 
 #ifdef WXLAYOUT_USE_CARET
@@ -187,6 +208,7 @@ wxLayoutWindow::Clear(int family,
 {
    GetLayoutList()->Clear(family,size,style,weight,underline,fg,bg);
    SetBackgroundColour(GetLayoutList()->GetDefaultStyleInfo().GetBGColour());
+   wxScrolledWindow::Clear();
    ResizeScrollbars(true);
    SetDirty();
    SetModified(false);
@@ -194,6 +216,14 @@ wxLayoutWindow::Clear(int family,
    DoPaint((wxRect *)NULL);
 }
 
+void wxLayoutWindow::Refresh(bool eraseBackground, const wxRect *rect)
+{
+   wxScrolledWindow::Refresh(eraseBackground, rect);
+
+   ResizeScrollbars();
+   ScrollToCursor();
+}
+
 void
 wxLayoutWindow::OnMouse(int eventId, wxMouseEvent& event)
 {
@@ -212,8 +242,10 @@ wxLayoutWindow::OnMouse(int eventId, wxMouseEvent& event)
    findPos.x -= WXLO_XOFFSET;
    findPos.y -= WXLO_YOFFSET;
 
-   if(findPos.x < 0) findPos.x = 0;
-   if(findPos.y < 0) findPos.y = 0;
+   if(findPos.x < 0)
+       findPos.x = 0;
+   if(findPos.y < 0)
+       findPos.y = 0;
 
    m_ClickPosition = wxPoint(event.GetX(), event.GetY());
 
@@ -223,98 +255,129 @@ wxLayoutWindow::OnMouse(int eventId, wxMouseEvent& event)
                                                    &cursorPos, &found);
    wxLayoutObject::UserData *u = obj ? obj->GetUserData() : NULL;
 
-   //has the mouse only been moved?
-   if(eventId == WXLOWIN_MENU_MOUSEMOVE)
+   // has the mouse only been moved?
+   switch ( eventId )
    {
-      // found is only true if we are really over an object, not just
-      // behind it
-      if(found && u && ! m_Selecting)
-      {
-         if(!m_HandCursor)
-            SetCursor(wxCURSOR_HAND);
-         m_HandCursor = TRUE;
-         if(m_StatusBar && m_StatusFieldLabel != -1)
+      case WXLOWIN_MENU_MOUSEMOVE:
+         // found is only true if we are really over an object, not just
+         // behind it
+         if(found && u && ! m_Selecting)
          {
-            const wxString &label = u->GetLabel();
-            if(label.Length())
-               m_StatusBar->SetStatusText(label,
-                                          m_StatusFieldLabel);
+            if(!m_HandCursor)
+               SetCursor(wxCURSOR_HAND);
+            m_HandCursor = TRUE;
+            if(m_StatusBar && m_StatusFieldLabel != -1)
+            {
+               const wxString &label = u->GetLabel();
+               if(label.Length())
+                  m_StatusBar->SetStatusText(label,
+                                             m_StatusFieldLabel);
+            }
          }
-      }
-      else
-      {
-         if(m_HandCursor)
-            SetCursor(wxCURSOR_IBEAM);
-         m_HandCursor = FALSE;
-         if(m_StatusBar && m_StatusFieldLabel != -1)
-            m_StatusBar->SetStatusText("", m_StatusFieldLabel);
-      }
-      if(event.LeftIsDown())
-      {
-         if(! m_Selecting)
+         else
          {
-            m_llist->StartSelection(wxPoint(-1, -1), m_ClickPosition);
-            m_Selecting = true;
-            DoPaint();  // TODO: we don't have to redraw everything!
+            if(m_HandCursor)
+               SetCursor(wxCURSOR_IBEAM);
+            m_HandCursor = FALSE;
+            if(m_StatusBar && m_StatusFieldLabel != -1)
+               m_StatusBar->SetStatusText("", m_StatusFieldLabel);
          }
-         else
+
+         // selecting?
+         if ( event.LeftIsDown() )
          {
+            wxASSERT_MSG( m_Selecting, "should be set in OnMouseLeftDown" );
+
             m_llist->ContinueSelection(cursorPos, m_ClickPosition);
             DoPaint();  // TODO: we don't have to redraw everything!
          }
-      }
-      if(m_Selecting && ! event.LeftIsDown())
-      {
-         m_llist->EndSelection(cursorPos, m_ClickPosition);
-         m_Selecting = false;
-         DoPaint();     // TODO: we don't have to redraw everything!
-      }
 
-      if ( u )
-      {
-         u->DecRef();
-         u = NULL;
-      }
-   }
-   else if(eventId == WXLOWIN_MENU_LCLICK)
-   {
-      // always move cursor to mouse click:
-      m_llist->MoveCursorTo(cursorPos);
+         if ( u )
+         {
+            u->DecRef();
+            u = NULL;
+         }
+         break;
 
-      // clicking a mouse removes the selection
-      if ( m_llist->HasSelection() )
-      {
-         m_llist->DiscardSelection();
-         DoPaint();     // TODO: we don't have to redraw everything!
-      }
+      case WXLOWIN_MENU_LDOWN:
+         {
+             // always move cursor to mouse click:
+             if ( obj )
+             {
+                // we have found the real position
+                m_llist->MoveCursorTo(cursorPos);
+             }
+             else
+             {
+                // click beyond the end of the text
+                m_llist->MoveCursorToEnd();
+             }
+
+             // clicking a mouse removes the selection
+             if ( m_llist->HasSelection() )
+             {
+                m_llist->DiscardSelection();
+                DoPaint();     // TODO: we don't have to redraw everything!
+             }
+
+             // Calculate where the top of the visible area is:
+             int x0, y0;
+             ViewStart(&x0,&y0);
+             int dx, dy;
+             GetScrollPixelsPerUnit(&dx, &dy);
+             x0 *= dx; y0 *= dy;
+
+             wxPoint offset(-x0+WXLO_XOFFSET, -y0+WXLO_YOFFSET);
+
+             if(m_CursorVisibility == -1)
+                m_CursorVisibility = 1;
+
+             if(m_CursorVisibility != 0)
+             {
+                // draw a thick cursor for    editable windows with focus
+                m_llist->DrawCursor(dc, m_HaveFocus && IsEditable(), offset);
+             }
+
+             // VZ: this should be unnecessary because mouse can only click on a
+             //     visible part of the canvas
+#if 0
+             ScrollToCursor();
+#endif // 0
 
-      // Calculate where the top of the visible area is:
-      int x0, y0;
-      ViewStart(&x0,&y0);
-      int dx, dy;
-      GetScrollPixelsPerUnit(&dx, &dy);
-      x0 *= dx; y0 *= dy;
+#ifdef __WXGTK__
+             DoPaint(); // DoPaint suppresses flicker under GTK
+#endif // wxGTK
 
-      wxPoint offset(-x0+WXLO_XOFFSET, -y0+WXLO_YOFFSET);
+             // start selection
+             m_llist->StartSelection(wxPoint(-1, -1), m_ClickPosition);
+             m_Selecting = true;
+         }
+         break;
 
-      if(m_CursorVisibility == -1)
-         m_CursorVisibility = 1;
+      case WXLOWIN_MENU_LUP:
+         if ( m_Selecting )
+         {
+            m_llist->EndSelection();
+            m_Selecting = false;
 
-      if(m_CursorVisibility != 0)
-      {
-         // draw a thick cursor for    editable windows with focus
-         m_llist->DrawCursor(dc, m_HaveFocus && IsEditable(), offset);
-      }
+            DoPaint();     // TODO: we don't have to redraw everything!
+         }
+         break;
 
-      // VZ: this should be unnecessary because mouse can only click on a
-      //     visible part of the canvas
-#if 0
-      ScrollToCursor();
-#endif // 0
+      case WXLOWIN_MENU_MDOWN:
+         Paste(TRUE);
+         break;
 
-#ifdef __WXGTK__
-      DoPaint(); // DoPaint suppresses flicker under GTK
-#endif // wxGTK
+      case WXLOWIN_MENU_DBLCLICK:
+         // select a word under cursor
+         m_llist->MoveCursorTo(cursorPos);
+         m_llist->MoveCursorWord(-1);
+         m_llist->StartSelection();
+         m_llist->MoveCursorWord(1, false);
+         m_llist->EndSelection();
+
+         DoPaint();     // TODO: we don't have to redraw everything!
+         break;
    }
 
    // notify about mouse events?
@@ -344,13 +407,15 @@ wxLayoutWindow::OnMouse(int eventId, wxMouseEvent& event)
       u->DecRef();
 }
 
-/*
- * Some simple keyboard handling.
- */
+// ----------------------------------------------------------------------------
+// keyboard handling.
+// ----------------------------------------------------------------------------
+
 void
 wxLayoutWindow::OnChar(wxKeyEvent& event)
 {
    int keyCode = event.KeyCode();
+   bool ctrlDown = event.ControlDown();
 
 #ifdef WXLAYOUT_DEBUG
    if(keyCode == WXK_F1)
@@ -360,26 +425,36 @@ wxLayoutWindow::OnChar(wxKeyEvent& event)
    }
 #endif
 
-   if(! m_Selecting && event.ShiftDown())
+   // Force m_Selecting to be false if shift is no longer
+   // pressed. OnKeyUp() cannot catch all Shift-Up events.
+   if(!event.ShiftDown())
+      m_Selecting = false;
+   
+   // pressing any non-arrow key optionally replaces the selection:
+   if(m_AutoDeleteSelection
+      && !m_Selecting
+      && m_llist->HasSelection() 
+      && ! IsDirectionKey(keyCode)
+      && ! (event.AltDown() || ctrlDown)
+      )
+      m_llist->DeleteSelection();
+   
+   // <Shift>+<arrow> starts selection
+   if ( IsDirectionKey(keyCode) )
    {
-      switch(keyCode)
+      if ( !m_Selecting )
       {
-      case WXK_UP:
-      case WXK_DOWN:
-      case WXK_RIGHT:
-      case WXK_LEFT:
-      case WXK_PRIOR:
-      case WXK_NEXT:
-      case WXK_HOME:
-      case WXK_END:
          m_Selecting = true;
          m_llist->StartSelection();
-         break;
-      default:
-         ;
+      }
+      else
+      {
+         // just continue the old selection
+         if(! event.ShiftDown() )
+            m_llist->DiscardSelection();
       }
    }
-
+   
    // If needed, make cursor visible:
    if(m_CursorVisibility == -1)
       m_CursorVisibility = 1;
@@ -389,7 +464,6 @@ wxLayoutWindow::OnChar(wxKeyEvent& event)
       cursor, etc. It's default will process all keycodes causing
       modifications to the buffer, but only if editing is allowed.
    */
-   bool ctrlDown = event.ControlDown();
    switch(keyCode)
    {
    case WXK_RIGHT:
@@ -424,7 +498,7 @@ wxLayoutWindow::OnChar(wxKeyEvent& event)
       break;
    case WXK_END:
       if ( ctrlDown )
-         m_llist->MoveCursorTo(m_llist->GetSize());
+         m_llist->MoveCursorToEnd();
       else
          m_llist->MoveCursorToEndOfLine();
       break;
@@ -438,7 +512,7 @@ wxLayoutWindow::OnChar(wxKeyEvent& event)
       else if( IsEditable() )
       {
          /* First, handle control keys */
-         if(event.ControlDown() && ! event.AltDown())
+         if(ctrlDown && ! event.AltDown())
          {
             switch(keyCode)
             {
@@ -505,13 +579,26 @@ wxLayoutWindow::OnChar(wxKeyEvent& event)
                   m_llist->Delete(1);
                break;
             case WXK_BACK: // backspace
-               if(m_llist->MoveCursorHorizontally(-1)) m_llist->Delete(1);
+               if(m_llist->MoveCursorHorizontally(-1))
+                  m_llist->Delete(1);
                break;
             case WXK_RETURN:
                if(m_WrapMargin > 0)
                   m_llist->WrapLine(m_WrapMargin);
                m_llist->LineBreak();
                break;
+
+            case WXK_TAB:
+               {
+                   // TODO should be configurable
+                   static const int tabSize = 8;
+
+                   CoordType x = m_llist->GetCursorPos().x;
+                   size_t numSpaces = tabSize - x % tabSize;
+                   m_llist->Insert(wxString(' ', numSpaces));
+               }
+               break;
+
             default:
                if((!(event.ControlDown() || event.AltDown() || event.MetaDown()))
                   && (keyCode < 256 && keyCode >= 32)
@@ -528,15 +615,11 @@ wxLayoutWindow::OnChar(wxKeyEvent& event)
          SetModified();
       }// if(IsEditable())
    }// first switch()
-   if(m_Selecting)
+
+   if ( m_Selecting )
    {
-      if(event.ShiftDown())
-         m_llist->ContinueSelection();
-      else
-      {
-         m_llist->EndSelection();
-         m_Selecting = false;
-      }
+      // continue selection to the current (new) cursor position
+      m_llist->ContinueSelection();
    }
 
    // we must call ResizeScrollbars() before ScrollToCursor(), otherwise the
@@ -551,11 +634,12 @@ wxLayoutWindow::OnChar(wxKeyEvent& event)
 void
 wxLayoutWindow::OnKeyUp(wxKeyEvent& event)
 {
-   if(event.KeyCode() == WXK_SHIFT && m_llist->IsSelecting())
+   if ( event.KeyCode() == WXK_SHIFT && m_Selecting )
    {
       m_llist->EndSelection();
       m_Selecting = false;
    }
+
    event.Skip();
 }
 
@@ -576,19 +660,10 @@ wxLayoutWindow::ScrollToCursor(void)
    WXLO_DEBUG(("ScrollToCursor: ViewStart is %d/%d", x0, y0));
 
    // Get the size of the visible window:
-   GetClientSize(&x1,&y1);
+   GetClientSize(&x1, &y1);
 
-   // notice that the client size may be (0, 0)...
-   wxASSERT(x1 >= 0 && y1 >= 0);
-
-   // VZ: I think this is false - if you do it here, ResizeScrollbars() won't
-   //     call SetScrollbars() later
-#if 0
-   // As we have the values anyway, use them to avoid unnecessary scrollbar
-   // updates.
-   if(x1 > m_maxx) m_maxx = x1;
-   if(y1 > m_maxy) m_maxy = y1;
-#endif // 0
+   // update the cursor screen position
+   m_llist->Layout(dc);
 
    // Make sure that the scrollbars are at a position so that the cursor is
    // visible if we are editing
@@ -793,17 +868,38 @@ wxLayoutWindow::InternalPaint(const wxRect *updateRect)
    }
 }
 
+void
+wxLayoutWindow::OnSize(wxSizeEvent &event)
+{
+   if ( m_llist )
+   {
+      ResizeScrollbars();
+   }
+
+   event.Skip();
+}
+
 // change the range and position of scrollbars
 void
 wxLayoutWindow::ResizeScrollbars(bool exact)
 {
    wxPoint max = m_llist->GetSize();
+   wxSize size = GetClientSize();
 
    WXLO_DEBUG(("ResizeScrollbars: max size = (%ld, %ld)",
                (long int)max.x, (long int) max.y));
 
+   // in the absence of scrollbars we should compare with the client size
+   if ( !m_hasHScrollbar )
+      m_maxx = size.x - WXLO_ROFFSET;
+   if ( !m_hasVScrollbar )
+      m_maxy = size.y - WXLO_BOFFSET;
+
+   // check if the text hasn't become too big
+   // TODO why do we set both at once? they're independent...
    if( max.x > m_maxx - WXLO_ROFFSET || max.y > m_maxy - WXLO_BOFFSET || exact )
    {
+      // text became too large
       if ( !exact )
       {
          // add an extra bit to the sizes to avoid future updates
@@ -817,17 +913,49 @@ wxLayoutWindow::ResizeScrollbars(bool exact)
                     m_ViewStartX, m_ViewStartY,
                     true);
 
+      m_hasHScrollbar =
+      m_hasVScrollbar = true;
+
       m_maxx = max.x + X_SCROLL_PAGE;
       m_maxy = max.y + Y_SCROLL_PAGE;
    }
+#if 0
+   else
+   {
+      // check if the window hasn't become too big, thus making the scrollbars
+      // unnecessary
+      if ( m_hasHScrollbar && (max.x < size.x) )
+      {
+         // remove the horizontal scrollbar
+         SetScrollbars(0, -1, 0, -1, 0, -1, true);
+         m_hasHScrollbar = false;
+      }
+
+      if ( m_hasVScrollbar && (max.y < size.y) )
+      {
+         // remove the vertical scrollbar
+         SetScrollbars(-1, 0, -1, 0, -1, 0, true);
+         m_hasVScrollbar = false;
+      }
+   }
+#endif
 }
 
+// ----------------------------------------------------------------------------
+// clipboard operations
+//
+// ----------------------------------------------------------------------------
+
 void
-wxLayoutWindow::Paste(void)
+wxLayoutWindow::Paste(bool primary)
 {
    // Read some text
    if (wxTheClipboard->Open())
    {
+#if __WXGTK__
+      if(primary)
+         wxTheClipboard->UsePrimarySelection();
+#endif
 #if wxUSE_PRIVATE_CLIPBOARD_FORMAT
       wxLayoutDataObject wxldo;
       if (wxTheClipboard->IsSupported( wxldo.GetFormat() ))
@@ -850,17 +978,6 @@ wxLayoutWindow::Paste(void)
       }
       wxTheClipboard->Close();
    }
-
-#if 0
-   /* My attempt to get the primary selection, but it does not
-      work. :-( */
-   if(text.Length() == 0)
-   {
-      wxTextCtrl tmp_tctrl(this,-1);
-      tmp_tctrl.Paste();
-      text += tmp_tctrl.GetValue();
-   }
-#endif
 }
 
 bool
@@ -926,6 +1043,11 @@ wxLayoutWindow::Cut(void)
    else
       return FALSE;
 }
+
+// ----------------------------------------------------------------------------
+// searching
+// ----------------------------------------------------------------------------
+
 bool
 wxLayoutWindow::Find(const wxString &needle,
                      wxPoint * fromWhere)
@@ -950,6 +1072,10 @@ wxLayoutWindow::Find(const wxString &needle,
    return false;
 }
 
+// ----------------------------------------------------------------------------
+// popup menu stuff
+// ----------------------------------------------------------------------------
+
 wxMenu *
 wxLayoutWindow::MakeFormatMenu()
 {
@@ -989,31 +1115,28 @@ void wxLayoutWindow::OnMenu(wxCommandEvent& event)
    switch (event.GetId())
    {
    case WXLOWIN_MENU_LARGER:
-      m_llist->SetFontLarger();
-      break;
+      m_llist->SetFontLarger(); Refresh(FALSE); break;
    case WXLOWIN_MENU_SMALLER:
-      m_llist->SetFontSmaller();
-      break;
-
+      m_llist->SetFontSmaller(); Refresh(FALSE); break;
    case WXLOWIN_MENU_UNDERLINE:
-      m_llist->ToggleFontUnderline();
-      break;
+      m_llist->ToggleFontUnderline(); Refresh(FALSE); break;
    case WXLOWIN_MENU_BOLD:
-      m_llist->ToggleFontWeight();
-      break;
+      m_llist->ToggleFontWeight(); Refresh(FALSE); break;
    case WXLOWIN_MENU_ITALICS:
-      m_llist->ToggleFontItalics();
-      break;
-
+      m_llist->ToggleFontItalics(); Refresh(FALSE); break;
    case WXLOWIN_MENU_ROMAN:
-      m_llist->SetFontFamily(wxROMAN); break;
+      m_llist->SetFontFamily(wxROMAN); Refresh(FALSE); break;
    case WXLOWIN_MENU_TYPEWRITER:
-      m_llist->SetFontFamily(wxFIXED); break;
+      m_llist->SetFontFamily(wxFIXED); Refresh(FALSE); break;
    case WXLOWIN_MENU_SANSSERIF:
-      m_llist->SetFontFamily(wxSWISS); break;
+      m_llist->SetFontFamily(wxSWISS); Refresh(FALSE); break;
    }
 }
 
+// ----------------------------------------------------------------------------
+// focus
+// ----------------------------------------------------------------------------
+
 void
 wxLayoutWindow::OnSetFocus(wxFocusEvent &ev)
 {
@@ -1027,3 +1150,26 @@ wxLayoutWindow::OnKillFocus(wxFocusEvent &ev)
    m_HaveFocus = false;
    ev.Skip();
 }
+
+// ----------------------------------------------------------------------------
+// private functions
+// ----------------------------------------------------------------------------
+
+static bool IsDirectionKey(long keyCode)
+{
+   switch(keyCode)
+   {
+      case WXK_UP:
+      case WXK_DOWN:
+      case WXK_RIGHT:
+      case WXK_LEFT:
+      case WXK_PRIOR:
+      case WXK_NEXT:
+      case WXK_HOME:
+      case WXK_END:
+         return true;
+
+      default:
+         return false;
+   }
+}