/////////////////////////////////////////////////////////////////////////////
// Name: accesstest.cpp
-// Purpose: wxWindows accessibility sample
+// Purpose: wxWidgets accessibility sample
// Author: Julian Smart
// Modified by:
// Created: 2002-02-12
#endif
// for all others, include the necessary headers (this file is usually all you
-// need because it includes almost all "standard" wxWindows headers)
+// need because it includes almost all "standard" wxWidgets headers)
#ifndef WX_PRECOMP
#include "wx/wx.h"
#endif
-#include "wx/access.h"
+#if wxUSE_ACCESSIBILITY
+ #include "wx/access.h"
+#endif // wxUSE_ACCESSIBILITY
+
#include "wx/splitter.h"
#include "wx/cshelp.h"
#ifdef __WXMSW__
-#include "windows.h"
-#include <ole2.h>
-#include <oleauto.h>
-#include <oleacc.h>
-#include "wx/msw/ole/oleutils.h"
-#include "wx/msw/winundef.h"
-
-#ifndef OBJID_CLIENT
-#define OBJID_CLIENT 0xFFFFFFFC
-#endif
+ #include "windows.h"
+ #include <ole2.h>
+ #include <oleauto.h>
+
+ #if wxUSE_ACCESSIBILITY
+ #include <oleacc.h>
+ #endif // wxUSE_ACCESSIBILITY
+
+ #include "wx/msw/ole/oleutils.h"
+ #include "wx/msw/winundef.h"
+ #ifndef OBJID_CLIENT
+ #define OBJID_CLIENT 0xFFFFFFFC
+ #endif
#endif
// ----------------------------------------------------------------------------
};
+#if wxUSE_ACCESSIBILITY
+
// Define a new frame type: this is going to be our main frame
class MyFrame : public wxFrame
{
private:
wxTextCtrl* m_textCtrl;
- // any class wishing to process wxWindows events must use this macro
+ // any class wishing to process wxWidgets events must use this macro
DECLARE_EVENT_TABLE()
};
};
// ----------------------------------------------------------------------------
-// event tables and other macros for wxWindows
+// event tables and other macros for wxWidgets
// ----------------------------------------------------------------------------
-// the event tables connect the wxWindows events with the functions (event
+// the event tables connect the wxWidgets events with the functions (event
// handlers) which process them. It can be also done at run-time, but for the
// simple menu events like this the static method is much simpler.
BEGIN_EVENT_TABLE(MyFrame, wxFrame)
EVT_MENU(AccessTest_About, MyFrame::OnAbout)
END_EVENT_TABLE()
-// Create a new application object: this macro will allow wxWindows to create
+#endif // wxUSE_ACCESSIBILITY
+
+// Create a new application object: this macro will allow wxWidgets to create
// the application object during program execution (it's better than using a
// static object for many reasons) and also declares the accessor function
// wxGetApp() which will return the reference of the right type (i.e. MyApp and
// 'Main program' equivalent: the program execution "starts" here
bool MyApp::OnInit()
{
+#if wxUSE_ACCESSIBILITY
// Note: JAWS for Windows will only speak the context-sensitive
// help if you use this help provider:
// wxHelpProvider::Set(new wxHelpControllerHelpProvider(m_helpController)).
wxHelpProvider::Set(new wxSimpleHelpProvider());
// create the main application window
- MyFrame *frame = new MyFrame(_T("AccessTest wxWindows App"),
+ MyFrame *frame = new MyFrame(_T("AccessTest wxWidgets App"),
wxPoint(50, 50), wxSize(450, 340));
// and show it (the frames, unlike simple controls, are not shown when
// created initially)
- frame->Show(TRUE);
+ frame->Show(true);
// success: wxApp::OnRun() will be called which will enter the main message
- // loop and the application will run. If we returned FALSE here, the
+ // loop and the application will run. If we returned false here, the
// application would exit immediately.
- return TRUE;
+ return true;
+#else
+ wxMessageBox( _T("This sample has to be compiled with wxUSE_ACCESSIBILITY"), _T("Building error"), wxOK);
+ return false;
+#endif // wxUSE_ACCESSIBILITY
}
+#if wxUSE_ACCESSIBILITY
+
class FrameAccessible: public wxWindowAccessible
{
public:
// Gets a variant representing the selected children
// of this object.
// Acceptable values:
- // - a null variant (IsNull() returns TRUE)
+ // - a null variant (IsNull() returns true)
// - a list variant (GetType() == wxT("list"))
// - an integer representing the selected child element,
// or 0 if this object is selected (GetType() == wxT("long"))
// frame constructor
MyFrame::MyFrame(const wxString& title, const wxPoint& pos, const wxSize& size, long style)
- : wxFrame(NULL, -1, title, pos, size, style)
+ : wxFrame(NULL, wxID_ANY, title, pos, size, style)
{
m_textCtrl = NULL;
#if 0 // wxUSE_STATUSBAR
// create a status bar just for fun (by default with 1 pane only)
CreateStatusBar(2);
- SetStatusText(_T("Welcome to wxWindows!"));
+ SetStatusText(_T("Welcome to wxWidgets!"));
#endif // wxUSE_STATUSBAR
- wxSplitterWindow* splitter = new wxSplitterWindow(this, -1);
+ wxSplitterWindow* splitter = new wxSplitterWindow(this, wxID_ANY);
splitter->SetAccessible(new SplitterWindowAccessible(splitter));
- wxListBox* listBox = new wxListBox(splitter, -1);
+ wxListBox* listBox = new wxListBox(splitter, wxID_ANY);
listBox->Append(wxT("Cabbages"));
listBox->Append(wxT("Kings"));
listBox->Append(wxT("Sealing wax"));
listBox->Append(wxT("Strings"));
listBox->CreateAccessible();
- listBox->SetHelpText(wxT("This is a sample wxWindows listbox, with a number of items in it."));
+ listBox->SetHelpText(wxT("This is a sample wxWidgets listbox, with a number of items in it."));
- m_textCtrl = new wxTextCtrl(splitter, -1, wxT(""), wxDefaultPosition,
+ m_textCtrl = new wxTextCtrl(splitter, wxID_ANY, wxT(""), wxDefaultPosition,
wxDefaultSize, wxTE_MULTILINE);
m_textCtrl->CreateAccessible();
- m_textCtrl->SetHelpText(wxT("This is a sample wxWindows multiline text control."));
+ m_textCtrl->SetHelpText(wxT("This is a sample wxWidgets multiline text control."));
splitter->SplitHorizontally(listBox, m_textCtrl, 150);
#if 0
- wxScrolledWindow* scrolledWindow = new wxScrolledWindow(this, -1);
+ wxScrolledWindow* scrolledWindow = new wxScrolledWindow(this, wxID_ANY);
scrolledWindow->SetAccessible(new ScrolledWindowAccessible(scrolledWindow));
#endif
}
void MyFrame::OnQuit(wxCommandEvent& WXUNUSED(event))
{
- // TRUE is to force the frame to close
- Close(TRUE);
+ // true is to force the frame to close
+ Close(true);
}
void MyFrame::OnAbout(wxCommandEvent& WXUNUSED(event))
wxString str;
str.Printf(wxT("Name = %s; Role = %s"), name.c_str(), role.c_str());
- str.Pad(indent, wxT(' '), FALSE);
+ str.Pad(indent, wxT(' '), false);
Log(str);
}
{
wxString str;
str.Printf(wxT("There are %d children."), (int) childCount);
- str.Pad(indent, wxT(' '), FALSE);
+ str.Pad(indent, wxT(' '), false);
Log(str);
Log(wxT(""));
}
wxString str;
str.Printf(wxT("%d) Name = %s; Role = %s"), i, name.c_str(), role.c_str());
- str.Pad(indent, wxT(' '), FALSE);
+ str.Pad(indent, wxT(' '), false);
Log(str);
VARIANT var;
{
wxString str;
str.Printf(wxT("This is a real object."));
- str.Pad(indent+4, wxT(' '), FALSE);
+ str.Pad(indent+4, wxT(' '), false);
Log(str);
if (pDisp->QueryInterface(IID_IAccessible, (LPVOID*) & childObject) == S_OK)
{
wxString str;
str.Printf(wxT("This is an element."));
- str.Pad(indent+4, wxT(' '), FALSE);
+ str.Pad(indent+4, wxT(' '), false);
Log(str);
}
// Log(wxT(""));
// Can return either a child object, or an integer
// representing the child element, starting from 1.
-wxAccStatus SplitterWindowAccessible::HitTest(const wxPoint& pt, int* childId, wxAccessible** childObject)
+wxAccStatus SplitterWindowAccessible::HitTest(const wxPoint& pt, int* childId, wxAccessible** WXUNUSED(childObject))
{
wxSplitterWindow* splitter = wxDynamicCast(GetWindow(), wxSplitterWindow);
if (splitter)
{
case wxNAVDIR_DOWN:
{
- if (splitter->GetSplitMode() == wxSPLIT_VERTICAL)
- {
- // Can't go down spatially if split vertically.
- return wxACC_FALSE;
- }
- else
+ if (splitter->GetSplitMode() != wxSPLIT_VERTICAL)
{
if (fromId == 1)
{
*toObject = splitter->GetWindow2()->GetAccessible();
return wxACC_OK;
}
- else
- return wxACC_FALSE;
}
-
+ return wxACC_FALSE;
+ #if 0
+ // below line is not executed due to earlier return
break;
+ #endif
}
case wxNAVDIR_FIRSTCHILD:
{
case wxNAVDIR_LEFT:
{
- if (splitter->GetSplitMode() == wxSPLIT_HORIZONTAL)
- {
- // Can't go left spatially if split horizontally.
- return wxACC_FALSE;
- }
- else
+ if (splitter->GetSplitMode() != wxSPLIT_HORIZONTAL)
{
if (fromId == 3)
{
*toObject = splitter->GetWindow1()->GetAccessible();
return wxACC_OK;
}
- else
- return wxACC_FALSE;
}
+ return wxACC_FALSE;
}
+ #if 0
+ // below line is not executed due to earlier return
break;
+ #endif
case wxNAVDIR_NEXT:
{
*toObject = splitter->GetWindow2()->GetAccessible();
return wxACC_OK;
}
- else
return wxACC_FALSE;
}
+ #if 0
+ // below line is not executed due to earlier return
break;
+ #endif
case wxNAVDIR_PREVIOUS:
{
*toObject = splitter->GetWindow1()->GetAccessible();
return wxACC_OK;
}
- else
return wxACC_FALSE;
}
+ #if 0
+ // below line is not executed due to earlier return
break;
+ #endif
case wxNAVDIR_RIGHT:
{
- if (splitter->GetSplitMode() == wxSPLIT_HORIZONTAL)
- {
- // Can't go right spatially if split horizontally.
- return wxACC_FALSE;
- }
- else
+ if (splitter->GetSplitMode() != wxSPLIT_HORIZONTAL)
{
if (fromId == 1)
{
*toObject = splitter->GetWindow2()->GetAccessible();
return wxACC_OK;
}
- else
- return wxACC_FALSE;
}
+ // Can't go right spatially if split horizontally.
+ return wxACC_FALSE;
}
+ #if 0
+ // below line is not executed due to earlier return
break;
+ #endif
case wxNAVDIR_UP:
{
- if (splitter->GetSplitMode() == wxSPLIT_VERTICAL)
- {
- // Can't go up spatially if split vertically.
- return wxACC_FALSE;
- }
- else
+ if (splitter->GetSplitMode() != wxSPLIT_VERTICAL)
{
if (fromId == 3)
{
*toObject = splitter->GetWindow1()->GetAccessible();
return wxACC_OK;
}
- else
- return wxACC_FALSE;
}
+ // Can't go up spatially if split vertically.
+ return wxACC_FALSE;
+ #if 0
+ // below line is not executed due to earlier return
break;
+ #endif
}
}
}
// Gets the parent, or NULL.
-wxAccStatus SplitterWindowAccessible::GetParent(wxAccessible** parent)
+wxAccStatus SplitterWindowAccessible::GetParent(wxAccessible** WXUNUSED(parent))
{
return wxACC_NOT_IMPLEMENTED;
}
// or > 0 (the action for a child).
// Return wxACC_NOT_SUPPORTED if there is no default action for this
// window (e.g. an edit control).
-wxAccStatus SplitterWindowAccessible::DoDefaultAction(int childId)
+wxAccStatus SplitterWindowAccessible::DoDefaultAction(int WXUNUSED(childId))
{
return wxACC_NOT_IMPLEMENTED;
}
// The retrieved string describes the action that is performed on an object,
// not what the object does as a result. For example, a toolbar button that prints
// a document has a default action of "Press" rather than "Prints the current document."
-wxAccStatus SplitterWindowAccessible::GetDefaultAction(int childId, wxString* actionName)
+wxAccStatus SplitterWindowAccessible::GetDefaultAction(int childId, wxString* WXUNUSED(actionName))
{
wxSplitterWindow* splitter = wxDynamicCast(GetWindow(), wxSplitterWindow);
if (splitter && splitter->IsSplit() && childId == 2)
// Returns the keyboard shortcut for this object or child.
// Return e.g. ALT+K
-wxAccStatus SplitterWindowAccessible::GetKeyboardShortcut(int childId, wxString* shortcut)
+wxAccStatus SplitterWindowAccessible::GetKeyboardShortcut(int childId, wxString* WXUNUSED(shortcut))
{
wxSplitterWindow* splitter = wxDynamicCast(GetWindow(), wxSplitterWindow);
if (splitter && splitter->IsSplit() && childId == 2)
}
// Selects the object or child.
-wxAccStatus SplitterWindowAccessible::Select(int childId, wxAccSelectionFlags selectFlags)
+wxAccStatus SplitterWindowAccessible::Select(int childId, wxAccSelectionFlags WXUNUSED(selectFlags))
{
wxSplitterWindow* splitter = wxDynamicCast(GetWindow(), wxSplitterWindow);
if (splitter && splitter->IsSplit() && childId == 2)
// If childId is 0 and child is NULL, no object in
// this subhierarchy has the focus.
// If this object has the focus, child should be 'this'.
-wxAccStatus SplitterWindowAccessible::GetFocus(int* childId, wxAccessible** child)
+wxAccStatus SplitterWindowAccessible::GetFocus(int* WXUNUSED(childId), wxAccessible** WXUNUSED(child))
{
return wxACC_NOT_IMPLEMENTED;
}
// Gets a variant representing the selected children
// of this object.
// Acceptable values:
-// - a null variant (IsNull() returns TRUE)
+// - a null variant (IsNull() returns true)
// - a list variant (GetType() == wxT("list"))
// - an integer representing the selected child element,
// or 0 if this object is selected (GetType() == wxT("long"))
// - a "void*" pointer to a wxAccessible child object
-wxAccStatus SplitterWindowAccessible::GetSelections(wxVariant* selections)
+wxAccStatus SplitterWindowAccessible::GetSelections(wxVariant* WXUNUSED(selections))
{
return wxACC_NOT_IMPLEMENTED;
}
+#endif // wxUSE_ACCESSIBILITY