Classe COleCmdUI

Implementa um método para que o MFC atualize o estado dos objetos de interface do usuário relacionados aos recursos controlados por IOleCommandTarget do aplicativo.

Sintaxe

class COleCmdUI : public CCmdUI

Membros

Construtores públicos

Nome	Descrição
COleCmdUI::COleCmdUI	Constrói um objeto COleCmdUI.

Métodos públicos

Nome	Descrição
COleCmdUI::Enable	Define ou limpa o sinalizador do comando habilitar.
COleCmdUI::SetCheck	Define o estado de um comando de alternância ativar/desativar.
COleCmdUI::SetText	Retorna uma cadeia de caracteres de status ou nome de texto para um comando.

Comentários

Em um aplicativo que não está habilitado para DocObjects, quando o usuário exibe um menu no aplicativo, MFC processa notificações UPDATE_COMMAND_UI. Cada notificação recebe um objeto CCmdUI que pode ser manipulado para refletir o estado de um comando específico. No entanto, quando o aplicativo está habilitado para DocObjects, o MFC processa notificações de UPDATE_OLE_COMMAND_UI e atribui objetos COleCmdUI.

COleCmdUI permite que um DocObject receba comandos originados na interface do usuário do contêiner (como FileNew, Open, Print e assim por diante) e permite que um contêiner receba comandos originados na interface do usuário do DocObject. Embora IDispatch possa ser usado para expedir os mesmos comandos, IOleCommandTarget proporciona uma maneira mais simples de consultar e executar porque depende de um conjunto padrão de comandos, geralmente sem argumentos, e nenhuma informação de tipo está envolvida. COleCmdUI pode ser usado para habilitar, atualizar e definir outras propriedades dos comandos de interface do usuário do DocObject. Quando quiser invocar o comando, chame COleServerDoc::OnExecOleCmd.

Para obter mais informações sobre DocObjects, consulte CDocObjectServer e CDocObjectServerItem.

Hierarquia de herança

CCmdUI

COleCmdUI

Requisitos

Cabeçalho: afxdocob.h

COleCmdUI::COleCmdUI

Constrói um objeto COleCmdUI associado a um comando específico da interface do usuário.

COleCmdUI(
    OLECMD* rgCmds,
    ULONG cCmds,
    const GUID* m_pGroup);

Parâmetros

rgCmds
Uma lista de comandos com suporte associados ao GUID fornecido. A estrutura OLECMD associa comandos a sinalizadores de comando.

cCmds
A contagem de comandos em rgCmds.

pGroup
Um ponteiro para um GUID que identifica um conjunto de comandos.

Comentários

O objeto COleCmdUI fornece uma interface programática para atualizar objetos da interface do usuário do DocObject, como itens de menu ou botões de barra de controle. Os objetos da interface do usuário podem ser habilitados, desabilitados, marcados e/ou desmarcados usando o objeto COleCmdUI.

COleCmdUI::Enable

Chame essa função para definir o sinalizador de comando do objeto COleCmdUI como OLECOMDF_ENABLED, o que informa à interface que o comando está disponível e habilitado ou a instrui a limpar o sinalizador de comando.

virtual void Enable(BOOL bOn);

Parâmetros

bOn
Indica se o comando associado ao objeto COleCmdUI deve ser habilitado ou desabilitado. Quando diferente de zero, habilita o comando; 0 desabilita o comando.

COleCmdUI::SetCheck

Chame essa função para definir o estado de um comando de alternância ativar/desativar.

virtual void SetCheck(int nCheck);

Parâmetros

nCheck
Um valor que determina o estado para definir um comando de alternância ativar/desativar. Os valores são:

Valor	Description
1	Define o comando como ativado.
2	Define o comando como indeterminado; o estado não pode ser determinado porque o atributo desse comando está tanto no estado ativado quanto desativado na seleção relevante.
qualquer outro valor	Define o comando como desativado.

COleCmdUI::SetText

Chame essa função para retornar uma cadeia de caracteres de status ou nome de texto para um comando.

virtual void SetText(LPCTSTR lpszText);

Parâmetros

lpszTexto
Um ponteiro para o texto a ser usado com o comando.

Confira também

Classe CCmdUI
Gráfico da hierarquia