Klasa COleDataSource

Artykuł
10/12/2023

Działa jako pamięć podręczna, w której aplikacja umieszcza dane, które będą oferowane podczas operacji transferu danych, takich jak Schowek lub operacje przeciągania i upuszczania.

Składnia

class COleDataSource : public CCmdTarget

Członkowie

Konstruktory publiczne

Nazwa/nazwisko	opis
COleDataSource::COleDataSource	`COleDataSource` Tworzy obiekt.

Metody publiczne

Nazwa/nazwisko	opis
COleDataSource::CacheData	Oferuje dane w określonym formacie przy użyciu `STGMEDIUM` struktury.
COleDataSource::CacheGlobalData	Oferuje dane w określonym formacie przy użyciu biblioteki HGLOBAL.
COleDataSource::D elayRenderData	Oferuje dane w określonym formacie przy użyciu opóźnionego renderowania.
COleDataSource::D elayRenderFileData	Oferuje dane w określonym formacie w wskaźniku `CFile` .
COleDataSource::D elaySetData	Wywoływane dla każdego formatu obsługiwanego w programie `OnSetData`.
COleDataSource::D oDragDrop	Wykonuje operacje przeciągania i upuszczania ze źródłem danych.
COleDataSource::Empty	Opróżnia `COleDataSource` obiekt danych.
COleDataSource::FlushClipboard	Renderuje wszystkie dane do Schowka.
COleDataSource::GetClipboardOwner	Sprawdza, czy dane umieszczone w Schowku są nadal dostępne.
COleDataSource::OnRenderData	Pobiera dane w ramach opóźnionego renderowania.
COleDataSource::OnRenderFileData	Pobiera dane do elementu w `CFile` ramach opóźnionego renderowania.
COleDataSource::OnrenderGlobalData	Pobiera dane do elementu HGLOBAL w ramach opóźnionego renderowania.
COleDataSource::OnSetData	Wywołana funkcja w celu zastąpienia danych w `COleDataSource` obiekcie.
COleDataSource::SetClipboard	`COleDataSource` Umieszcza obiekt w Schowku.

Uwagi

Źródła danych OLE można tworzyć bezpośrednio. Alternatywnie klasy COleClientItem i COleServerItem tworzą źródła danych OLE w odpowiedzi na ich CopyToClipboard funkcje składowe i DoDragDrop . Aby uzyskać krótki opis, zobacz COleServerItem::CopyToClipboard . Zastąpi OnGetClipboardData funkcję składową elementu klienta lub klasy elementu serwera, aby dodać dodatkowe formaty Schowka do danych w źródle danych OLE utworzonym dla CopyToClipboard funkcji składowej lub DoDragDrop .

Za każdym razem, gdy chcesz przygotować dane do transferu, należy utworzyć obiekt tej klasy i wypełnić je danymi przy użyciu najbardziej odpowiedniej metody dla danych. Sposób ich wstawienia do źródła danych ma bezpośredni wpływ na to, czy dane są dostarczane natychmiast (renderowanie natychmiastowe) czy na żądanie (opóźnione renderowanie). Dla każdego formatu Schowka, w którym podajesz dane, przekazując format Schowka do użycia (i opcjonalną strukturę FORMATETC ), wywołaj metodę DelayRenderData.

Aby uzyskać więcej informacji na temat źródeł danych i transferu danych, zobacz artykuł Obiekty danych i źródła danych (OLE). Ponadto w artykule Clipboard Topics (Tematy schowka) opisano mechanizm Schowka OLE.

Hierarchia dziedziczenia

Cobject

Ccmdtarget

COleDataSource

Wymagania

Nagłówek: afxole.h

COleDataSource::CacheData

Wywołaj tę funkcję, aby określić format, w którym dane są oferowane podczas operacji transferu danych.

void CacheData(
    CLIPFORMAT cfFormat,
    LPSTGMEDIUM lpStgMedium,
    LPFORMATETC lpFormatEtc = NULL);

Parametry

cfFormat
Format Schowka, w którym mają być oferowane dane. Ten parametr może być jednym ze wstępnie zdefiniowanych formatów Schowka lub wartością zwracaną przez natywną funkcję RegisterClipboardFormat systemu Windows.

lpStgMedium
Wskazuje strukturę STGMEDIUM zawierającą dane w określonym formacie.

lpFormatEtc
Wskazuje strukturę FORMATETC opisującą format, w którym mają być oferowane dane. Podaj wartość tego parametru, jeśli chcesz określić dodatkowe informacje o formacie poza formatem Schowka określonym przez cfFormat. Jeśli ma wartość NULL, wartości domyślne są używane dla innych pól w FORMATETC strukturze.

Uwagi

Musisz podać dane, ponieważ ta funkcja udostępnia je przy użyciu natychmiastowego renderowania. Dane są buforowane do momentu, gdy będą potrzebne.

Podaj dane przy użyciu struktury STGMEDIUM . Możesz również użyć funkcji składowej CacheGlobalData , jeśli ilość danych, które podajesz, jest wystarczająco mała, aby można było wydajnie przesyłać przy użyciu biblioteki HGLOBAL.

Po wywołaniu CacheDataptd elementu członkowskiego lpFormatEtc i zawartości lpStgMedium są własnością obiektu danych, a nie przez obiekt wywołujący.

Aby użyć renderowania opóźnionego, wywołaj funkcję elementu członkowskiego DelayRenderData lub DelayRenderFileData . Aby uzyskać więcej informacji na temat opóźnionego renderowania obsługiwanego przez MFC, zobacz artykuł Data Objects and Data Sources: Manipulation (Obiekty danych i źródła danych: manipulowanie).

Aby uzyskać więcej informacji, zobacz struktury STGMEDIUM i FORMATETC w zestawie Windows SDK.

Aby uzyskać więcej informacji, zobacz RegisterClipboardFormat w zestawie Windows SDK.

COleDataSource::CacheGlobalData

Wywołaj tę funkcję, aby określić format, w którym dane są oferowane podczas operacji transferu danych.

void CacheGlobalData(
    CLIPFORMAT cfFormat,
    HGLOBAL hGlobal,
    LPFORMATETC lpFormatEtc = NULL);

Parametry

Hglobal
Dojmij do globalnego bloku pamięci zawierającego dane w określonym formacie.

Uwagi

Ta funkcja udostępnia dane przy użyciu natychmiastowego renderowania, dlatego podczas wywoływania funkcji należy podać dane. dane są buforowane do momentu, gdy będą potrzebne. Użyj funkcji składowej CacheData , jeśli dostarczasz dużą ilość danych lub jeśli potrzebujesz nośnika magazynu ustrukturyzowanego.

Aby uzyskać więcej informacji, zobacz strukturę FORMATETC w zestawie Windows SDK.

Aby uzyskać więcej informacji, zobacz RegisterClipboardFormat w zestawie Windows SDK.

COleDataSource::COleDataSource

COleDataSource Tworzy obiekt.

COleDataSource();

COleDataSource::D elayRenderData

Wywołaj tę funkcję, aby określić format, w którym dane są oferowane podczas operacji transferu danych.

void DelayRenderData(
    CLIPFORMAT cfFormat,
    LPFORMATETC lpFormatEtc = NULL);

Parametry

Uwagi

Ta funkcja udostępnia dane przy użyciu opóźnionego renderowania, więc dane nie są dostarczane natychmiast. Funkcja składowa OnRenderData lub OnRenderGlobalData jest wywoływana w celu żądania danych.

Użyj tej funkcji, jeśli nie zamierzasz dostarczać danych za pośrednictwem CFile obiektu. Jeśli zamierzasz dostarczyć dane za pośrednictwem obiektu, wywołaj funkcję składową CFile DelayRenderFileData. Aby uzyskać więcej informacji na temat opóźnionego renderowania obsługiwanego przez MFC, zobacz artykuł Data Objects and Data Sources: Manipulation (Obiekty danych i źródła danych: manipulowanie).

Aby użyć natychmiastowego renderowania, wywołaj funkcję składową CacheData lub CacheGlobalData .

Aby uzyskać więcej informacji, zobacz strukturę FORMATETC w zestawie Windows SDK.

Aby uzyskać więcej informacji, zobacz RegisterClipboardFormat w zestawie Windows SDK.

COleDataSource::D elayRenderFileData

Wywołaj tę funkcję, aby określić format, w którym dane są oferowane podczas operacji transferu danych.

void DelayRenderFileData(
    CLIPFORMAT cfFormat,
    LPFORMATETC lpFormatEtc = NULL);

Parametry

Uwagi

Ta funkcja udostępnia dane przy użyciu opóźnionego renderowania, więc dane nie są dostarczane natychmiast. Funkcja składowa OnRenderFileData jest wywoływana w celu żądania danych.

Użyj tej funkcji, jeśli zamierzasz użyć CFile obiektu do dostarczania danych. Jeśli nie zamierzasz używać CFile obiektu, wywołaj funkcję składową DelayRenderData . Aby uzyskać więcej informacji na temat opóźnionego renderowania obsługiwanego przez MFC, zobacz artykuł Data Objects and Data Sources: Manipulation (Obiekty danych i źródła danych: manipulowanie).

Aby użyć natychmiastowego renderowania, wywołaj funkcję składową CacheData lub CacheGlobalData .

Aby uzyskać więcej informacji, zobacz strukturę FORMATETC w zestawie Windows SDK.

Aby uzyskać więcej informacji, zobacz RegisterClipboardFormat w zestawie Windows SDK.

COleDataSource::D elaySetData

Wywołaj tę funkcję, aby obsługiwać zmianę zawartości źródła danych.

void DelaySetData(
    CLIPFORMAT cfFormat,
    LPFORMATETC lpFormatEtc = NULL);

Parametry

cfFormat
Format Schowka, w którym mają zostać umieszczone dane. Ten parametr może być jednym ze wstępnie zdefiniowanych formatów Schowka lub wartością zwracaną przez natywną funkcję RegisterClipboardFormat systemu Windows.

lpFormatEtc
Wskazuje strukturę FORMATETC opisującą format, w którym dane mają zostać zastąpione. Podaj wartość tego parametru, jeśli chcesz określić dodatkowe informacje o formacie poza formatem Schowka określonym przez cfFormat. Jeśli ma wartość NULL, wartości domyślne są używane dla innych pól w FORMATETC strukturze.

Uwagi

W takim przypadku funkcja OnSetData będzie wywoływana przez platformę. Jest to używane tylko wtedy, gdy platforma zwraca źródło danych z COleServerItem::GetDataSource. Jeśli DelaySetData nie zostanie wywołana, OnSetData funkcja nigdy nie zostanie wywołana. DelaySetData powinien być wywoływany dla każdego schowka lub FORMATETC obsługiwanego formatu.

Aby uzyskać więcej informacji, zobacz strukturę FORMATETC w zestawie Windows SDK.

Aby uzyskać więcej informacji, zobacz RegisterClipboardFormat w zestawie Windows SDK.

COleDataSource::D oDragDrop

Wywołaj DoDragDrop funkcję składową, aby wykonać operację przeciągania i upuszczania dla tego źródła danych, zazwyczaj w procedurze obsługi CWnd::OnLButtonDown .

DROPEFFECT DoDragDrop(
    DWORD dwEffects = DROPEFFECT_COPY|DROPEFFECT_MOVE|DROPEFFECT_LINK,
    LPCRECT lpRectStartDrag = NULL,
    COleDropSource* pDropSource = NULL);

Parametry

dwEffects
Operacje przeciągania i upuszczania dozwolone w tym źródle danych. Może to być co najmniej jeden z następujących elementów:

DROPEFFECT_COPY Można wykonać operację kopiowania.
DROPEFFECT_MOVE Można wykonać operację przenoszenia.
DROPEFFECT_LINK Można ustanowić link z porzuconych danych do oryginalnych danych.
DROPEFFECT_SCROLL Wskazuje, że może wystąpić operacja przeciągania przewijania.

lpRectStartDrag
Wskaźnik do prostokąta, który definiuje, gdzie faktycznie rozpoczyna się przeciąganie. Aby uzyskać więcej informacji zobacz następujące sekcji uwag.

pDropSource
Wskazuje źródło upuszczania. Jeśli wartość NULL, zostanie użyta domyślna implementacja COleDropSource .

Wartość zwracana

Efekt upuszczania generowany przez operację przeciągania i upuszczania; w przeciwnym razie DROPEFFECT_NONE, jeśli operacja nigdy nie rozpoczyna się, ponieważ użytkownik zwolnił przycisk myszy przed opuszczeniem podanego prostokąta.

Uwagi

Operacja przeciągania i upuszczania nie rozpoczyna się natychmiast. Czeka, aż kursor myszy opuści prostokąt określony przez lpRectStartDrag lub do momentu, aż zostanie przekazana określona liczba milisekund. Jeśli parametr lpRectStartDrag ma wartość NULL, rozmiar prostokąta to jeden piksel.

Czas opóźnienia jest określany przez ustawienie klucza rejestru. Czas opóźnienia można zmienić, wywołując polecenie CWinApp::WriteProfileString lub CWinApp::WriteProfileInt. Jeśli nie określisz czasu opóźnienia, zostanie użyta wartość domyślna 200 milisekund. Czas opóźnienia przeciągania jest przechowywany w następujący sposób:

Czas opóźnienia przeciągania systemu Windows NT jest przechowywany w HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\NT\CurrentVersion\IniFileMapping\win.ini\Windows\DragDelay.
Czas opóźnienia przeciągania systemu Windows 3.x jest przechowywany w win. Plik INI w sekcji [Windows}.
Czas opóźnienia przeciągania systemu Windows 95/98 jest przechowywany w buforowanej wersji win. INI.

Aby uzyskać więcej informacji na temat sposobu przechowywania informacji o opóźnieniu przeciągania w rejestrze lub obiekcie . Plik INI, zobacz WriteProfileString w zestawie Windows SDK.

Aby uzyskać więcej informacji, zobacz artykuł Przeciąganie i upuszczanie OLE.

COleDataSource::Empty

Wywołaj tę funkcję, aby opróżnić COleDataSource obiekt danych.

void Empty();

Uwagi

Zarówno buforowane, jak i opóźnione formaty renderowania są opróżniane, aby można je było ponownie użyć.

Aby uzyskać więcej informacji, zobacz ReleaseStgMedium w zestawie Windows SDK.

COleDataSource::FlushClipboard

Renderuje dane, które są w Schowku, a następnie umożliwia wklejanie danych ze Schowka po zamknięciu aplikacji.

static void PASCAL FlushClipboard();

Uwagi

Użyj polecenia SetClipboard , aby umieścić dane w Schowku.

COleDataSource::GetClipboardOwner

Określa, czy dane w Schowku uległy zmianie od czasu ostatniego wywołania tablicy SetClipboard , a jeśli tak, identyfikuje bieżącego właściciela.

static COleDataSource* PASCAL GetClipboardOwner();

Wartość zwracana

Źródło danych aktualnie w Schowku lub wartość NULL, jeśli w Schowku nie ma nic lub jeśli schowek nie jest własnością aplikacji wywołującej.

COleDataSource::OnRenderData

Wywoływana przez platformę w celu pobrania danych w określonym formacie.

virtual BOOL OnRenderData(
    LPFORMATETC lpFormatEtc,
    LPSTGMEDIUM lpStgMedium);

Parametry

lpFormatEtc
Wskazuje strukturę FORMATETC określającą format, w którym są żądane informacje.

lpStgMedium
Wskazuje strukturę STGMEDIUM, w której dane mają być zwracane.

Wartość zwracana

Bezzerowe, jeśli się powiedzie; w przeciwnym razie 0.

Uwagi

Określony format jest wcześniej umieszczony w COleDataSource obiekcie przy użyciu funkcji elementu członkowskiego DelayRenderData lub DelayRenderFileData na potrzeby opóźnionego renderowania. Domyślna implementacja tej funkcji wywoła metodę OnRenderFileData lub OnRenderGlobalData , jeśli podany nośnik magazynu jest odpowiednio plikiem lub pamięcią. Jeśli żaden z tych formatów nie zostanie podany, domyślna implementacja zwróci wartość 0 i nic nie zrobi. Aby uzyskać więcej informacji na temat opóźnionego renderowania obsługiwanego przez MFC, zobacz artykuł Data Objects and Data Sources: Manipulation (Obiekty danych i źródła danych: manipulowanie).

Jeśli lpStgMedium-tymed> jest TYMED_NULL, STGMEDIUM należy przydzielić i wypełnić zgodnie z lpFormatEtc-tymed.> Jeśli nie jest TYMED_NULL, STGMEDIUM należy je wypełnić danymi.

Aby uzyskać więcej informacji, zobacz struktury STGMEDIUM i FORMATETC , typ wyliczania TYMED i IDataObject::GetData w zestawie SDK systemu Windows.

COleDataSource::OnRenderFileData

Wywoływana przez platformę w celu pobrania danych w określonym formacie, gdy określony nośnik magazynu jest plikiem.

virtual BOOL OnRenderFileData(
    LPFORMATETC lpFormatEtc,
    CFile* pFile);

Parametry

lpFormatEtc
Wskazuje strukturę FORMATETC określającą format, w którym są żądane informacje.

plik pFile
Wskazuje obiekt CFile, w którym dane mają być renderowane.

Wartość zwracana

Bezzerowe, jeśli się powiedzie; w przeciwnym razie 0.

Uwagi

Określony format jest wcześniej umieszczony w COleDataSource obiekcie przy użyciu funkcji składowej DelayRenderData na potrzeby opóźnionego renderowania. Domyślna implementacja tej funkcji po prostu zwraca wartość FALSE.

Jest to zaawansowane przesłonięcia. Zastąpi tę funkcję, aby dostarczyć dane w żądanym formacie i nośniku. W zależności od danych warto zastąpić jedną z pozostałych wersji tej funkcji. Jeśli chcesz obsłużyć wiele nośników magazynu, zastąp wartość OnRenderData. Jeśli dane są w pliku lub mają zmienny rozmiar, przesłoń OnRenderFileDatawartość . Aby uzyskać więcej informacji na temat opóźnionego renderowania obsługiwanego przez MFC, zobacz artykuł Data Objects and Data Sources: Manipulation (Obiekty danych i źródła danych: manipulowanie).

Aby uzyskać więcej informacji, zobacz strukturę FORMATETC i IDataObject::GetData w zestawie WINDOWS SDK.

COleDataSource::OnrenderGlobalData

Wywoływana przez platformę w celu pobrania danych w określonym formacie, gdy określony nośnik magazynu jest pamięcią globalną.

virtual BOOL OnRenderGlobalData(
    LPFORMATETC lpFormatEtc,
    HGLOBAL* phGlobal);

Parametry

lpFormatEtc
Wskazuje strukturę FORMATETC określającą format, w którym są żądane informacje.

phGlobal
Wskazuje dojście do pamięci globalnej, w której dane mają być zwracane. Jeśli jeszcze go nie przydzielono, ten parametr może mieć wartość NULL.

Wartość zwracana

Bezzerowe, jeśli się powiedzie; w przeciwnym razie 0.

Uwagi

Jeśli fraza phGlobal ma wartość NULL, należy przydzielić i zwrócić nową frazę HGLOBAL. W przeciwnym razie parametr HGLOBAL określony przez frazę phGlobal powinien być wypełniony danymi. Ilość danych umieszczonych w HGLOBAL nie może przekraczać bieżącego rozmiaru bloku pamięci. Ponadto nie można ponownie przydzielić bloku do większego rozmiaru.

Jest to zaawansowane przesłonięcia. Zastąpi tę funkcję, aby dostarczyć dane w żądanym formacie i nośniku. W zależności od danych możesz zastąpić jedną z pozostałych wersji tej funkcji. Jeśli chcesz obsłużyć wiele nośników magazynu, zastąp wartość OnRenderData. Jeśli dane są w pliku lub mają zmienny rozmiar, zastąp wartość OnRenderFileData. Aby uzyskać więcej informacji na temat opóźnionego renderowania obsługiwanego przez MFC, zobacz artykuł Data Objects and Data Sources: Manipulation (Obiekty danych i źródła danych: manipulowanie).

Aby uzyskać więcej informacji, zobacz strukturę FORMATETC i IDataObject::GetData w zestawie WINDOWS SDK.

COleDataSource::OnSetData

Wywoływana przez platformę w celu ustawienia lub zastąpienia danych w COleDataSource obiekcie w określonym formacie.

virtual BOOL OnSetData(
    LPFORMATETC lpFormatEtc,
    LPSTGMEDIUM lpStgMedium,
    BOOL bRelease);

Parametry

lpFormatEtc
Wskazuje strukturę FORMATETC określającą format, w którym dane są zastępowane.

lpStgMedium
Wskazuje strukturę STGMEDIUM zawierającą dane, które zastąpią bieżącą zawartość COleDataSource obiektu.

Brelease
Wskazuje, kto ma własność nośnika magazynu po zakończeniu wywołania funkcji. Wywołujący decyduje, kto jest odpowiedzialny za wydawanie zasobów przydzielonych w imieniu nośnika magazynu. Obiekt wywołujący robi to, ustawiając wartość bRelease. Jeśli wersja bRelease jest niezerowa, źródło danych przejmuje własność, zwalniając nośnik po zakończeniu korzystania z niego. Jeśli wersję bRelease to 0, obiekt wywołujący zachowuje własność, a źródło danych może używać nośnika magazynu tylko przez czas trwania wywołania.

Wartość zwracana

Bezzerowe, jeśli się powiedzie; w przeciwnym razie 0.

Uwagi

Źródło danych nie przejmuje własności danych, dopóki nie zostanie pomyślnie uzyskane. Oznacza to, że nie przejmuje własności, jeśli OnSetData zwraca wartość 0. Jeśli źródło danych przejmuje własność, zwalnia nośnik magazynu przez wywołanie funkcji ReleaseStgMedium .

Domyślna implementacja nic nie robi. Zastąp tę funkcję, aby zastąpić dane w określonym formacie. Jest to zaawansowane przesłonięcia.

Aby uzyskać więcej informacji, zobacz struktury STGMEDIUM i FORMATETC oraz funkcje ReleaseStgMedium i IDataObject::GetData w zestawie WINDOWS SDK.

COleDataSource::SetClipboard

Umieszcza dane zawarte w obiekcie w COleDataSource Schowku po wywołaniu jednej z następujących funkcji: CacheData, CacheGlobalData, DelayRenderData lub DelayRenderFileData.

void SetClipboard();

Zobacz też

Przykład MFC HIERSVR
Przykład MFC OCLIENT
Klasa CCmdTarget
Wykres hierarchii
Klasa COleDataObject

Klasa COleDataSource

Składnia

Członkowie

Konstruktory publiczne

Metody publiczne

Uwagi

Hierarchia dziedziczenia

Wymagania

COleDataSource::CacheData

Parametry

Uwagi

COleDataSource::CacheGlobalData

Parametry

Uwagi

COleDataSource::COleDataSource

COleDataSource::D elayRenderData

Parametry

Uwagi

COleDataSource::D elayRenderFileData

Parametry

Uwagi

COleDataSource::D elaySetData

Parametry

Uwagi

COleDataSource::D oDragDrop

Parametry

Wartość zwracana

Uwagi

COleDataSource::Empty

Uwagi

COleDataSource::FlushClipboard

Uwagi

COleDataSource::GetClipboardOwner

Wartość zwracana

COleDataSource::OnRenderData

Parametry

Wartość zwracana

Uwagi

COleDataSource::OnRenderFileData

Parametry

Wartość zwracana

Uwagi

COleDataSource::OnrenderGlobalData

Parametry

Wartość zwracana

Uwagi

COleDataSource::OnSetData

Parametry

Wartość zwracana

Uwagi

COleDataSource::SetClipboard

Zobacz też

Opinia

Opinia

Dodatkowe zasoby