Minor code improvements and coding policy fixes.

* BLOCK_SELECTOR class is not longer derived from EDA_ITEM.
* Encapsulate BLOCK_SELECTOR class member variables and add access methods.
* Move HandleBlockBegin() function from block_commande.cpp to drawframe.cpp.
* Remove virtual methods from top level derived objects per future
  coding policy change.
* Remove Doxygen copydoc statement from objects derived from EDA_ITEM
  since the comments are automatically copied to the derived object.
* Removed copy and pasted Doxygen comments from objects derived from
  EDA_ITEM.

common/block_commande.cpp

@@ -2,7 +2,6 @@
  * This program source code file is part of KiCad, a free EDA CAD application.
  *
  * Copyright (C) 2004 Jean-Pierre Charras, [email protected]
- * Copyright (C) 2011 Wayne Stambaugh <[email protected]>
  * Copyright (C) 2004-2011 KiCad Developers, see change_log.txt for contributors.
  *
  * This program is free software; you can redistribute it and/or
@@ -40,11 +39,12 @@
 #include <block_commande.h>
 
 
-BLOCK_SELECTOR::BLOCK_SELECTOR() : EDA_RECT()
+BLOCK_SELECTOR::BLOCK_SELECTOR() :
+    EDA_RECT()
 {
-    m_State   = STATE_NO_BLOCK; /* State (enum BlockState) of block. */
-    m_Command = BLOCK_IDLE;     /* Type (enum CmdBlockType) of operation. */
-    m_Color   = BROWN;
+    m_state   = STATE_NO_BLOCK; /* State (enum BLOCK_STATE_T) of block. */
+    m_command = BLOCK_IDLE;     /* Type (enum BLOCK_COMMAND_T) of operation. */
+    m_color   = BROWN;
 }
 
 
@@ -53,14 +53,11 @@ BLOCK_SELECTOR::~BLOCK_SELECTOR()
 }
 
 
-/*
- *  Print block command message (Block move, Block copy ...) in status bar
- */
 void BLOCK_SELECTOR::SetMessageBlock( EDA_DRAW_FRAME* frame )
 {
     wxString msg;
 
-    switch( m_Command )
+    switch( m_command )
     {
     case BLOCK_IDLE:
         break;
@@ -137,193 +134,92 @@ void BLOCK_SELECTOR::Draw( EDA_DRAW_PANEL* aPanel, wxDC* aDC, const wxPoint& aOf
 }
 
 
-/**
- * Function InitData
- *  Init the initial values of a BLOCK_SELECTOR, before starting a block command
- */
 void BLOCK_SELECTOR::InitData( EDA_DRAW_PANEL* aPanel, const wxPoint& startpos )
 {
-    m_State = STATE_BLOCK_INIT;
+    m_state = STATE_BLOCK_INIT;
     SetOrigin( startpos );
     SetSize( wxSize( 0, 0 ) );
-    m_ItemsSelection.ClearItemsList();
+    m_items.ClearItemsList();
     aPanel->SetMouseCapture( DrawAndSizingBlockOutlines, AbortBlockCurrentCommand );
 }
 
 
-/**
- * Function ClearItemsList
- * delete only the list of EDA_ITEM * pointers, NOT the pointed data
- * itself
- */
 void BLOCK_SELECTOR::ClearItemsList()
 {
-    m_ItemsSelection.ClearItemsList();
+    m_items.ClearItemsList();
 }
 
-/**
- * Function ClearListAndDeleteItems
- * delete only the list of EDA_ITEM * pointers, AND the data pinted
- * by m_Item
- */
+
 void BLOCK_SELECTOR::ClearListAndDeleteItems()
 {
-     m_ItemsSelection.ClearListAndDeleteItems();
+     m_items.ClearListAndDeleteItems();
 }
 
-/**
- * Function PushItem
- * Add aItem to the list of items
- * @param aItem = an ITEM_PICKER to add to the list
- */
+
 void BLOCK_SELECTOR::PushItem( ITEM_PICKER& aItem )
 {
-    m_ItemsSelection.PushItem( aItem );
+    m_items.PushItem( aItem );
 }
 
 
 void BLOCK_SELECTOR::Clear()
 {
-    if( m_Command != BLOCK_IDLE )
+    if( m_command != BLOCK_IDLE )
     {
-        m_Command = BLOCK_IDLE;
-        m_State   = STATE_NO_BLOCK;
+        m_command = BLOCK_IDLE;
+        m_state   = STATE_NO_BLOCK;
         ClearItemsList();
     }
 }
 
 
-/*  First command block function:
- *  Init the Block infos: command type, initial position, and other variables..
- */
-bool EDA_DRAW_FRAME::HandleBlockBegin( wxDC* DC, int key, const wxPoint& startpos )
-{
-    BLOCK_SELECTOR* Block = &GetScreen()->m_BlockLocate;
-
-    if( ( Block->m_Command != BLOCK_IDLE ) || ( Block->m_State != STATE_NO_BLOCK ) )
-        return false;
-
-    Block->m_Command = (CmdBlockType) ReturnBlockCommand( key );
-
-    if( Block->m_Command == 0 )
-        return false;
-
-    switch( Block->m_Command )
-    {
-    case BLOCK_IDLE:
-        break;
-
-    case BLOCK_MOVE:                /* Move */
-    case BLOCK_DRAG:                /* Drag */
-    case BLOCK_COPY:                /* Copy */
-    case BLOCK_DELETE:              /* Delete */
-    case BLOCK_SAVE:                /* Save */
-    case BLOCK_ROTATE:              /* Rotate 90 deg */
-    case BLOCK_FLIP:                /* Flip */
-    case BLOCK_ZOOM:                /* Window Zoom */
-    case BLOCK_MIRROR_X:
-    case BLOCK_MIRROR_Y:            /* mirror */
-    case BLOCK_PRESELECT_MOVE:      /* Move with preselection list*/
-        Block->InitData( m_canvas, startpos );
-        break;
-
-    case BLOCK_PASTE:
-        Block->InitData( m_canvas, startpos );
-        Block->m_BlockLastCursorPosition.x = 0;
-        Block->m_BlockLastCursorPosition.y = 0;
-        InitBlockPasteInfos();
-
-        if( Block->m_ItemsSelection.GetCount() == 0 )      /* No data to paste */
-        {
-            DisplayError( this, wxT( "No Block to paste" ), 20 );
-            GetScreen()->m_BlockLocate.m_Command = BLOCK_IDLE;
-            m_canvas->SetMouseCaptureCallback( NULL );
-            return true;
-        }
-
-        if( !m_canvas->IsMouseCaptured() )
-        {
-            Block->m_ItemsSelection.ClearItemsList();
-            DisplayError( this,
-                          wxT( "EDA_DRAW_FRAME::HandleBlockBegin() Err: m_mouseCaptureCallback NULL" ) );
-            return true;
-        }
-
-        Block->m_State = STATE_BLOCK_MOVE;
-        m_canvas->CallMouseCapture( DC, startpos, false );
-        break;
-
-    default:
-    {
-        wxString msg;
-        msg << wxT( "EDA_DRAW_FRAME::HandleBlockBegin() error: Unknown command " ) <<
-        Block->m_Command;
-        DisplayError( this, msg );
-    }
-    break;
-    }
-
-    Block->SetMessageBlock( this );
-    return true;
-}
-
-
-/* Redraw the outlines of the block which shows the search area for block
- * commands
- *  The first point of the rectangle showing the area is initialised
- *  by Initm_BlockLocateDatas().
- *  The other point of the rectangle is the mouse cursor
- */
 void DrawAndSizingBlockOutlines( EDA_DRAW_PANEL* aPanel, wxDC* aDC, const wxPoint& aPosition,
                                  bool aErase )
 {
-    BLOCK_SELECTOR* PtBlock;
+    BLOCK_SELECTOR* block;
 
-    PtBlock = &aPanel->GetScreen()->m_BlockLocate;
+    block = &aPanel->GetScreen()->m_BlockLocate;
 
-    PtBlock->m_MoveVector = wxPoint( 0, 0 );
+    block->SetMoveVector( wxPoint( 0, 0 ) );
 
     if( aErase )
-        PtBlock->Draw( aPanel, aDC, wxPoint( 0, 0 ), g_XorMode, PtBlock->m_Color );
+        block->Draw( aPanel, aDC, wxPoint( 0, 0 ), g_XorMode, block->GetColor() );
 
-    PtBlock->m_BlockLastCursorPosition = aPanel->GetScreen()->GetCrossHairPosition();
-    PtBlock->SetEnd( aPanel->GetScreen()->GetCrossHairPosition() );
+    block->SetLastCursorPosition( aPanel->GetScreen()->GetCrossHairPosition() );
+    block->SetEnd( aPanel->GetScreen()->GetCrossHairPosition() );
 
-    PtBlock->Draw( aPanel, aDC, wxPoint( 0, 0 ), g_XorMode, PtBlock->m_Color );
+    block->Draw( aPanel, aDC, wxPoint( 0, 0 ), g_XorMode, block->GetColor() );
 
-    if( PtBlock->m_State == STATE_BLOCK_INIT )
+    if( block->GetState() == STATE_BLOCK_INIT )
     {
-        if( PtBlock->GetWidth() || PtBlock->GetHeight() )
+        if( block->GetWidth() || block->GetHeight() )
             /* 2nd point exists: the rectangle is not surface anywhere */
-            PtBlock->m_State = STATE_BLOCK_END;
+            block->SetState( STATE_BLOCK_END );
     }
 }
 
 
-/*
- *  Cancel Current block operation.
- */
-void AbortBlockCurrentCommand( EDA_DRAW_PANEL* Panel, wxDC* DC )
+void AbortBlockCurrentCommand( EDA_DRAW_PANEL* aPanel, wxDC* aDC )
 {
-    BASE_SCREEN* screen = Panel->GetScreen();
+    BASE_SCREEN* screen = aPanel->GetScreen();
 
-    if( Panel->IsMouseCaptured() )      /* Erase current drawing on screen */
+    if( aPanel->IsMouseCaptured() )      /* Erase current drawing on screen */
     {
         /* Clear block outline. */
-        Panel->CallMouseCapture( DC, wxDefaultPosition, false );
-        Panel->SetMouseCapture( NULL, NULL );
+        aPanel->CallMouseCapture( aDC, wxDefaultPosition, false );
+        aPanel->SetMouseCapture( NULL, NULL );
         screen->SetCurItem( NULL );
 
         /* Delete the picked wrapper if this is a picked list. */
-        if( screen->m_BlockLocate.m_Command != BLOCK_PASTE )
+        if( screen->m_BlockLocate.GetCommand() != BLOCK_PASTE )
             screen->m_BlockLocate.ClearItemsList();
     }
 
-    screen->m_BlockLocate.m_State = STATE_NO_BLOCK;
-    screen->m_BlockLocate.m_Command = BLOCK_ABORT;
-    Panel->GetParent()->HandleBlockEnd( DC );
+    screen->m_BlockLocate.SetState( STATE_NO_BLOCK );
+    screen->m_BlockLocate.SetCommand( BLOCK_ABORT );
+    aPanel->GetParent()->HandleBlockEnd( aDC );
 
-    screen->m_BlockLocate.m_Command = BLOCK_IDLE;
-    Panel->GetParent()->DisplayToolMsg( wxEmptyString );
-    Panel->SetCursor( (wxStockCursor) Panel->GetCurrentCursor() );
+    screen->m_BlockLocate.SetCommand( BLOCK_IDLE );
+    aPanel->GetParent()->DisplayToolMsg( wxEmptyString );
+    aPanel->SetCursor( (wxStockCursor) aPanel->GetCurrentCursor() );
 }