PICKED_ITEMS_LIST Class Reference

A holder to handle information on schematic or board items. More...

#include <undo_redo_container.h>

Public Member Functions
	PICKED_ITEMS_LIST ()
	~PICKED_ITEMS_LIST ()
void	PushItem (const ITEM_PICKER &aItem)
	Push aItem to the top of the list. More...
ITEM_PICKER	PopItem ()
bool	ContainsItem (const EDA_ITEM *aItem) const
int	FindItem (const EDA_ITEM *aItem) const
void	ClearItemsList ()
	Delete only the list of pickers NOT the picked data itself. More...
void	ClearListAndDeleteItems (std::function< void(EDA_ITEM *)> aItemDeleter)
	Delete the list of pickers AND the data pointed by #m_PickedItem or #m_PickedItemLink according to the type of undo/redo command recorded. More...
unsigned	GetCount () const
void	ReversePickersListOrder ()
	Reverse the order of pickers stored in this list. More...
ITEM_PICKER	GetItemWrapper (unsigned int aIdx) const
EDA_ITEM *	GetPickedItem (unsigned int aIdx) const
BASE_SCREEN *	GetScreenForItem (unsigned int aIdx) const
EDA_ITEM *	GetPickedItemLink (unsigned int aIdx) const
UNDO_REDO	GetPickedItemStatus (unsigned int aIdx) const
EDA_ITEM_FLAGS	GetPickerFlags (unsigned aIdx) const
	Return the value of the picker flag. More...
bool	SetPickedItem (EDA_ITEM *aItem, unsigned aIdx)
bool	SetPickedItem (EDA_ITEM *aItem, UNDO_REDO aStatus, unsigned aIdx)
bool	SetPickedItemLink (EDA_ITEM *aLink, unsigned aIdx)
	Set the link associated to a given picked item. More...
bool	SetPickedItemStatus (UNDO_REDO aStatus, unsigned aIdx)
	Set the type of undo/redo operation for a given picked item. More...
bool	SetPickerFlags (EDA_ITEM_FLAGS aFlags, unsigned aIdx)
	Set the flags of the picker (usually to the picked item m_flags value). More...
bool	RemovePicker (unsigned aIdx)
	Remove one entry (one picker) from the list of picked items. More...
void	CopyList (const PICKED_ITEMS_LIST &aSource)
	Copy all data from aSource to the list. More...

Private Attributes
std::vector< ITEM_PICKER >	m_ItemsList

Detailed Description

A holder to handle information on schematic or board items.

The information held is a pointer on each item, and the command made.

Definition at line 133 of file undo_redo_container.h.

Constructor & Destructor Documentation

PICKED_ITEMS_LIST()

PICKED_ITEMS_LIST::PICKED_ITEMS_LIST

(

)

Definition at line 57 of file undo_redo_container.cpp.

{
}

~PICKED_ITEMS_LIST()

PICKED_ITEMS_LIST::~PICKED_ITEMS_LIST

(

)

Definition at line 62 of file undo_redo_container.cpp.

{
}

Member Function Documentation

ClearItemsList()

void PICKED_ITEMS_LIST::ClearItemsList

(

)

Delete only the list of pickers NOT the picked data itself.

Definition at line 111 of file undo_redo_container.cpp.

{
 m_ItemsList.clear();
}

References m_ItemsList.

Referenced by PCB_EDIT_FRAME::Edit_Zone_Params(), PCB_BASE_FRAME::PlaceFootprint(), and PCB_EDIT_FRAME::RunActionPlugin().

ClearListAndDeleteItems()

void PICKED_ITEMS_LIST::ClearListAndDeleteItems

(

std::function< void(EDA_ITEM *)>

aItemDeleter

)

Delete the list of pickers AND the data pointed by #m_PickedItem or #m_PickedItemLink according to the type of undo/redo command recorded.

Definition at line 117 of file undo_redo_container.cpp.

{
 while( GetCount() > 0 )
 {
 ITEM_PICKER wrapper = PopItem();
 
 if( wrapper.GetItem() == nullptr ) // No more items in list.
 break;
 
 // The Link is an undo construct; it is always owned by the undo/redo container
 if( wrapper.GetLink() )
 aItemDeleter( wrapper.GetLink() );
 
 if( wrapper.GetFlags() & UR_TRANSIENT )
 {
 aItemDeleter( wrapper.GetItem() );
 }
 else if( wrapper.GetStatus() == UNDO_REDO::DELETED )
 {
 // This should really be replaced with UR_TRANSIENT, but currently many clients
 // (eeschema in particular) abuse this to achieve non-undo-related deletions.
 aItemDeleter( wrapper.GetItem() );
 }
 }
}

References DELETED, GetCount(), ITEM_PICKER::GetFlags(), ITEM_PICKER::GetItem(), ITEM_PICKER::GetLink(), ITEM_PICKER::GetStatus(), PopItem(), and UR_TRANSIENT.

Referenced by PCB_BASE_EDIT_FRAME::ClearListAndDeleteItems(), SCH_EDIT_FRAME::ClearUndoORRedoList(), SYMBOL_EDIT_FRAME::ClearUndoORRedoList(), and PL_EDITOR_FRAME::ClearUndoORRedoList().

ContainsItem()

bool PICKED_ITEMS_LIST::ContainsItem

(

const EDA_ITEM *

aItem

)

const

Returns

True if aItem is found in the pick list.

Definition at line 87 of file undo_redo_container.cpp.

{
 for( const ITEM_PICKER& picker : m_ItemsList )
 {
 if( picker.GetItem() == aItem )
 return true;
 }
 
 return false;
}

References m_ItemsList.

Referenced by PCB_EDIT_FRAME::RunActionPlugin().

CopyList()

void PICKED_ITEMS_LIST::CopyList

(

const PICKED_ITEMS_LIST &

aSource

)

Copy all data from aSource to the list.

Items picked are not copied. just pointer in them are copied.

Parameters

aSource

The list of items to copy to the list.

Definition at line 271 of file undo_redo_container.cpp.

{
 m_ItemsList = aSource.m_ItemsList; // Vector's copy
}

References m_ItemsList.

Referenced by SCH_EDIT_FRAME::SaveCopyInUndoList().

FindItem()

int PICKED_ITEMS_LIST::FindItem

(

const EDA_ITEM *

aItem

)

const

Returns

Index of the searched item. If the item is not stored in the list, negative value is returned.

Definition at line 99 of file undo_redo_container.cpp.

{
 for( size_t i = 0; i < m_ItemsList.size(); i++ )
 {
 if( m_ItemsList[i].GetItem() == aItem )
 return i;
 }
 
 return -1;
}

References m_ItemsList.

Referenced by DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::processItem().

GetCount()

unsigned PICKED_ITEMS_LIST::GetCount ( ) const

inline

Returns

The count of pickers stored in this list.

Definition at line 179 of file undo_redo_container.h.

 {
 return m_ItemsList.size();
 }

References m_ItemsList.

Referenced by ClearListAndDeleteItems(), PCB_BASE_FRAME::PlaceFootprint(), SCH_EDIT_FRAME::PutDataInPreviousState(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), PCB_EDIT_FRAME::RunActionPlugin(), PCB_BASE_EDIT_FRAME::saveCopyInUndoList(), SCH_EDIT_FRAME::SaveCopyInUndoList(), COMMIT::Stage(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::TransferDataFromWindow(), and UpdateCopyOfZonesList().

GetItemWrapper()

ITEM_PICKER PICKED_ITEMS_LIST::GetItemWrapper

(

unsigned int

aIdx

)

const

Returns

The picker of a picked item.

Parameters

aIdx	Index of the picker in the picked list if this picker does not exist, a picker is returned, with its members set to 0 or NULL.

Definition at line 144 of file undo_redo_container.cpp.

{
 ITEM_PICKER picker;
 
 if( aIdx < m_ItemsList.size() )
 picker = m_ItemsList[aIdx];
 
 return picker;
}

References m_ItemsList.

Referenced by PCB_EDIT_FRAME::RunActionPlugin(), SCH_EDIT_FRAME::SaveCopyInUndoList(), PCB_BASE_EDIT_FRAME::saveCopyInUndoList(), and UpdateCopyOfZonesList().

GetPickedItem()

EDA_ITEM * PICKED_ITEMS_LIST::GetPickedItem

(

unsigned int

aIdx

)

const

Returns

A pointer to the picked item.

Parameters

aIdx	Index of the picked item in the picked list.

Definition at line 155 of file undo_redo_container.cpp.

{
 if( aIdx < m_ItemsList.size() )
 return m_ItemsList[aIdx].GetItem();
 
 return nullptr;
}

References m_ItemsList.

Referenced by SCH_EDIT_FRAME::PutDataInPreviousState(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), PCB_EDIT_FRAME::RunActionPlugin(), SCH_EDIT_FRAME::SaveCopyInUndoList(), PCB_BASE_EDIT_FRAME::saveCopyInUndoList(), COMMIT::Stage(), and UpdateCopyOfZonesList().

GetPickedItemLink()

EDA_ITEM * PICKED_ITEMS_LIST::GetPickedItemLink

(

unsigned int

aIdx

)

const

Returns

link of the picked item, or null if does not exist.

Parameters

aIdx	Index of the picked item in the picked list.

Definition at line 173 of file undo_redo_container.cpp.

{
 if( aIdx < m_ItemsList.size() )
 return m_ItemsList[aIdx].GetLink();
 
 return nullptr;
}

References m_ItemsList.

Referenced by SCH_EDIT_FRAME::PutDataInPreviousState(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), SCH_EDIT_FRAME::SaveCopyInUndoList(), PCB_BASE_EDIT_FRAME::saveCopyInUndoList(), COMMIT::Stage(), and UpdateCopyOfZonesList().

GetPickedItemStatus()

UNDO_REDO PICKED_ITEMS_LIST::GetPickedItemStatus

(

unsigned int

aIdx

)

const

Returns

The type of undo/redo operation associated to the picked item, or UNSPECIFIED if does not exist.

Parameters

aIdx	Index of the picked item in the picked list.

Definition at line 182 of file undo_redo_container.cpp.

{
 if( aIdx < m_ItemsList.size() )
 return m_ItemsList[aIdx].GetStatus();
 
 return UNDO_REDO::UNSPECIFIED;
}

References m_ItemsList, and UNSPECIFIED.

Referenced by SCH_EDIT_FRAME::PutDataInPreviousState(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), SCH_EDIT_FRAME::SaveCopyInUndoList(), PCB_BASE_EDIT_FRAME::saveCopyInUndoList(), COMMIT::Stage(), and UpdateCopyOfZonesList().

GetPickerFlags()

EDA_ITEM_FLAGS PICKED_ITEMS_LIST::GetPickerFlags

(

unsigned

aIdx

)

const

Return the value of the picker flag.

Parameters

aIdx	Index of the picker in the picked list.

Returns

The value stored in the picker, if the picker exists, or 0 if does not exist.

Definition at line 191 of file undo_redo_container.cpp.

{
 if( aIdx < m_ItemsList.size() )
 return m_ItemsList[aIdx].GetFlags();
 
 return 0;
}

References m_ItemsList.

Referenced by SCH_EDIT_FRAME::PutDataInPreviousState().

GetScreenForItem()

BASE_SCREEN * PICKED_ITEMS_LIST::GetScreenForItem

(

unsigned int

aIdx

)

const

Returns

A pointer to the picked item's screen.

Parameters

aIdx	Index of the picked item in the picked list.

Definition at line 164 of file undo_redo_container.cpp.

{
 if( aIdx < m_ItemsList.size() )
 return m_ItemsList[aIdx].GetScreen();
 
 return nullptr;
}

References m_ItemsList.

Referenced by SCH_EDIT_FRAME::PutDataInPreviousState().

PopItem()

ITEM_PICKER PICKED_ITEMS_LIST::PopItem

(

)

Returns

The picker removed from the top of the list.

Definition at line 73 of file undo_redo_container.cpp.

{
 ITEM_PICKER item;
 
 if( m_ItemsList.size() != 0 )
 {
 item = m_ItemsList.back();
 m_ItemsList.pop_back();
 }
 
 return item;
}

References m_ItemsList.

Referenced by ClearListAndDeleteItems(), PL_EDITOR_FRAME::GetLayoutFromRedoList(), PL_EDITOR_FRAME::GetLayoutFromUndoList(), SYMBOL_EDIT_FRAME::GetSymbolFromRedoList(), SYMBOL_EDIT_FRAME::GetSymbolFromUndoList(), PL_EDITOR_FRAME::RollbackFromUndo(), and SYMBOL_EDIT_FRAME::RollbackSymbolFromUndo().

PushItem()

void PICKED_ITEMS_LIST::PushItem

(

const ITEM_PICKER &

aItem

)

Push aItem to the top of the list.

Parameters

aItem

Picker to push on to the list.

Definition at line 67 of file undo_redo_container.cpp.

{
 m_ItemsList.push_back( aItem );
}

References m_ItemsList.

Referenced by BOARD::AddArea(), SCH_EDIT_FRAME::DeleteJunction(), SCH_LINE_WIRE_BUS_TOOL::finishSegments(), PL_EDITOR_FRAME::GetLayoutFromRedoList(), PL_EDITOR_FRAME::GetLayoutFromUndoList(), SYMBOL_EDIT_FRAME::GetSymbolFromRedoList(), SYMBOL_EDIT_FRAME::GetSymbolFromUndoList(), GROUP_TOOL::Group(), BOARD_EDITOR_CONTROL::PageSettings(), SCH_EDITOR_CONTROL::PageSetup(), PCB_BASE_FRAME::PlaceFootprint(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::processItem(), BOARD_COMMIT::Push(), PCB_EDIT_FRAME::RunActionPlugin(), PL_EDITOR_FRAME::SaveCopyInUndoList(), SYMBOL_EDIT_FRAME::SaveCopyInUndoList(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), PCB_BASE_EDIT_FRAME::saveCopyInUndoList(), SCH_EDIT_FRAME::SaveCopyInUndoList(), SaveCopyOfZones(), SCH_EDIT_FRAME::SchematicCleanUp(), PCB_EDIT_FRAME::SetTrackSegmentWidth(), DIALOG_JUNCTION_PROPS::TransferDataFromWindow(), DIALOG_LINE_PROPERTIES::TransferDataFromWindow(), DIALOG_WIRE_BUS_PROPERTIES::TransferDataFromWindow(), GROUP_TOOL::Ungroup(), and UpdateCopyOfZonesList().

RemovePicker()

bool PICKED_ITEMS_LIST::RemovePicker

(

unsigned

aIdx

)

Remove one entry (one picker) from the list of picked items.

Parameters

aIdx	Index of the picker in the picked list.

Returns

True if ok or false if did not exist.

Definition at line 261 of file undo_redo_container.cpp.

{
 if( aIdx >= m_ItemsList.size() )
 return false;
 
 m_ItemsList.erase( m_ItemsList.begin() + aIdx );
 return true;
}

References m_ItemsList.

Referenced by PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), and UpdateCopyOfZonesList().

ReversePickersListOrder()

void PICKED_ITEMS_LIST::ReversePickersListOrder

(

)

Reverse the order of pickers stored in this list.

This is useful when pop a list from Undo to Redo (and vice-versa) because sometimes undo (or redo) a command needs to keep the order of successive changes. Obviously, undo and redo are in reverse order

Definition at line 277 of file undo_redo_container.cpp.

{
 std::vector <ITEM_PICKER> tmp;
 
 while( !m_ItemsList.empty() )
 {
 tmp.push_back( m_ItemsList.back() );
 m_ItemsList.pop_back();
 }
 
 m_ItemsList.swap( tmp );
}

References m_ItemsList.

Referenced by SCH_EDITOR_CONTROL::Redo(), PCB_BASE_EDIT_FRAME::RestoreCopyFromRedoList(), PCB_BASE_EDIT_FRAME::RestoreCopyFromUndoList(), and SCH_EDITOR_CONTROL::Undo().

SetPickedItem() [1/2]

bool PICKED_ITEMS_LIST::SetPickedItem	(	EDA_ITEM *	aItem,
		UNDO_REDO	aStatus,
		unsigned	aIdx
	)

Parameters

aItem	A pointer to the item to pick.
aStatus	The type of undo/redo operation associated to the item to pick.
aIdx	Index of the picker in the picked list.

Returns

True if the picker exists or false if does not exist.

Definition at line 224 of file undo_redo_container.cpp.

{
 if( aIdx < m_ItemsList.size() )
 {
 m_ItemsList[aIdx].SetItem( aItem );
 m_ItemsList[aIdx].SetStatus( aStatus );
 return true;
 }
 
 return false;
}

References m_ItemsList.

SetPickedItem() [2/2]

bool PICKED_ITEMS_LIST::SetPickedItem	(	EDA_ITEM *	aItem,
		unsigned	aIdx
	)

Parameters

aItem	A pointer to the item to pick.
aIdx	Index of the picker in the picked list.

Returns

True if the picker exists or false if does not exist.

Definition at line 200 of file undo_redo_container.cpp.

{
 if( aIdx < m_ItemsList.size() )
 {
 m_ItemsList[aIdx].SetItem( aItem );
 return true;
 }
 
 return false;
}

References m_ItemsList.

Referenced by SCH_EDIT_FRAME::PutDataInPreviousState().

SetPickedItemLink()

bool PICKED_ITEMS_LIST::SetPickedItemLink	(	EDA_ITEM *	aLink,
		unsigned	aIdx
	)

Set the link associated to a given picked item.

Parameters

aLink	is the link to the item associated to the picked item.
aIdx	is index of the picker in the picked list.

Returns

true if the picker exists, or false if does not exist.

Definition at line 212 of file undo_redo_container.cpp.

{
 if( aIdx < m_ItemsList.size() )
 {
 m_ItemsList[aIdx].SetLink( aLink );
 return true;
 }
 
 return false;
}

References m_ItemsList.

Referenced by SCH_EDIT_FRAME::PutDataInPreviousState(), SCH_EDIT_FRAME::SaveCopyInUndoList(), PCB_BASE_EDIT_FRAME::saveCopyInUndoList(), and UpdateCopyOfZonesList().

SetPickedItemStatus()

bool PICKED_ITEMS_LIST::SetPickedItemStatus	(	UNDO_REDO	aStatus,
		unsigned	aIdx
	)

Set the type of undo/redo operation for a given picked item.

Parameters

aStatus	The type of undo/redo operation associated to the picked item
aIdx	Index of the picker in the picked list

Returns

True if the picker exists or false if does not exist

Definition at line 237 of file undo_redo_container.cpp.

{
 if( aIdx < m_ItemsList.size() )
 {
 m_ItemsList[aIdx].SetStatus( aStatus );
 return true;
 }
 
 return false;
}

References m_ItemsList.

Referenced by SCH_EDIT_FRAME::PutDataInPreviousState(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), SCH_EDIT_FRAME::SaveCopyInUndoList(), PCB_BASE_EDIT_FRAME::saveCopyInUndoList(), and UpdateCopyOfZonesList().

SetPickerFlags()

bool PICKED_ITEMS_LIST::SetPickerFlags	(	EDA_ITEM_FLAGS	aFlags,
		unsigned	aIdx
	)

Set the flags of the picker (usually to the picked item m_flags value).

Parameters

aFlags	The flag value to save in picker.
aIdx	Index of the picker in the picked list.

Returns

True if the picker exists or false if does not exist.

Definition at line 249 of file undo_redo_container.cpp.

{
 if( aIdx < m_ItemsList.size() )
 {
 m_ItemsList[aIdx].SetFlags( aFlags );
 return true;
 }
 
 return false;
}

References m_ItemsList.

Member Data Documentation

m_ItemsList

std::vector<ITEM_PICKER> PICKED_ITEMS_LIST::m_ItemsList

private

Definition at line 136 of file undo_redo_container.h.

Referenced by ClearItemsList(), ContainsItem(), CopyList(), FindItem(), GetCount(), GetItemWrapper(), GetPickedItem(), GetPickedItemLink(), GetPickedItemStatus(), GetPickerFlags(), GetScreenForItem(), PopItem(), PushItem(), RemovePicker(), ReversePickersListOrder(), SetPickedItem(), SetPickedItemLink(), SetPickedItemStatus(), and SetPickerFlags().

---

The documentation for this class was generated from the following files:

• undo_redo_container.h
• undo_redo_container.cpp