Classe CDockState
Uma classe CObject serializada que carrega, descarrega ou limpa o estado de uma ou mais barras de controle de encaixe na memória persistente (um arquivo).
Sintaxe
class CDockState : public CObject
Membros
Métodos públicos
| Nome | Descrição |
|---|---|
| CDockState::Clear | Limpa as informações do estado de encaixe. |
| CDockState::GetVersion | Recupera o número de versão do estado da barra armazenada. |
| CDockState::LoadState | Recupera informações de estado do registro ou do arquivo .INI. |
| CDockState::SaveState | Salva informações de estado para o registro ou arquivo .INI. |
Membros de Dados Públicos
| Nome | Descrição |
|---|---|
| CDockState::m_arrBarInfo | Matriz de ponteiros para as informações de estado de encaixe armazenado com uma entrada para cada barra de controle. |
Comentários
O estado de encaixe inclui o tamanho e a posição da barra e se ela está encaixada ou não. Ao recuperar o estado de encaixe armazenado, CDockState verifica a posição da barra e, se a barra não estiver visível com as configurações de tela atuais, CDockState dimensiona a posição da barra para que ela fique visível. A principal finalidade de CDockState é preservar todo o estado de várias barras de controle e permitir que esse estado seja salvo e carregado no registro, no arquivo .INI do aplicativo ou em forma binária como parte do conteúdo de um objeto CArchive.
A barra pode ser qualquer barra de controle encaixável, incluindo uma barra de ferramentas, uma barra de status ou uma barra de diálogo. Objetos CDockState são gravados e lidos de ou para um arquivo por meio de um objeto CArchive.
CFrameWnd::GetDockState recupera as informações de estado de todos os objetos CControlBar da janela de quadro e coloca-as no objeto CDockState. Em seguida, você pode gravar o conteúdo do objeto CDockState no armazenamento com Serialize ou CDockState::SaveState. Se você quiser restaurar o estado das barras de controle na janela de quadros, poderá carregar o estado com Serialize ou cDockState::LoadState e, em seguida, usar CFrameWnd::SetDockState para aplicar o estado salvo às barras de controle da janela de quadro.
Para obter mais informações sobre barras de controle de encaixe, consulte os artigos Barras de Controle, Barras de Ferramentas: Encaixe e Flutuante e Janelas de quadro.
Hierarquia de herança
CDockState
Requisitos
Cabeçalho: afxadv.h
CDockState::Clear
Chame essa função para limpar todas as informações de encaixe armazenadas no objeto CDockState.
void Clear();
Comentários
Isso inclui não apenas se a barra está encaixada ou não, mas o tamanho e a posição da barra e se ela está ou não visível.
CDockState::GetVersion
Chame essa função para recuperar o número de versão do estado de barra armazenado.
DWORD GetVersion();
Valor de retorno
1 se as informações da barra armazenada forem mais antigas do que o estado da barra atual; 2 se as informações da barra armazenada forem as mesmas do estado da barra atual.
Comentários
O suporte de versão permite que uma barra revisada adicione novas propriedades persistentes e ainda seja capaz de detectar e carregar o estado persistente criado por uma versão anterior da barra.
CDockState::LoadState
Chame essa função para recuperar informações de estado do registro ou arquivo .INI.
void LoadState(LPCTSTR lpszProfileName);
Parâmetros
lpszProfileName
Aponta para uma cadeia de caracteres terminada em nulo que especifica o nome de uma seção no arquivo de inicialização ou uma chave no registro do Windows em que as informações de estado são armazenadas.
Comentários
O nome do perfil é a seção do arquivo .INI do aplicativo ou do registro que contém as informações de estado das barras. Você pode salvar informações de estado da barra de controle no registro ou arquivo .INI com SaveState.
CDockState::m_arrBarInfo
Um objeto CPtrArray que é uma matriz de ponteiros para as informações da barra de controle armazenadas para cada barra de controle que salvou informações de estado no objeto CDockState.
CPtrArray m_arrBarInfo;
CDockState::SaveState
Chame essa função para salvar as informações de estado do registro ou arquivo .INI.
void SaveState(LPCTSTR lpszProfileName);
Parâmetros
lpszProfileName
Aponta para uma cadeia de caracteres terminada em nulo que especifica o nome de uma seção no arquivo de inicialização ou uma chave no Registro do Windows em que as informações de estado são armazenadas.
Comentários
O nome do perfil é a seção do arquivo .INI do aplicativo ou do registro que contém as informações de estado das barras de controle. SaveState também salva o tamanho da tela atual. Você pode recuperar informações da barra de controle do registro ou arquivo .INI com LoadState.