]> git.saurik.com Git - wxWidgets.git/blobdiff - src/gtk1/mdi.cpp
Attempt to add primary selection support, but doesn't work.
[wxWidgets.git] / src / gtk1 / mdi.cpp
index cf1408acdf673f66d6346699476b120ca085feba..e9acbdf01acd6b949f25d3f9c4ac331d70204fc4 100644 (file)
@@ -2,10 +2,9 @@
 // Name:        mdi.cpp
 // Purpose:
 // Author:      Robert Roebling
-// Created:     01/02/97
-// Id:
-// Copyright:   (c) 1998 Robert Roebling, Julian Smart and Markus Holzem
-// Licence:    wxWindows licence
+// Id:          $Id$
+// Copyright:   (c) 1998 Robert Roebling
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 #ifdef __GNUG__
 
 #include "wx/mdi.h"
 #include "wx/dialog.h"
+#include "wx/menu.h"
+#include <wx/intl.h>
+
+#include "glib.h"
+#include "gdk/gdk.h"
+#include "gtk/gtk.h"
 #include "wx/gtk/win_gtk.h"
 
+//-----------------------------------------------------------------------------
+// constants
 //-----------------------------------------------------------------------------
 
-extern wxList wxPendingDelete;
+const int wxMENU_HEIGHT = 27;
 
 //-----------------------------------------------------------------------------
-// wxMDIParentFrame
+// idle system
 //-----------------------------------------------------------------------------
 
-static void gtk_page_size_callback( GtkWidget *WXUNUSED(widget), GtkAllocation* alloc, wxWindow *win )
-{ 
-  if ((win->m_x == alloc->x) &&
-      (win->m_y == alloc->y) &&
-      (win->m_width == alloc->width) &&
-      (win->m_height == alloc->height))
-  {
-    return;
-  };
-  
-  win->SetSize( alloc->x, alloc->y, alloc->width, alloc->height );
-};
-
-// page change callback
-static void gtk_page_change_callback( GtkNotebook *WXUNUSED(widget),
-                                      GtkNotebookPage *page,
-                                      gint WXUNUSED(nPage),
-                                      wxMDIClientWindow *client_win )
-{
-  wxNode *node = client_win->m_children.First();
-  while (node)
-  {
-    wxMDIChildFrame *child_frame = (wxMDIChildFrame *)node->Data();
-    if (child_frame->m_page == page)
-    {
-      wxMDIParentFrame *mdi_frame = (wxMDIParentFrame*)client_win->m_parent;
-      mdi_frame->m_currentChild = child_frame;
-      mdi_frame->SetMDIMenuBar( child_frame->m_menuBar );
-      return;
-    };
-    node = node->Next();
-  }
-}
+extern void wxapp_install_idle_handler();
+extern bool g_isIdle;
+
+//-----------------------------------------------------------------------------
+// globals
+//-----------------------------------------------------------------------------
 
+extern wxList wxPendingDelete;
+
+//-----------------------------------------------------------------------------
+// wxMDIParentFrame
 //-----------------------------------------------------------------------------
 
 IMPLEMENT_DYNAMIC_CLASS(wxMDIParentFrame,wxFrame)
@@ -65,252 +49,337 @@ IMPLEMENT_DYNAMIC_CLASS(wxMDIParentFrame,wxFrame)
 BEGIN_EVENT_TABLE(wxMDIParentFrame, wxFrame)
 END_EVENT_TABLE()
 
-wxMDIParentFrame::wxMDIParentFrame(void)
+wxMDIParentFrame::wxMDIParentFrame()
 {
-  m_clientWindow = NULL;
-  m_currentChild = NULL;
-  m_parentFrameActive = TRUE;
-};
+    m_justInserted = FALSE;
+    m_clientWindow = (wxMDIClientWindow *) NULL;
+}
 
 wxMDIParentFrame::wxMDIParentFrame( wxWindow *parent,
       wxWindowID id, const wxString& title,
       const wxPoint& pos, const wxSize& size,
       long style, const wxString& name )
 {
-  m_clientWindow = NULL;
-  m_currentChild = NULL;
-  m_parentFrameActive = TRUE;
-  Create( parent, id, title, pos, size, style, name );
-};
+    m_justInserted = FALSE;
+    m_clientWindow = (wxMDIClientWindow *) NULL;
+    Create( parent, id, title, pos, size, style, name );
+}
 
-wxMDIParentFrame::~wxMDIParentFrame(void)
+wxMDIParentFrame::~wxMDIParentFrame()
 {
-};
+}
 
 bool wxMDIParentFrame::Create( wxWindow *parent,
       wxWindowID id, const wxString& title,
       const wxPoint& pos, const wxSize& size,
       long style, const wxString& name )
 {
-  wxFrame::Create( parent, id, title, pos, size, style, name );
-  
-  OnCreateClient();
-  
-  return TRUE;
-};
+    wxFrame::Create( parent, id, title, pos, size, style, name );
+
+    OnCreateClient();
+
+    return TRUE;
+}
 
 void wxMDIParentFrame::GtkOnSize( int x, int y, int width, int height )
 {
-  wxFrame::GtkOnSize( x, y, width, height );
-  
-  if (m_mdiMenuBar)
-  {
-    int x = 0;
-    int y = 0;
-    GetClientSize( &x, &y );
-    m_mdiMenuBar->SetSize( 1, 1, x-2, 26 ); 
-  }
-};
-
-void wxMDIParentFrame::SetMDIMenuBar( wxMenuBar *menu_bar )
+    wxFrame::GtkOnSize( x, y, width, height );
+
+    wxMDIChildFrame *child_frame = GetActiveChild();
+    if (!child_frame) return;
+
+    wxMenuBar *menu_bar = child_frame->m_menuBar;
+    if (!menu_bar) return;
+    if (!menu_bar->m_widget) return;
+
+    menu_bar->m_x = 0;
+    menu_bar->m_y = 0;
+    menu_bar->m_width = m_width;
+    menu_bar->m_height = wxMENU_HEIGHT;
+    gtk_myfixed_set_size( GTK_MYFIXED(m_mainWidget), 
+                          menu_bar->m_widget, 
+                          0, 0, m_width, wxMENU_HEIGHT );
+}
+
+void wxMDIParentFrame::OnInternalIdle()
 {
-  if (m_mdiMenuBar) m_mdiMenuBar->Show( FALSE );
-  m_mdiMenuBar = menu_bar;
-  if (m_mdiMenuBar)
-  {
-    int x = 0;
-    int y = 0;
-    GetClientSize( &x, &y );
-    m_mdiMenuBar->SetSize( 1, 1, x-2, 26 ); 
-    m_mdiMenuBar->Show( TRUE );
-  }
-};
+    /* if a an MDI child window has just been inserted
+       it has to be brought to the top in idle time. we
+       simply set the last notebook page active as new
+       pages can only be appended at the end */
+
+    if (m_justInserted)
+    {
+        GtkNotebook *notebook = GTK_NOTEBOOK(m_clientWindow->m_widget);
+        gtk_notebook_set_page( notebook, g_list_length( notebook->children ) - 1 );
+
+        m_justInserted = FALSE;
+        return;
+    }
+
+    wxFrame::OnInternalIdle();
+
+    wxMDIChildFrame *active_child_frame = GetActiveChild();
+    bool visible_child_menu = FALSE;
+
+    wxNode *node = m_clientWindow->GetChildren().First();
+    while (node)
+    {
+        wxMDIChildFrame *child_frame = (wxMDIChildFrame *)node->Data();
+       wxMenuBar *menu_bar = child_frame->m_menuBar;
+        if (child_frame->m_menuBar)
+        {
+            if (child_frame == active_child_frame)
+            {
+               if (menu_bar->Show(TRUE))
+               {
+                   menu_bar->m_width = m_width;
+                   menu_bar->m_height = wxMENU_HEIGHT;
+                    gtk_myfixed_set_size( GTK_MYFIXED(m_mainWidget), 
+                                         menu_bar->m_widget, 
+                                         0, 0, m_width, wxMENU_HEIGHT );
+                   menu_bar->SetInvokingWindow( child_frame );
+               }
+                visible_child_menu = TRUE;
+            }
+            else
+           {
+               if (menu_bar->Show(FALSE))
+               {
+                   menu_bar->UnsetInvokingWindow( child_frame );
+               }
+           }
+        }
+        node = node->Next();
+    }
+
+    /* show/hide parent menu bar as required */
+    if ((m_frameMenuBar) &&
+        (m_frameMenuBar->IsShown() == visible_child_menu))
+    {
+        if (visible_child_menu)
+       {
+            m_frameMenuBar->Show( FALSE );
+           m_frameMenuBar->UnsetInvokingWindow( this );
+       }
+       else
+       {
+            m_frameMenuBar->Show( TRUE );
+           m_frameMenuBar->SetInvokingWindow( this );
+           
+           m_frameMenuBar->m_width = m_width;
+           m_frameMenuBar->m_height = wxMENU_HEIGHT;
+            gtk_myfixed_set_size( GTK_MYFIXED(m_mainWidget), 
+                                 m_frameMenuBar->m_widget, 
+                                 0, 0, m_width, wxMENU_HEIGHT );
+       }
+    }
+}
 
 void wxMDIParentFrame::GetClientSize(int *width, int *height ) const
 {
-  wxFrame::GetClientSize( width, height );
-};
+    wxFrame::GetClientSize( width, height );
+}
 
-wxMDIChildFrame *wxMDIParentFrame::GetActiveChild(void) const
+wxMDIChildFrame *wxMDIParentFrame::GetActiveChild() const
 {
-  return m_currentChild;
-};
+    if (!m_clientWindow) return (wxMDIChildFrame*) NULL;
+
+    GtkNotebook *notebook = GTK_NOTEBOOK(m_clientWindow->m_widget);
+    if (!notebook) return (wxMDIChildFrame*) NULL;
+
+#if (GTK_MINOR_VERSION > 0)
+    gint i = gtk_notebook_get_current_page( notebook );
+#else
+    gint i = gtk_notebook_current_page( notebook );
+#endif
+    if (i < 0) return (wxMDIChildFrame*) NULL;
+
+    GtkNotebookPage* page = (GtkNotebookPage*) (g_list_nth(notebook->children,i)->data);
+    if (!page) return (wxMDIChildFrame*) NULL;
 
-wxMDIClientWindow *wxMDIParentFrame::GetClientWindow(void) const
+    wxNode *node = m_clientWindow->GetChildren().First();
+    while (node)
+    {
+        wxMDIChildFrame *child_frame = (wxMDIChildFrame *)node->Data();
+        if (child_frame->m_page == page)
+            return child_frame;
+        node = node->Next();
+    }
+
+    return (wxMDIChildFrame*) NULL;
+}
+
+wxMDIClientWindow *wxMDIParentFrame::GetClientWindow() const
 {
-  return m_clientWindow;
-};
+    return m_clientWindow;
+}
 
-wxMDIClientWindow *wxMDIParentFrame::OnCreateClient(void)
+wxMDIClientWindow *wxMDIParentFrame::OnCreateClient()
 {
-  m_clientWindow = new wxMDIClientWindow( this );
-  return m_clientWindow;
-};
+    m_clientWindow = new wxMDIClientWindow( this );
+    return m_clientWindow;
+}
 
-void wxMDIParentFrame::ActivateNext(void)
+void wxMDIParentFrame::ActivateNext()
 {
-  if (m_clientWindow)
-    gtk_notebook_next_page( GTK_NOTEBOOK(m_clientWindow->m_widget) );
-};
+    if (m_clientWindow)
+      gtk_notebook_next_page( GTK_NOTEBOOK(m_clientWindow->m_widget) );
+}
 
-void wxMDIParentFrame::ActivatePrevious(void)
+void wxMDIParentFrame::ActivatePrevious()
 {
-  if (m_clientWindow)
-    gtk_notebook_prev_page( GTK_NOTEBOOK(m_clientWindow->m_widget) );
-};
+    if (m_clientWindow)
+      gtk_notebook_prev_page( GTK_NOTEBOOK(m_clientWindow->m_widget) );
+}
 
 void wxMDIParentFrame::OnActivate( wxActivateEvent& WXUNUSED(event) )
 {
-};
+}
 
 void wxMDIParentFrame::OnSysColourChanged( wxSysColourChangedEvent& WXUNUSED(event) )
 {
-};
+}
 
 //-----------------------------------------------------------------------------
 // wxMDIChildFrame
 //-----------------------------------------------------------------------------
 
-IMPLEMENT_DYNAMIC_CLASS(wxMDIChildFrame,wxPanel)
-  
-BEGIN_EVENT_TABLE(wxMDIChildFrame, wxPanel)
-  EVT_CLOSE(wxMDIChildFrame::OnCloseWindow)
-  EVT_SIZE(wxMDIChildFrame::OnSize)
-  EVT_ACTIVATE(wxMDIChildFrame::OnActivate)
+IMPLEMENT_DYNAMIC_CLASS(wxMDIChildFrame,wxFrame)
+
+BEGIN_EVENT_TABLE(wxMDIChildFrame, wxFrame)
+    EVT_ACTIVATE(wxMDIChildFrame::OnActivate)
 END_EVENT_TABLE()
 
-wxMDIChildFrame::wxMDIChildFrame(void)
+wxMDIChildFrame::wxMDIChildFrame()
 {
-  m_menuBar = NULL;
-  m_page = NULL;
-};
+    m_menuBar = (wxMenuBar *) NULL;
+    m_page = (GtkNotebookPage *) NULL;
+}
 
 wxMDIChildFrame::wxMDIChildFrame( wxMDIParentFrame *parent,
       wxWindowID id, const wxString& title,
       const wxPoint& WXUNUSED(pos), const wxSize& size,
       long style, const wxString& name )
 {
-  m_menuBar = NULL;
-  m_page = NULL;
-  Create( parent, id, title, wxDefaultPosition, size, style, name );
-};
+    m_menuBar = (wxMenuBar *) NULL;
+    m_page = (GtkNotebookPage *) NULL;
+    Create( parent, id, title, wxDefaultPosition, size, style, name );
+}
 
-wxMDIChildFrame::~wxMDIChildFrame(void)
+wxMDIChildFrame::~wxMDIChildFrame()
 {
-  if (m_menuBar)
-  {
-    wxMDIParentFrame *mdi_frame = (wxMDIParentFrame*)m_parent->m_parent;
-    if (mdi_frame->m_currentChild == this)
-    {
-      mdi_frame->SetMDIMenuBar( NULL );
-      mdi_frame->m_currentChild = NULL;
-    };
-    delete m_menuBar;
-  }
-};
+    if (m_menuBar)
+        delete m_menuBar;
+}
 
 bool wxMDIChildFrame::Create( wxMDIParentFrame *parent,
       wxWindowID id, const wxString& title,
       const wxPoint& WXUNUSED(pos), const wxSize& size,
       long style, const wxString& name )
 {
-  m_title = title;
-  return wxPanel::Create( parent->GetClientWindow(), id, wxDefaultPosition, size, style, name );
-};
+    m_title = title;
 
-void wxMDIChildFrame::OnCloseWindow( wxCloseEvent &event )
+    return wxWindow::Create( parent->GetClientWindow(), id, wxDefaultPosition, size, style, name );
+}
+
+void wxMDIChildFrame::GetClientSize( int *width, int *height ) const
 {
-    if ( GetEventHandler()->OnClose() || event.GetForce())
-    {
-        this->Destroy();
-    }
-};
+    wxWindow::GetClientSize( width, height );
+}
 
-void wxMDIChildFrame::OnSize( wxSizeEvent &WXUNUSED(event) )
+void wxMDIChildFrame::AddChild( wxWindow *child )
 {
-  if ( GetAutoLayout() )
-    Layout();
-  else {
-    // no child: go out !
-    if (!GetChildren()->First())
-      return;
-      
-    // do we have exactly one child?
-    wxWindow *child = NULL;
-    for(wxNode *node = GetChildren()->First(); node; node = node->Next())
+    wxWindow::AddChild( child );
+}
+
+void wxMDIChildFrame::SetMenuBar( wxMenuBar *menu_bar )
+{
+    wxASSERT_MSG( m_menuBar == NULL, _T("Only one menubar allowed") );
+
+    m_menuBar = menu_bar;
+
+    if (m_menuBar)
     {
-      wxWindow *win = (wxWindow *)node->Data();
-      if (!IS_KIND_OF(win,wxFrame) && !IS_KIND_OF(win,wxDialog))
-      {
-        if ( child )  // it's the second one: do nothing
-          return;
-
-        child = win;
-      };
-    };
-
-    // yes: set it's size to fill all the frame
-    int client_x, client_y;
-    GetClientSize(&client_x, &client_y);
-    child->SetSize( 1, 1, client_x-2, client_y);
-  }
-};
-
-bool wxMDIChildFrame::Destroy(void)
+        wxMDIParentFrame *mdi_frame = (wxMDIParentFrame*)m_parent->GetParent();
+
+        m_menuBar->SetParent( mdi_frame );
+
+        /* insert the invisible menu bar into the _parent_ mdi frame */
+        gtk_myfixed_put( GTK_MYFIXED(mdi_frame->m_mainWidget), 
+                         m_menuBar->m_widget, 
+                         0, 0,  mdi_frame->m_width, wxMENU_HEIGHT );
+    }
+}
+
+wxMenuBar *wxMDIChildFrame::GetMenuBar() const
 {
-  if (!wxPendingDelete.Member(this))
-    wxPendingDelete.Append(this);
+    return m_menuBar;
+}
 
-  return TRUE;
+void wxMDIChildFrame::Activate()
+{
+#if (GTK_MINOR_VERSION > 0)
+    wxMDIParentFrame* parent = (wxMDIParentFrame*) GetParent();
+    GtkNotebook* notebook = GTK_NOTEBOOK(parent->m_widget);
+    gint pageno = gtk_notebook_page_num( notebook, m_page->child );
+    gtk_notebook_set_page( notebook, pageno );
+#else
+    // the only way I can see to do this under gtk+ 1.0.X would
+    // be to keep track of page numbers, start at first and 
+    // do "next" enough times to get to this page number - messy
+    // - J. Russell Smyth
+#endif
 }
 
-static void SetInvokingWindow( wxMenu *menu, wxWindow *win )
+void wxMDIChildFrame::OnActivate( wxActivateEvent &WXUNUSED(event) )
 {
-  menu->SetInvokingWindow( win );
-  wxNode *node = menu->m_items.First();
-  while (node)
-  {
-    wxMenuItem *menuitem = (wxMenuItem*)node->Data();
-    if (menuitem->IsSubMenu())
-      SetInvokingWindow( menuitem->GetSubMenu(), win );
-    node = node->Next();
-  };
-};
+}
 
-void wxMDIChildFrame::SetMenuBar( wxMenuBar *menu_bar )
+//-----------------------------------------------------------------------------
+// "size_allocate"
+//-----------------------------------------------------------------------------
+
+static void gtk_page_size_callback( GtkWidget *WXUNUSED(widget), GtkAllocation* alloc, wxWindow *win )
 {
-  m_menuBar = menu_bar;
-  
-  if (m_menuBar)
-  {
-    wxMDIParentFrame *mdi_frame = (wxMDIParentFrame*)m_parent->m_parent;
-    
-    if (m_menuBar->m_parent != this)
+    if (g_isIdle) wxapp_install_idle_handler();
+
+    if ((win->m_x == alloc->x) &&
+        (win->m_y == alloc->y) &&
+        (win->m_width == alloc->width) &&
+        (win->m_height == alloc->height) &&
+        (win->m_sizeSet))
     {
-      wxNode *node = m_menuBar->m_menus.First();
-      while (node)
-      {
-        wxMenu *menu = (wxMenu*)node->Data();
-        SetInvokingWindow( menu, this );
-        node = node->Next();
-      };
-      
-      m_menuBar->m_parent = mdi_frame;
+        return;
     }
-    mdi_frame->SetMDIMenuBar( m_menuBar );
 
-    gtk_myfixed_put( GTK_MYFIXED(mdi_frame->m_mainWindow),
-      m_menuBar->m_widget, m_menuBar->m_x, m_menuBar->m_y );
-  }
-};
+    win->SetSize( alloc->x, alloc->y, alloc->width, alloc->height );
+}
 
-void wxMDIChildFrame::Activate(void)
-{
-};
+//-----------------------------------------------------------------------------
+// InsertChild callback for wxMDIClientWindow
+//-----------------------------------------------------------------------------
 
-void wxMDIChildFrame::OnActivate( wxActivateEvent &WXUNUSED(event) )
+static void wxInsertChildInMDI( wxMDIClientWindow* parent, wxMDIChildFrame* child )
 {
-};
+    wxString s = child->m_title;
+    if (s.IsNull()) s = _("MDI child");
+
+    GtkWidget *label_widget = gtk_label_new( s.mbc_str() );
+    gtk_misc_set_alignment( GTK_MISC(label_widget), 0.0, 0.5 );
+
+    gtk_signal_connect( GTK_OBJECT(child->m_widget), "size_allocate",
+      GTK_SIGNAL_FUNC(gtk_page_size_callback), (gpointer)child );
+
+    GtkNotebook *notebook = GTK_NOTEBOOK(parent->m_widget);
+
+    gtk_notebook_append_page( notebook, child->m_widget, label_widget );
+
+    child->m_page = (GtkNotebookPage*) (g_list_last(notebook->children)->data);
+
+    wxMDIParentFrame *parent_frame = (wxMDIParentFrame*) parent->GetParent();
+    parent_frame->m_justInserted = TRUE;
+}
 
 //-----------------------------------------------------------------------------
 // wxMDIClientWindow
@@ -318,68 +387,37 @@ void wxMDIChildFrame::OnActivate( wxActivateEvent &WXUNUSED(event) )
 
 IMPLEMENT_DYNAMIC_CLASS(wxMDIClientWindow,wxWindow)
 
-wxMDIClientWindow::wxMDIClientWindow(void)
+wxMDIClientWindow::wxMDIClientWindow()
 {
-};
+}
 
 wxMDIClientWindow::wxMDIClientWindow( wxMDIParentFrame *parent, long style )
 {
-  CreateClient( parent, style );
-};
+    CreateClient( parent, style );
+}
 
-wxMDIClientWindow::~wxMDIClientWindow(void)
+wxMDIClientWindow::~wxMDIClientWindow()
 {
-};
+}
 
 bool wxMDIClientWindow::CreateClient( wxMDIParentFrame *parent, long style )
 {
-  m_needParent = TRUE;
-  
-  PreCreation( parent, -1, wxPoint(10,10), wxSize(100,100), style, "wxMDIClientWindow" );
-
-  m_widget = gtk_notebook_new();
-  
-  gtk_signal_connect( GTK_OBJECT(m_widget), "switch_page",
-                      GTK_SIGNAL_FUNC(gtk_page_change_callback), (gpointer)this );
-                 
-  gtk_notebook_set_scrollable( GTK_NOTEBOOK(m_widget), 1 );
-  
-  PostCreation();
-  
-  Show( TRUE );
-  
-  return TRUE;
-};
-
-void wxMDIClientWindow::AddChild( wxWindow *child )
-{
-  if (!child->IsKindOf(CLASSINFO(wxMDIChildFrame)))
-  {
-     wxFAIL_MSG("wxNotebook::AddChild: Child has to be wxMDIChildFrame");
-     return;
-  };
-  
-  m_children.Append( child );
-  
-  wxString s;
-  wxMDIChildFrame* mdi_child = (wxMDIChildFrame*) child;
-  s = mdi_child->m_title;
-  if (s.IsNull()) s = "MDI child";
-  
-  GtkWidget *label_widget;
-  label_widget = gtk_label_new( s );
-  gtk_misc_set_alignment( GTK_MISC(label_widget), 0.0, 0.5 );
-  
-  gtk_signal_connect( GTK_OBJECT(child->m_widget), "size_allocate",
-    GTK_SIGNAL_FUNC(gtk_page_size_callback), (gpointer)child );
-    
-  gtk_notebook_append_page( GTK_NOTEBOOK(m_widget), child->m_widget, label_widget );
-  
-  mdi_child->m_page = (GtkNotebookPage*) (g_list_last(GTK_NOTEBOOK(m_widget)->children)->data);
-    
-  gtk_notebook_set_page( GTK_NOTEBOOK(m_widget), m_children.Number()-1 );
-  
-  gtk_page_change_callback( NULL, mdi_child->m_page, 0, this );
-};
+    m_needParent = TRUE;
+
+    m_insertCallback = (wxInsertChildFunction)wxInsertChildInMDI;
+
+    PreCreation( parent, -1, wxPoint(10,10), wxSize(100,100), style, "wxMDIClientWindow" );
 
+    m_widget = gtk_notebook_new();
+
+    gtk_notebook_set_scrollable( GTK_NOTEBOOK(m_widget), 1 );
+
+    m_parent->DoAddChild( this );
+
+    PostCreation();
+
+    Show( TRUE );
+
+    return TRUE;
+}