wxVector<T> is header-based, use @nolibrary

[wxWidgets.git] / docs / doxygen / overviews / dataobject.h

diff --git a/docs/doxygen/overviews/dataobject.h b/docs/doxygen/overviews/dataobject.h
index bf84f293b5e1681c273569151ad5319f4312db6a..18d5d7180383794e5b727d16e782ba4843c145a1 100644 (file)
--- a/docs/doxygen/overviews/dataobject.h
+++ b/docs/doxygen/overviews/dataobject.h
@@ -6,13 +6,13 @@
 // Licence:     wxWindows license
 /////////////////////////////////////////////////////////////////////////////
 
-/*!
+/**
 
- @page overview_dataobject wxDataObject overview
+ @page overview_dataobject wxDataObject Overview
 
- Classes: #wxDataObject, #wxClipboard, #wxDataFormat, #wxDropSource, #wxDropTarget
+ Classes: wxDataObject, wxClipboard, wxDataFormat, wxDropSource, wxDropTarget
 
- See also: @ref overview_dnd and @ref overview_samplednd
+ See also: @ref overview_dnd and @ref page_utils_samples_dnd
 
  This overview discusses data transfer through clipboard or drag and drop.
  In wxWidgets, these two ways to transfer data (either between different
@@ -22,7 +22,7 @@
  clipboard support for free and vice versa.
 
  At the heart of both clipboard and drag and drop operations lies the
- #wxDataObject class. The objects of this class (or, to
+ wxDataObject class. The objects of this class (or, to
  be precise, classes derived from it) represent the data which is being carried
  by the mouse during drag and drop operation or copied to or pasted from the
  clipboard. wxDataObject is a "smart" piece of data because it knows which
@@ -37,41 +37,44 @@
  one position to another in a word processor. Let us describe what each of them
  should do.
 
- @li The data provider (source) duties
- @li The data receiver (target) duties
+ @li @ref overview_dataobject_source
+ @li @ref overview_dataobject_target
+
+
+ <hr>
 
 
  @section overview_dataobject_source The data provider (source) duties
 
- The data provider is responsible for creating a #wxDataObject containing the 
+ The data provider is responsible for creating a wxDataObject containing the
  data to be transferred. Then it should either pass it to the clipboard using
- #SetData function or to #wxDropSource and call #DoDragDrop function.
+ wxClipboard::SetData function or to wxDropSource and call wxDropSource::DoDragDrop
+ function.
 
  The only (but important) difference is that the object for the clipboard
  transfer must always be created on the heap (i.e. using @c new) and it will
  be freed by the clipboard when it is no longer needed (indeed, it is not known
  in advance when, if ever, the data will be pasted from the clipboard). On the
  other hand, the object for drag and drop operation must only exist while
- #DoDragDrop executes and may be safely deleted afterwards and so can be 
- created either on heap or on stack (i.e. as a local variable).
+ wxDropSource::DoDragDrop executes and may be safely deleted afterwards and so
+ can be created either on heap or on stack (i.e. as a local variable).
 
  Another small difference is that in the case of clipboard operation, the
  application usually knows in advance whether it copies or cuts (i.e. copies and
  deletes) data - in fact, this usually depends on which menu item the user
  chose. But for drag and drop it can only know it after
- #DoDragDrop returns (from its return value).
+ wxDropSource::DoDragDrop returns (from its return value).
 
 
  @section overview_dataobject_target The data receiver (target) duties
 
  To receive (paste in usual terminology) data from the clipboard, you should
- create a #wxDataObject derived class which supports the data formats you need 
+ create a wxDataObject derived class which supports the data formats you need
  and pass it as argument to wxClipboard::GetData. If it returns @false,
-
- no data in (any of) the supported format(s) is available. If it returns @true, 
+ no data in (any of) the supported format(s) is available. If it returns @true,
  the data has been successfully transferred to wxDataObject.
 
- For drag and drop case, the wxDropTarget::OnData virtual function will be called 
+ For drag and drop case, the wxDropTarget::OnData virtual function will be called
  when a data object is dropped, from which the data itself may be requested by calling
  wxDropTarget::GetData method which fills the data object.