soui 5.0.0.1
Soui5 Doc
 
Loading...
Searching...
No Matches
SAccProxyWindow.h
1#ifndef __SACCPROXYWINDOW__H__
2#define __SACCPROXYWINDOW__H__
3
4#include "interface/saccproxy-i.h"
5
6SNSBEGIN
7
8#ifdef SOUI_ENABLE_ACC
9
10/**
11 * @class SAccProxyWindow
12 * @brief Accessibility proxy window class implementing IAccProxy interface.
13 */
14class SOUI_EXP SAccProxyWindow : public TObjRefImpl<IAccProxy> {
15 public:
16 /**
17 * @brief Constructor.
18 * @param pWnd Pointer to the associated window.
19 */
20 SAccProxyWindow(IWindow *pWnd)
21 : m_pWnd(pWnd)
22 {
23 }
24
25 /**
26 * @brief Destructor.
27 */
28 virtual ~SAccProxyWindow()
29 {
30 }
31
32 public:
33 /**
34 * @brief Retrieves the name of the accessible object.
35 * @param pszName Pointer to receive the name of the accessible object.
36 * @return HRESULT indicating success or failure.
37 */
38 virtual STDMETHODIMP get_accName(BSTR *pszName);
39
40 /**
41 * @brief Retrieves the value of the accessible object.
42 * @param pszValue Pointer to receive the value of the accessible object.
43 * @return HRESULT indicating success or failure.
44 */
45 virtual STDMETHODIMP get_accValue(BSTR *pszValue);
46
47 /**
48 * @brief Retrieves the description of the accessible object.
49 * @param pszDescription Pointer to receive the description of the accessible object.
50 * @return HRESULT indicating success or failure.
51 */
52 virtual STDMETHODIMP get_accDescription(BSTR *pszDescription);
53
54 /**
55 * @brief Retrieves the role of the accessible object.
56 * @param pvarRole Pointer to receive the role of the accessible object.
57 * @return HRESULT indicating success or failure.
58 */
59 virtual STDMETHODIMP get_accRole(VARIANT *pvarRole);
60
61 /**
62 * @brief Retrieves the state of the accessible object.
63 * @param pvarState Pointer to receive the state of the accessible object.
64 * @return HRESULT indicating success or failure.
65 */
66 virtual STDMETHODIMP get_accState(VARIANT *pvarState);
67
68 /**
69 * @brief Retrieves the help string for the accessible object.
70 * @param pszHelp Pointer to receive the help string.
71 * @return HRESULT indicating success or failure.
72 */
73 virtual STDMETHODIMP get_accHelp(BSTR *pszHelp);
74
75 /**
76 * @brief Retrieves the help topic for the accessible object.
77 * @param pszHelpFile Pointer to receive the help file name.
78 * @param pidTopic Pointer to receive the help topic ID.
79 * @return HRESULT indicating success or failure.
80 */
81 virtual STDMETHODIMP get_accHelpTopic(BSTR *pszHelpFile, long *pidTopic);
82
83 /**
84 * @brief Retrieves the keyboard shortcut for the accessible object.
85 * @param pszKeyboardShortcut Pointer to receive the keyboard shortcut.
86 * @return HRESULT indicating success or failure.
87 */
88 virtual STDMETHODIMP get_accKeyboardShortcut(BSTR *pszKeyboardShortcut);
89
90 /**
91 * @brief Retrieves the default action for the accessible object.
92 * @param pszDefaultAction Pointer to receive the default action.
93 * @return HRESULT indicating success or failure.
94 */
95 virtual STDMETHODIMP get_accDefaultAction(BSTR *pszDefaultAction);
96
97 /**
98 * @brief Selects the accessible object.
99 * @param flagsSelect Flags specifying the selection action.
100 * @return HRESULT indicating success or failure.
101 */
102 virtual STDMETHODIMP accSelect(long flagsSelect);
103
104 /**
105 * @brief Performs the default action for the accessible object.
106 * @return HRESULT indicating success or failure.
107 */
108 virtual STDMETHODIMP accDoDefaultAction();
109
110 /**
111 * @brief Sets the name of the accessible object.
112 * @param szName New name for the accessible object.
113 * @return HRESULT indicating success or failure.
114 */
115 virtual STDMETHODIMP put_accName(BSTR szName);
116
117 /**
118 * @brief Sets the value of the accessible object.
119 * @param szValue New value for the accessible object.
120 * @return HRESULT indicating success or failure.
121 */
122 virtual STDMETHODIMP put_accValue(BSTR szValue);
123
124 protected:
125 IWindow *m_pWnd; // Pointer to the associated window
126};
127
128#endif // SOUI_ENABLE_ACC
129
130SNSEND
131
132#endif // __SACCPROXYWINDOW__H__
Template class implementing the IObjRef interface.