Fix typos in comments in C++ code
No real changes. Closes https://github.com/wxWidgets/wxWidgets/pull/268
This commit is contained in:
committed by
Vadim Zeitlin
parent
c30fe114ee
commit
e3f1423632
@@ -327,7 +327,7 @@ public:
|
|||||||
// side: wxLEFT or wxRIGHT, indicates on which side the button will be placed.
|
// side: wxLEFT or wxRIGHT, indicates on which side the button will be placed.
|
||||||
// spacingX: empty space on sides of the button. Default is 0.
|
// spacingX: empty space on sides of the button. Default is 0.
|
||||||
// Remarks:
|
// Remarks:
|
||||||
// There is no spacingY - the button will be centered vertically.
|
// There is no spacingY - the button will be centred vertically.
|
||||||
void SetButtonPosition( int width = -1,
|
void SetButtonPosition( int width = -1,
|
||||||
int height = -1,
|
int height = -1,
|
||||||
int side = wxRIGHT,
|
int side = wxRIGHT,
|
||||||
@@ -397,7 +397,7 @@ public:
|
|||||||
}
|
}
|
||||||
|
|
||||||
//
|
//
|
||||||
// Utilies needed by the popups or native implementations
|
// Utilities needed by the popups or native implementations
|
||||||
//
|
//
|
||||||
|
|
||||||
// Returns true if given key combination should toggle the popup.
|
// Returns true if given key combination should toggle the popup.
|
||||||
@@ -494,7 +494,7 @@ protected:
|
|||||||
// called from wxSizeEvent handler
|
// called from wxSizeEvent handler
|
||||||
virtual void OnResize() = 0;
|
virtual void OnResize() = 0;
|
||||||
|
|
||||||
// Return native text identation
|
// Return native text indentation
|
||||||
// (i.e. text margin, for pure text, not textctrl)
|
// (i.e. text margin, for pure text, not textctrl)
|
||||||
virtual wxCoord GetNativeTextIndent() const;
|
virtual wxCoord GetNativeTextIndent() const;
|
||||||
|
|
||||||
@@ -553,7 +553,7 @@ protected:
|
|||||||
// NULL popup can be used to indicate default in a derived class
|
// NULL popup can be used to indicate default in a derived class
|
||||||
virtual void DoSetPopupControl(wxComboPopup* popup);
|
virtual void DoSetPopupControl(wxComboPopup* popup);
|
||||||
|
|
||||||
// ensures there is atleast the default popup
|
// ensures there is at least the default popup
|
||||||
void EnsurePopupControl();
|
void EnsurePopupControl();
|
||||||
|
|
||||||
// Recalculates button and textctrl areas. Called when size or button setup change.
|
// Recalculates button and textctrl areas. Called when size or button setup change.
|
||||||
@@ -711,7 +711,7 @@ protected:
|
|||||||
// draw blank button background under bitmap?
|
// draw blank button background under bitmap?
|
||||||
bool m_blankButtonBg;
|
bool m_blankButtonBg;
|
||||||
|
|
||||||
// is the popup window currenty shown?
|
// is the popup window currently shown?
|
||||||
wxByte m_popupWinState;
|
wxByte m_popupWinState;
|
||||||
|
|
||||||
// should the focus be reset to the textctrl in idle time?
|
// should the focus be reset to the textctrl in idle time?
|
||||||
@@ -831,7 +831,7 @@ public:
|
|||||||
virtual bool LazyCreate();
|
virtual bool LazyCreate();
|
||||||
|
|
||||||
//
|
//
|
||||||
// Utilies
|
// Utilities
|
||||||
//
|
//
|
||||||
|
|
||||||
// Hides the popup
|
// Hides the popup
|
||||||
|
@@ -1243,7 +1243,7 @@ public:
|
|||||||
// there is intentionally no division because we don't want to
|
// there is intentionally no division because we don't want to
|
||||||
// introduce rounding errors in time calculations
|
// introduce rounding errors in time calculations
|
||||||
|
|
||||||
// comparaison (see also operator versions below)
|
// comparison (see also operator versions below)
|
||||||
// ------------------------------------------------------------------------
|
// ------------------------------------------------------------------------
|
||||||
|
|
||||||
// is the timespan null?
|
// is the timespan null?
|
||||||
|
@@ -108,7 +108,7 @@ enum wxEndianness
|
|||||||
wxENDIAN_MAX
|
wxENDIAN_MAX
|
||||||
};
|
};
|
||||||
|
|
||||||
// informations about a linux distro returned by the lsb_release utility
|
// information about a linux distro returned by the lsb_release utility
|
||||||
struct wxLinuxDistributionInfo
|
struct wxLinuxDistributionInfo
|
||||||
{
|
{
|
||||||
wxString Id;
|
wxString Id;
|
||||||
|
@@ -9,7 +9,7 @@
|
|||||||
/////////////////////////////////////////////////////////////////////////////
|
/////////////////////////////////////////////////////////////////////////////
|
||||||
|
|
||||||
// This class closely follows the implementation of the boost
|
// This class closely follows the implementation of the boost
|
||||||
// library scoped_ptr and is an adaption for c++ macro's in
|
// library scoped_ptr and is an adaptation for c++ macro's in
|
||||||
// the wxWidgets project. The original authors of the boost
|
// the wxWidgets project. The original authors of the boost
|
||||||
// scoped_ptr are given below with their respective copyrights.
|
// scoped_ptr are given below with their respective copyrights.
|
||||||
|
|
||||||
|
@@ -362,7 +362,7 @@ public:
|
|||||||
|
|
||||||
// this function is called to compare 2 items and should return -1, 0
|
// this function is called to compare 2 items and should return -1, 0
|
||||||
// or +1 if the first item is less than, equal to or greater than the
|
// or +1 if the first item is less than, equal to or greater than the
|
||||||
// second one. The base class version performs alphabetic comparaison
|
// second one. The base class version performs alphabetic comparison
|
||||||
// of item labels (GetText)
|
// of item labels (GetText)
|
||||||
virtual int OnCompareItems(const wxTreeItemId& item1,
|
virtual int OnCompareItems(const wxTreeItemId& item1,
|
||||||
const wxTreeItemId& item2)
|
const wxTreeItemId& item2)
|
||||||
|
@@ -101,7 +101,7 @@ struct WXDLLIMPEXP_CORE wxVisualAttributes
|
|||||||
wxColour colBg;
|
wxColour colBg;
|
||||||
};
|
};
|
||||||
|
|
||||||
// different window variants, on platforms like eg mac uses different
|
// different window variants, on platforms like e.g. mac uses different
|
||||||
// rendering sizes
|
// rendering sizes
|
||||||
enum wxWindowVariant
|
enum wxWindowVariant
|
||||||
{
|
{
|
||||||
@@ -205,7 +205,7 @@ public:
|
|||||||
virtual void SetLabel(const wxString& label) = 0;
|
virtual void SetLabel(const wxString& label) = 0;
|
||||||
virtual wxString GetLabel() const = 0;
|
virtual wxString GetLabel() const = 0;
|
||||||
|
|
||||||
// the window name is used for ressource setting in X, it is not the
|
// the window name is used for resource setting in X, it is not the
|
||||||
// same as the window title/label
|
// same as the window title/label
|
||||||
virtual void SetName( const wxString &name ) { m_windowName = name; }
|
virtual void SetName( const wxString &name ) { m_windowName = name; }
|
||||||
virtual wxString GetName() const { return m_windowName; }
|
virtual wxString GetName() const { return m_windowName; }
|
||||||
@@ -508,7 +508,7 @@ public:
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Override these methods for windows that have a virtual size
|
// Override these methods for windows that have a virtual size
|
||||||
// independent of their client size. eg. the virtual area of a
|
// independent of their client size. e.g. the virtual area of a
|
||||||
// wxScrolledWindow.
|
// wxScrolledWindow.
|
||||||
|
|
||||||
virtual void DoSetVirtualSize( int x, int y );
|
virtual void DoSetVirtualSize( int x, int y );
|
||||||
@@ -526,7 +526,7 @@ public:
|
|||||||
}
|
}
|
||||||
|
|
||||||
// returns the magnification of the content of this window
|
// returns the magnification of the content of this window
|
||||||
// eg 2.0 for a window on a retina screen
|
// e.g. 2.0 for a window on a retina screen
|
||||||
virtual double GetContentScaleFactor() const;
|
virtual double GetContentScaleFactor() const;
|
||||||
|
|
||||||
// return the size of the left/right and top/bottom borders in x and y
|
// return the size of the left/right and top/bottom borders in x and y
|
||||||
@@ -842,7 +842,7 @@ public:
|
|||||||
void SetEventHandler( wxEvtHandler *handler );
|
void SetEventHandler( wxEvtHandler *handler );
|
||||||
|
|
||||||
// push/pop event handler: allows to chain a custom event handler to
|
// push/pop event handler: allows to chain a custom event handler to
|
||||||
// alreasy existing ones
|
// already existing ones
|
||||||
void PushEventHandler( wxEvtHandler *handler );
|
void PushEventHandler( wxEvtHandler *handler );
|
||||||
wxEvtHandler *PopEventHandler( bool deleteHandler = false );
|
wxEvtHandler *PopEventHandler( bool deleteHandler = false );
|
||||||
|
|
||||||
@@ -1069,7 +1069,7 @@ public:
|
|||||||
const wxRegion& GetUpdateRegion() const { return m_updateRegion; }
|
const wxRegion& GetUpdateRegion() const { return m_updateRegion; }
|
||||||
wxRegion& GetUpdateRegion() { return m_updateRegion; }
|
wxRegion& GetUpdateRegion() { return m_updateRegion; }
|
||||||
|
|
||||||
// get the update rectangleregion bounding box in client coords
|
// get the update rectangle region bounding box in client coords
|
||||||
wxRect GetUpdateClientRect() const;
|
wxRect GetUpdateClientRect() const;
|
||||||
|
|
||||||
// these functions verify whether the given point/rectangle belongs to
|
// these functions verify whether the given point/rectangle belongs to
|
||||||
|
@@ -30,7 +30,7 @@ class WXDLLIMPEXP_BASE wxClassInfo;
|
|||||||
// Enum Support
|
// Enum Support
|
||||||
//
|
//
|
||||||
// In the header files XTI requires no change from pure c++ code, however in the
|
// In the header files XTI requires no change from pure c++ code, however in the
|
||||||
// implementation, an enum needs to be enumerated eg:
|
// implementation, an enum needs to be enumerated e.g.:
|
||||||
//
|
//
|
||||||
// wxBEGIN_ENUM( wxFlavor )
|
// wxBEGIN_ENUM( wxFlavor )
|
||||||
// wxENUM_MEMBER( Vanilla )
|
// wxENUM_MEMBER( Vanilla )
|
||||||
@@ -60,7 +60,7 @@ public:
|
|||||||
int GetEnumMemberValue(const wxChar *name ) const;
|
int GetEnumMemberValue(const wxChar *name ) const;
|
||||||
|
|
||||||
// returns the name of the enum member having the passed in value
|
// returns the name of the enum member having the passed in value
|
||||||
// returns an emtpy string if not found
|
// returns an empty string if not found
|
||||||
const wxChar *GetEnumMemberName(int value) const;
|
const wxChar *GetEnumMemberName(int value) const;
|
||||||
|
|
||||||
// returns the number of members in this enum
|
// returns the number of members in this enum
|
||||||
|
@@ -12,9 +12,9 @@
|
|||||||
|
|
||||||
Header control above a collapsible pane.
|
Header control above a collapsible pane.
|
||||||
|
|
||||||
The collapsible header usually constists of a small indicator of the
|
The collapsible header usually consists of a small indicator of the
|
||||||
collapsed state and the label text beside it.
|
collapsed state and the label text beside it.
|
||||||
This class is used by the generic implemetation of wxCollapsiblePane but
|
This class is used by the generic implementation of wxCollapsiblePane but
|
||||||
maybe used in more complex layouts for other uses.
|
maybe used in more complex layouts for other uses.
|
||||||
|
|
||||||
@beginEventTable{wxCommandEvent}
|
@beginEventTable{wxCommandEvent}
|
||||||
@@ -65,7 +65,7 @@ public:
|
|||||||
const wxString& name = wxCollapsibleHeaderCtrlNameStr);
|
const wxString& name = wxCollapsibleHeaderCtrlNameStr);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
Set collpased state of the header.
|
Set collapsed state of the header.
|
||||||
*/
|
*/
|
||||||
virtual void SetCollapsed(bool collapsed = true);
|
virtual void SetCollapsed(bool collapsed = true);
|
||||||
|
|
||||||
|
@@ -716,7 +716,7 @@ public:
|
|||||||
@beginWxPerlOnly
|
@beginWxPerlOnly
|
||||||
In wxPerl @a templates is a reference to a list of templates.
|
In wxPerl @a templates is a reference to a list of templates.
|
||||||
If you override this method in your document manager it must
|
If you override this method in your document manager it must
|
||||||
return two values, eg:
|
return two values, e.g.:
|
||||||
|
|
||||||
@code
|
@code
|
||||||
(doctemplate, path) = My::DocManager->SelectDocumentPath(...);
|
(doctemplate, path) = My::DocManager->SelectDocumentPath(...);
|
||||||
@@ -1302,7 +1302,7 @@ public:
|
|||||||
Calls wxView::Close() and deletes each view. Deleting the final view
|
Calls wxView::Close() and deletes each view. Deleting the final view
|
||||||
will implicitly delete the document itself, because the wxView
|
will implicitly delete the document itself, because the wxView
|
||||||
destructor calls RemoveView(). This in turns calls OnChangedViewList(),
|
destructor calls RemoveView(). This in turns calls OnChangedViewList(),
|
||||||
whose default implemention is to save and delete the document if no
|
whose default implementation is to save and delete the document if no
|
||||||
views exist.
|
views exist.
|
||||||
*/
|
*/
|
||||||
virtual bool DeleteAllViews();
|
virtual bool DeleteAllViews();
|
||||||
|
@@ -626,7 +626,7 @@ public:
|
|||||||
@class wxGridCellEnumEditor
|
@class wxGridCellEnumEditor
|
||||||
|
|
||||||
Grid cell editor which displays an enum number as a textual equivalent
|
Grid cell editor which displays an enum number as a textual equivalent
|
||||||
(eg. data in cell is 0,1,2 ... n the cell could be displayed as
|
(e.g. data in cell is 0,1,2 ... n the cell could be displayed as
|
||||||
"John","Fred"..."Bob" in the combo choice box).
|
"John","Fred"..."Bob" in the combo choice box).
|
||||||
|
|
||||||
@library{wxadv}
|
@library{wxadv}
|
||||||
@@ -1741,8 +1741,8 @@ public:
|
|||||||
/*!
|
/*!
|
||||||
@name Table Row and Column Labels
|
@name Table Row and Column Labels
|
||||||
|
|
||||||
By default the numbers are used for labeling rows and Latin letters for
|
By default the numbers are used for labelling rows and Latin letters for
|
||||||
labeling columns. If the table has more than 26 columns, the pairs of
|
labelling columns. If the table has more than 26 columns, the pairs of
|
||||||
letters are used starting from the 27-th one and so on, i.e. the
|
letters are used starting from the 27-th one and so on, i.e. the
|
||||||
sequence of labels is A, B, ..., Z, AA, AB, ..., AZ, BA, ..., ..., ZZ,
|
sequence of labels is A, B, ..., Z, AA, AB, ..., AZ, BA, ..., ..., ZZ,
|
||||||
AAA, ...
|
AAA, ...
|
||||||
|
@@ -134,7 +134,7 @@ public:
|
|||||||
associated with this log record.
|
associated with this log record.
|
||||||
|
|
||||||
@return
|
@return
|
||||||
The formated message.
|
The formatted message.
|
||||||
|
|
||||||
@note
|
@note
|
||||||
Time stamping is disabled for Visual C++ users in debug builds by
|
Time stamping is disabled for Visual C++ users in debug builds by
|
||||||
@@ -157,7 +157,7 @@ protected:
|
|||||||
Time to format.
|
Time to format.
|
||||||
|
|
||||||
@return
|
@return
|
||||||
The formated time string, may be empty.
|
The formatted time string, may be empty.
|
||||||
*/
|
*/
|
||||||
virtual wxString FormatTime(time_t time) const;
|
virtual wxString FormatTime(time_t time) const;
|
||||||
};
|
};
|
||||||
|
@@ -447,7 +447,7 @@ public:
|
|||||||
...);
|
...);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
Constuctor using an array of string elements corresponding to the
|
Constructor using an array of string elements corresponding to the
|
||||||
parameters of the ctor above in the same order.
|
parameters of the ctor above in the same order.
|
||||||
*/
|
*/
|
||||||
wxFileTypeInfo(const wxArrayString& sArray);
|
wxFileTypeInfo(const wxArrayString& sArray);
|
||||||
|
@@ -268,7 +268,7 @@ public:
|
|||||||
|
|
||||||
@param rect
|
@param rect
|
||||||
The portion inside of the window. Setting with an empty wxRect will
|
The portion inside of the window. Setting with an empty wxRect will
|
||||||
restore the default diaplay of the thumbnail.
|
restore the default display of the thumbnail.
|
||||||
*/
|
*/
|
||||||
virtual void SetThumbnailClip(const wxRect& rect);
|
virtual void SetThumbnailClip(const wxRect& rect);
|
||||||
|
|
||||||
|
Reference in New Issue
Block a user