Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Removed some TODOs in the Latex docs; changed wxMotif wxClipboard to match

Browse Source 
wxGTK/wxMSW syntax; added Ron Kuris' wxExecute patch


git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@1659 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Julian Smart
1999-02-09 21:22:58 +00:00
parent 3b1e466ce9
commit 5b6aa0ff15
24 changed files with 103 additions and 107 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/latex/wx/bitmap.tex
View File

@@ -388,8 +388,9 @@ Saves a bitmap in the named file.
The validity of these flags depends on the platform and wxWindows configuration.}
\docparam{palette}{An optional palette used for saving the bitmap. TODO: this parameter should
probably be eliminated; instead the app should set the palette before saving.}
\docparam{palette}{An optional palette used for saving the bitmap.}
% TODO: this parameter should
%probably be eliminated; instead the app should set the palette before saving.
\wxheading{Return value}
@@ -640,8 +641,7 @@ Saves a bitmap in the named file.
\docparam{type}{See \helpref{wxBitmap::wxBitmap}{wxbitmapconstr} for values this can take.}
\docparam{palette}{An optional palette used for saving the bitmap. TODO: this parameter should
probably be eliminated; instead the app should set the palette before saving.}
\docparam{palette}{An optional palette used for saving the bitmap.}
\wxheading{Return value}

1
docs/latex/wx/bmpdatob.tex
View File

@@ -69,6 +69,7 @@ size_t MyBitmapDataObject::GetSize()
TODO: Offer a nicer way to do this. Maybe by providing a platform
dependent function in this class like
\begin{verbatim}
size_t GetBitmapSize( const wxBitmap &bitmap )
\end{verbatim}

3
docs/latex/wx/brush.tex
View File

@@ -32,8 +32,7 @@ efficiency problems. Once one wxBrush object changes its data it will create its
own brush data internally so that other brushes, which previously shared the
data using the reference counting, are not affected.
TODO: an overview for wxBrush.
%TODO: an overview for wxBrush.
\wxheading{See also}
\helpref{wxBrushList}{wxbrushlist}, \helpref{wxDC}{wxdc}, \helpref{wxDC::SetBrush}{wxdcsetbrush}

6
docs/latex/wx/colour.tex
View File

@@ -112,18 +112,12 @@ Assignment operator, using a colour name to be found in the colour database.
Tests the equality of two colours by comparing individual red, green blue colours.
TODO: this may be different on platforms other than Windows - no reference counting
is done on Windows.
\membersection{wxColour::operator $!=$}\label{wxcolourinequality}
\func{bool}{operator $!=$}{\param{const wxColour\&}{ colour}}
Tests the inequality of two colours by comparing individual red, green blue colours.
TODO: this may be different on platforms other than Windows - no reference counting
is done on Windows.
\section{\class{wxColourData}}\label{wxcolourdata}
This class holds a variety of information related to colour dialogs.

3
docs/latex/wx/combobox.tex
View File

@@ -220,8 +220,7 @@ Returns the current value in the combobox text field.
\constfunc{int}{Number}{\void}
Returns the number of items in the combobox list.
TODO: make this GetNumber or GetCount?
%TODO: make this GetNumber or GetCount?
\membersection{wxComboBox::Paste}\label{wxcomboboxpaste}

4
docs/latex/wx/date.tex
View File

@@ -2,6 +2,10 @@
A class for manipulating dates.
NOTE: this class should be
used with caution, since it is not fully tested. It may be replaced
with a new class in the near future.
\wxheading{Derived from}
\helpref{wxObject}{wxobject}

3
docs/latex/wx/evthand.tex
View File

@@ -237,8 +237,7 @@ Sets user-supplied client data.
Normally, any extra data the programmer wishes
to associate with the object should be made available by deriving a new class
with new data members.
TODO: make this void*, char* only in compatibility mode.
%TODO: make this void*, char* only in compatibility mode.
\wxheading{See also}

3
docs/latex/wx/function.tex
View File

@@ -1699,7 +1699,8 @@ builds.
This function may be redefined to do something non trivial and is called
whenever one of debugging macros fails (i.e. condition is false in an
assertion). TODO: this should probably be an overridable in wxApp.
assertion).
% TODO: this should probably be an overridable in wxApp.
\membersection{wxASSERT}\label{wxassert}

3
docs/latex/wx/icon.tex
View File

@@ -269,8 +269,7 @@ Saves an icon in the named file.
The validity of these flags depends on the platform and wxWindows configuration.}
\docparam{palette}{An optional palette used for saving the icon. TODO: this parameter should
probably be eliminated; instead the app should set the palette before saving.}
\docparam{palette}{An optional palette used for saving the icon.}
\wxheading{Return value}

2
docs/latex/wx/ilayout.tex
View File

@@ -19,8 +19,6 @@ which means that their values should be calculated by looking at known constrain
\subsection{Edges and relationships}
TODO: put this in a different section.
The {\it wxEdge}\index{wxEdge} enumerated type specifies the type of edge or dimension of a window.
\begin{twocollist}\itemsep=0pt

10
docs/latex/wx/menuevt.tex
View File

@@ -16,15 +16,15 @@ functions that take a wxMenuEvent argument.
\twocolwidtha{7cm}
\begin{twocollist}\itemsep=0pt
\twocolitem{{\bf EVT\_MENU\_CHAR(func)}}{Process a wxEVT\_MENU\_CHAR event (a keypress
when a menu is showing). Windows only. TODO}
when a menu is showing). Windows only; not yet implemented.}
\twocolitem{{\bf EVT\_MENU\_INIT(func)}}{Process a wxEVT\_MENU\_INIT event (the menu
is about to pop up). Windows only. TODO}
is about to pop up). Windows only; not yet implemented.}
\twocolitem{{\bf EVT\_MENU\_HIGHLIGHT(func)}}{Process a wxEVT\_MENU\_HIGHLIGHT event (a menu
item is being highlighted). Windows only.}
item is being highlighted). Windows only; not yet implemented.}
\twocolitem{{\bf EVT\_POPUP\_MENU(func)}}{Process a wxEVT\_POPUP\_MENU event (a menu
item is being highlighted). Windows only. TODO}
item is being highlighted). Windows only; not yet implemented.}
\twocolitem{{\bf EVT\_CONTEXT\_MENU(func)}}{Process a wxEVT\_CONTEXT\_MENU event (F1 has
been pressed with a particular menu item highlighted). Windows only. TODO}
been pressed with a particular menu item highlighted). Windows only; not yet implemented.}
\end{twocollist}%
\wxheading{See also}

2
docs/latex/wx/mltchdlg.tex
View File

@@ -3,8 +3,6 @@
This class represents a dialog that shows a list of strings, and allows
the user to select one or more.
TODO.
\wxheading{Derived from}
\helpref{wxDialog}{wxdialog}\\

3
docs/latex/wx/palette.tex
View File

@@ -3,8 +3,7 @@
A palette is a table that maps pixel values to RGB colours. It allows the colours
of a low-depth bitmap, for example, to be mapped to the available colours in a display.
TODO: topic overview for wxPalette.
%TODO: topic overview for wxPalette.
\wxheading{Derived from}
\helpref{wxGDIObject}{wxgdiobject}\\

6
docs/latex/wx/pen.tex
View File

@@ -26,8 +26,7 @@ efficiency problems. Once one wxPen object changes its data it will create its
own pen data internally so that other pens, which previously shared the
data using the reference counting, are not affected.
TODO: an overview for wxPen.
%TODO: an overview for wxPen.
\wxheading{See also}
\helpref{wxPenList}{wxpenlist}, \helpref{wxDC}{wxdc}, \helpref{wxDC::SetPen}{wxdcsetpen}
@@ -235,8 +234,7 @@ with the pen. The array is not deallocated by wxPen, but neither must it be
deallocated by the calling application until the pen is deleted or this
function is called with a NULL array.
TODO: describe in detail.
%TODO: describe in detail.
\wxheading{See also}
\helpref{wxPen::GetDashes}{wxpengetdashes}

4
docs/latex/wx/spinbutt.tex
View File

@@ -22,10 +22,6 @@ used next to a text control for increment and decrementing a value.
See also \helpref{window styles overview}{windowstyles}.
\wxheading{Remarks}
TODO
\wxheading{Event handling}
To process input from a spin button, use one of these event handler macros to direct input to member

4
docs/latex/wx/stattext.tex
View File

@@ -2,10 +2,6 @@
A static text control displays one or more lines of read-only text.
TODO: should a static text have a validator? E.g. if you wanted
to use it to initialise the control with some text taken from
the validator.
\wxheading{Derived from}
\helpref{wxControl}{wxcontrol}\\

3
docs/latex/wx/tcommdlg.tex
View File

@@ -208,5 +208,6 @@ a string or client data.
Classes: \helpref{wxMultipleChoiceDialog}{wxmultiplechoicedialog}
This dialog shows a list of choices, plus OK and (optionally) Cancel. The user can
select one or more of them. TODO.
select one or more of them.

9
docs/latex/wx/timaglst.tex
View File

@@ -2,5 +2,12 @@
Classes: \helpref{wxImageList}{wximagelist}
TODO.
An image list is a list of images that may have transparent areas.
The class helps an application organise a collection of images
so that they can be referenced by integer index instead of by
pointer.
Image lists are used in \helpref{wxNotebook}{wxnotebook},
\helpref{wxListCtrl}{wxlistctrl}, \helpref{wxTreeCtrl}{wxlistctrl} and
some other control classes.

4
docs/latex/wx/time.tex
View File

@@ -2,6 +2,10 @@
Representation of time and date.
NOTE: this class should be
used with caution, since it is not fully tested. It may be replaced
with a new class in the near future.
\wxheading{Derived from}
\helpref{wxObject}{wxobject}

85
docs/latex/wx/ttoolbar.tex
View File

@@ -101,39 +101,44 @@ source is given below.
#endif
#include "wx/toolbar.h"
#include <wx/log.h>
#include "test.h"
IMPLEMENT_APP(MyApp)
#ifdef __X__
// TODO: include XBM or XPM icons for X apps
#if defined(__WXGTK__) || defined(__WXMOTIF__)
#include "mondrian.xpm"
#include "bitmaps/new.xpm"
#include "bitmaps/open.xpm"
#include "bitmaps/save.xpm"
#include "bitmaps/copy.xpm"
#include "bitmaps/cut.xpm"
#include "bitmaps/print.xpm"
#include "bitmaps/preview.xpm"
#include "bitmaps/help.xpm"
#endif
IMPLEMENT_APP(MyApp)
// The `main program' equivalent, creating the windows and returning the
// main frame
bool MyApp::OnInit(void)
{
// Create the main frame window
MyFrame* frame = new MyFrame(NULL, -1, "wxToolBar Sample",
MyFrame* frame = new MyFrame((wxFrame *) NULL, -1, (const wxString) "wxToolBar Sample",
wxPoint(100, 100), wxSize(450, 300));
// Give it a status line
frame->CreateStatusBar();
// Give it an icon
#ifdef __WXMSW__
frame->SetIcon(wxIcon("mondrian"));
#endif
#ifdef __X__
frame->SetIcon(wxIcon("mondrian.xbm"));
#endif
frame->SetIcon(wxICON(mondrian));
// Make a menubar
wxMenu *fileMenu = new wxMenu;
fileMenu->Append(wxID_EXIT, "E&xit");
fileMenu->Append(wxID_EXIT, "E&xit", "Quit toolbar sample" );
wxMenu *helpMenu = new wxMenu;
helpMenu->Append(wxID_HELP, "&About");
helpMenu->Append(wxID_HELP, "&About", "About toolbar sample");
wxMenuBar* menuBar = new wxMenuBar;
@@ -145,12 +150,15 @@ bool MyApp::OnInit(void)
// Create the toolbar
frame->CreateToolBar(wxNO_BORDER|wxHORIZONTAL|wxTB_FLAT, ID_TOOLBAR);
frame->GetToolBar()->SetMargins( 2, 2 );
InitToolbar(frame->GetToolBar());
// Force a resize. This should probably be replaced by a call to a wxFrame
// function that lays out default decorations and the remaining content window.
frame->OnSize(wxSizeEvent(wxSize(-1, -1), frame->GetId()));
wxSizeEvent event(wxSize(-1, -1), frame->GetId());
frame->OnSize(event);
frame->Show(TRUE);
frame->SetStatusText("Hello, wxWindows");
@@ -162,8 +170,6 @@ bool MyApp::OnInit(void)
bool MyApp::InitToolbar(wxToolBar* toolBar)
{
toolBar->SetMargins(5, 5);
// Set up toolbar
wxBitmap* toolBarBitmaps[8];
@@ -176,17 +182,15 @@ bool MyApp::InitToolbar(wxToolBar* toolBar)
toolBarBitmaps[5] = new wxBitmap("icon6");
toolBarBitmaps[6] = new wxBitmap("icon7");
toolBarBitmaps[7] = new wxBitmap("icon8");
#endif
#ifdef __X__
// TODO
toolBarBitmaps[0] = new wxBitmap(...);
toolBarBitmaps[1] = new wxBitmap(...);
toolBarBitmaps[2] = new wxBitmap(...);
toolBarBitmaps[3] = new wxBitmap(...);
toolBarBitmaps[4] = new wxBitmap(...);
toolBarBitmaps[5] = new wxBitmap(...);
toolBarBitmaps[6] = new wxBitmap(...);
toolBarBitmaps[7] = new wxBitmap(...);
#else
toolBarBitmaps[0] = new wxBitmap( new_xpm );
toolBarBitmaps[1] = new wxBitmap( open_xpm );
toolBarBitmaps[2] = new wxBitmap( save_xpm );
toolBarBitmaps[3] = new wxBitmap( copy_xpm );
toolBarBitmaps[4] = new wxBitmap( cut_xpm );
toolBarBitmaps[5] = new wxBitmap( preview_xpm );
toolBarBitmaps[6] = new wxBitmap( print_xpm );
toolBarBitmaps[7] = new wxBitmap( help_xpm );
#endif
#ifdef __WXMSW__
@@ -194,27 +198,26 @@ bool MyApp::InitToolbar(wxToolBar* toolBar)
#else
int width = 16;
#endif
int offX = 5;
int currentX = 5;
toolBar->AddTool(wxID_NEW, *(toolBarBitmaps[0]), wxNullBitmap, FALSE, (float)currentX, -1, NULL, "New file");
toolBar->AddTool(wxID_NEW, *(toolBarBitmaps[0]), wxNullBitmap, FALSE, currentX, -1, (wxObject *) NULL, "New file");
currentX += width + 5;
toolBar->AddTool(wxID_OPEN, *(toolBarBitmaps[1]), wxNullBitmap, FALSE, (float)currentX, -1, NULL, "Open file");
toolBar->AddTool(wxID_OPEN, *(toolBarBitmaps[1]), wxNullBitmap, FALSE, currentX, -1, (wxObject *) NULL, "Open file");
currentX += width + 5;
toolBar->AddTool(wxID_SAVE, *(toolBarBitmaps[2]), wxNullBitmap, FALSE, (float)currentX, -1, NULL, "Save file");
toolBar->AddTool(wxID_SAVE, *(toolBarBitmaps[2]), wxNullBitmap, FALSE, currentX, -1, (wxObject *) NULL, "Save file");
currentX += width + 5;
toolBar->AddSeparator();
toolBar->AddTool(wxID_COPY, *(toolBarBitmaps[3]), wxNullBitmap, FALSE, (float)currentX, -1, NULL, "Copy");
toolBar->AddTool(wxID_COPY, *(toolBarBitmaps[3]), wxNullBitmap, FALSE, currentX, -1, (wxObject *) NULL, "Copy");
currentX += width + 5;
toolBar->AddTool(wxID_CUT, *(toolBarBitmaps[4]), wxNullBitmap, FALSE, (float)currentX, -1, NULL, "Cut");
toolBar->AddTool(wxID_CUT, *(toolBarBitmaps[4]), wxNullBitmap, FALSE, currentX, -1, (wxObject *) NULL, "Cut");
currentX += width + 5;
toolBar->AddTool(wxID_PASTE, *(toolBarBitmaps[5]), wxNullBitmap, FALSE, (float)currentX, -1, NULL, "Paste");
toolBar->AddTool(wxID_PASTE, *(toolBarBitmaps[5]), wxNullBitmap, FALSE, currentX, -1, (wxObject *) NULL, "Paste");
currentX += width + 5;
toolBar->AddSeparator();
toolBar->AddTool(wxID_PRINT, *(toolBarBitmaps[6]), wxNullBitmap, FALSE, (float)currentX, -1, NULL, "Print");
toolBar->AddTool(wxID_PRINT, *(toolBarBitmaps[6]), wxNullBitmap, FALSE, currentX, -1, (wxObject *) NULL, "Print");
currentX += width + 5;
toolBar->AddSeparator();
toolBar->AddTool(wxID_HELP, *(toolBarBitmaps[7]), wxNullBitmap, FALSE, currentX, -1, NULL, "Help");
toolBar->AddTool(wxID_HELP, *(toolBarBitmaps[7]), wxNullBitmap, FALSE, currentX, -1, (wxObject *) NULL, "Help");
toolBar->Realize();
@@ -233,7 +236,7 @@ BEGIN_EVENT_TABLE(MyFrame, wxFrame)
EVT_MENU(wxID_HELP, MyFrame::OnAbout)
EVT_CLOSE(MyFrame::OnCloseWindow)
EVT_TOOL_RANGE(wxID_OPEN, wxID_PASTE, MyFrame::OnToolLeftClick)
EVT_TOOL_ENTER(ID_TOOLBAR, MyFrame::OnToolEnter)
EVT_TOOL_ENTER(wxID_OPEN, MyFrame::OnToolEnter)
END_EVENT_TABLE()
// Define my frame constructor
@@ -244,19 +247,19 @@ MyFrame::MyFrame(wxFrame* parent, wxWindowID id, const wxString& title, const wx
m_textWindow = new wxTextCtrl(this, -1, "", wxPoint(0, 0), wxSize(-1, -1), wxTE_MULTILINE);
}
void MyFrame::OnQuit(wxCommandEvent& event)
void MyFrame::OnQuit(wxCommandEvent& WXUNUSED(event))
{
Close(TRUE);
}
void MyFrame::OnAbout(wxCommandEvent& event)
void MyFrame::OnAbout(wxCommandEvent& WXUNUSED(event))
{
(void)wxMessageBox("wxWindows wxToolBar demo\n", "About wxToolBar");
(void)wxMessageBox("wxWindows toolbar sample", "About wxToolBar");
}
// Define the behaviour for the frame closing
// - must delete all frames except for the main one.
void MyFrame::OnCloseWindow(wxCloseEvent& event)
void MyFrame::OnCloseWindow(wxCloseEvent& WXUNUSED(event))
{
Destroy();
}

30
docs/latex/wx/window.tex
View File

@@ -141,7 +141,8 @@ relative to the panel.
\func{void}{Clear}{\void}
Clears the window by filling it with the current background colour.
Clears the window by filling it with the current background colour. Does not
cause an erase background event to be generated.
\membersection{wxWindow::ClientToScreen}
@@ -464,12 +465,10 @@ Returns the identifier of the window.
Each window has an integer identifier. If the application has not provided one,
an identifier will be generated.
TODO: perhaps there should be a default identifier for each class, rather
choosing one, which could clash with other ones.
\wxheading{See also}
\helpref{wxWindow::SetId}{wxwindowsetid}
\helpref{wxWindow::SetId}{wxwindowsetid}\rtfsp
\helpref{Window identifiers}{windowids}
\membersection{wxWindow::GetPosition}
@@ -702,14 +701,6 @@ default resource table will be used.}
TRUE if the operation succeeded, otherwise FALSE.
\wxheading{Remarks}
TODO
\wxheading{See also}
TODO
\membersection{wxWindow::Lower}\label{wxwindowlower}
\func{void}{Lower}{\void}
@@ -1543,11 +1534,17 @@ Sets the background colour of the window.
The background colour is usually painted by the default\rtfsp
\helpref{wxWindow::OnEraseBackground}{wxwindowonerasebackground} event handler function.
Note that setting the background colour does not cause an immediate refresh, so you
may wish to call \helpref{wxWindow::Clear}{wxwindowclear} or \helpref{wxWindow::Refresh}{wxwindowrefresh} after
calling this function.
\wxheading{See also}
\helpref{wxWindow::GetBackgroundColour}{wxwindowgetbackgroundcolour},\rtfsp
\helpref{wxWindow::SetForegroundColour}{wxwindowsetforegroundcolour},\rtfsp
\helpref{wxWindow::GetForegroundColour}{wxwindowgetforegroundcolour},\rtfsp
\helpref{wxWindow::Clear}{wxwindowclear},\rtfsp
\helpref{wxWindow::Refresh}{wxwindowrefresh},\rtfsp
\helpref{wxWindow::OnEraseBackground}{wxwindowonerasebackground}
\membersection{wxWindow::SetConstraints}\label{wxwindowsetconstraints}
@@ -1637,13 +1634,10 @@ Each window has an integer identifier. If the application has not provided one,
an identifier will be generated. Normally, the identifier should be provided
on creation and should not be modified subsequently.
TODO: perhaps there should be a default identifier for each class, rather
choosing one, which could clash with other ones.
\wxheading{See also}
\helpref{wxWindow::GetId}{wxwindowgetid}
\helpref{wxWindow::GetId}{wxwindowgetid},\rtfsp
\helpref{Window identifiers}{windowids}
\membersection{wxWindow::SetName}\label{wxwindowsetname}

2
include/wx/motif/clipbrd.h
View File

@@ -61,7 +61,7 @@ public:
// format available on the clipboard ?
// supply ID if private format, the same as wxPrivateDataObject::SetId()
virtual bool IsSupportedFormat( wxDataFormat format, const wxString &id = wxEmptyString );
virtual bool IsSupported( wxDataFormat format );
// fill data with data on the clipboard (if available)
virtual bool GetData( wxDataObject *data );

2
src/motif/clipbrd.cpp
View File

@@ -306,7 +306,7 @@ void wxClipboard::Close()
wxCloseClipboard();
}
bool wxClipboard::IsSupportedFormat( wxDataFormat format, const wxString& WXUNUSED(id) )
bool wxClipboard::IsSupported( wxDataFormat format)
{
return wxIsClipboardFormatAvailable(format);
}

10
src/motif/utilsexc.cpp
View File

@@ -15,6 +15,7 @@
#include "wx/utils.h"
#include "wx/app.h"
#include "wx/process.h"
#include <stdio.h>
#include <stdlib.h>
@@ -105,13 +106,15 @@ void xt_notify_end_process(XtPointer client, int *fid,
XtRemoveInput(*id);
if (process_data->process)
process_data->process->OnTerminate(process_data->pid);
process_data->process->OnTerminate(process_data->pid, 0); // What should 'status' be?
process_data->end_process = TRUE;
/* double deletion!
if (process_data->pid > 0)
delete process_data;
else
*/
process_data->pid = 0;
}
@@ -180,7 +183,10 @@ long wxExecute(char **argv, bool sync, wxProcess *handler)
XtAppProcessEvent((XtAppContext) wxTheApp->GetAppContext(), XtIMAll);
if (WIFEXITED(process_data->end_process) != 0)
{
delete process_data;
return WEXITSTATUS(process_data->end_process);
}
}
delete process_data;