Mirrors_UI_SDK/wxWidgets
1
0
Fork 0
mirror of https://github.com/wxWidgets/wxWidgets.git synced 2026-09-25 00:43:39 +08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Merge branch 'doc-fixes'

Browse Source 
Fix many inconsistencies between real and interface headers.

See #25531, #25626.
This commit is contained in:
Vadim Zeitlin
2025-07-16 01:32:52 +02:00
parent ea87876f50 7c7bd14259
commit 608b38eff3
8 changed files with 52 additions and 375 deletions
Download Patch File Download Diff File Expand all files Collapse all files
interface/wx/aui/auibar.h
+16 -2
View File
@@ -537,13 +537,27 @@ public:
const wxRect& rect,
int state) = 0;
/**
Return the size of the label for the given item.
Note that the type of @a dc was wxDC until wxWidgets 3.3.0, where it
was changed to wxReadOnlyDC as this function doesn't modify the DC
contents.
*/
virtual wxSize GetLabelSize(
wxDC& dc,
wxReadOnlyDC& dc,
wxWindow* wnd,
const wxAuiToolBarItem& item) = 0;
/**
Return the size of the given item.
Note that the type of @a dc was wxDC until wxWidgets 3.3.0, where it
was changed to wxReadOnlyDC as this function doesn't modify the DC
contents.
*/
virtual wxSize GetToolSize(
wxDC& dc,
wxReadOnlyDC& dc,
wxWindow* wnd,
const wxAuiToolBarItem& item) = 0;
interface/wx/bmpcbox.h
+6 -6
View File
@@ -138,20 +138,20 @@ public:
Adds the item to the end of the combo box.
*/
int Append(const wxString& item,
const wxBitmap& bitmap = wxNullBitmap);
const wxBitmapBundle& bitmap = wxBitmapBundle());
/**
Adds the item to the end of the combo box, associating the given
untyped, client data pointer @a clientData with the item.
*/
int Append(const wxString& item, const wxBitmap& bitmap,
int Append(const wxString& item, const wxBitmapBundle& bitmap,
void* clientData);
/**
Adds the item to the end of the combo box, associating the given typed
client data pointer @a clientData with the item.
*/
int Append(const wxString& item, const wxBitmap& bitmap,
int Append(const wxString& item, const wxBitmapBundle& bitmap,
wxClientData* clientData);
/**
@@ -193,7 +193,7 @@ public:
Inserts the item into the list before @a pos.
Not valid for @c wxCB_SORT style, use Append() instead.
*/
int Insert(const wxString& item, const wxBitmap& bitmap,
int Insert(const wxString& item, const wxBitmapBundle& bitmap,
unsigned int pos);
/**
@@ -201,7 +201,7 @@ public:
untyped, client data pointer with the item.
Not valid for @c wxCB_SORT style, use Append() instead.
*/
int Insert(const wxString& item, const wxBitmap& bitmap,
int Insert(const wxString& item, const wxBitmapBundle& bitmap,
unsigned int pos,
void* clientData);
@@ -210,7 +210,7 @@ public:
client data pointer with the item.
Not valid for @c wxCB_SORT style, use Append() instead.
*/
int Insert(const wxString& item, const wxBitmap& bitmap,
int Insert(const wxString& item, const wxBitmapBundle& bitmap,
unsigned int pos,
wxClientData* clientData);
interface/wx/dataview.h
+6 -6
View File
@@ -3109,14 +3109,14 @@ public:
after adding any items to the control (or, conversely, items must not
be added before the columns are set up).
*/
void AppendItem( const wxVector<wxVariant> &values, wxUIntPtr data = nullptr );
void AppendItem( const wxVector<wxVariant> &values, wxUIntPtr data = 0 );
/**
Prepends an item (i.e.\ a row) to the control.
See remarks for AppendItem() for preconditions of this method.
*/
void PrependItem( const wxVector<wxVariant> &values, wxUIntPtr data = nullptr );
void PrependItem( const wxVector<wxVariant> &values, wxUIntPtr data = 0 );
/**
Inserts an item (i.e.\ a row) to the control.
@@ -3126,7 +3126,7 @@ public:
Additionally, @a row must be less than or equal to the current number
of items in the control (see GetItemCount()).
*/
void InsertItem( unsigned int row, const wxVector<wxVariant> &values, wxUIntPtr data = nullptr );
void InsertItem( unsigned int row, const wxVector<wxVariant> &values, wxUIntPtr data = 0 );
/**
Delete the row at position @a row.
@@ -3498,7 +3498,7 @@ public:
in number and type. No (default) values are filled in
automatically.
*/
void AppendItem( const wxVector<wxVariant> &values, wxUIntPtr data = nullptr );
void AppendItem( const wxVector<wxVariant> &values, wxUIntPtr data = 0 );
/**
Prepends an item (=row) and fills it with @a values.
@@ -3507,7 +3507,7 @@ public:
in number and type. No (default) values are filled in
automatically.
*/
void PrependItem( const wxVector<wxVariant> &values, wxUIntPtr data = nullptr );
void PrependItem( const wxVector<wxVariant> &values, wxUIntPtr data = 0 );
/**
Inserts an item (=row) and fills it with @a values.
@@ -3516,7 +3516,7 @@ public:
in number and type. No (default) values are filled in
automatically.
*/
void InsertItem( unsigned int row, const wxVector<wxVariant> &values, wxUIntPtr data = nullptr );
void InsertItem( unsigned int row, const wxVector<wxVariant> &values, wxUIntPtr data = 0 );
/**
Delete the item (=row) at position @a pos.
interface/wx/dc.h
+5 -1
View File
@@ -118,6 +118,10 @@ struct wxFontMetrics
Objects of this class can't be created directly, please see wxDC for the
description of how to create objects of the derived classes.
Please note that all wxWidgets functions taking parameters of this type
added before wxWidgets 3.3.0 used to take wxDC instead and that they can
still be called with wxDC objects, as wxDC inherits from wxReadOnlyDC.
@since 3.3.0
*/
class wxReadOnlyDC : public wxObject
@@ -129,7 +133,7 @@ public:
bool IsOk() const;
/**
@name query capabilities
@name Query capabilities
*/
///@{
interface/wx/propgrid/property.h
-9
View File
@@ -1282,15 +1282,6 @@ public:
*/
int AddChoice( const wxString& label, int value = wxPG_INVALID_VALUE );
/**
Adds a private child property.
@deprecated Use AddPrivateChild() instead.
@see AddPrivateChild()
*/
void AddChild( wxPGProperty* prop );
/**
Adds a private child property. If you use this instead of
wxPropertyGridInterface::Insert() or
interface/wx/propgrid/propgridpagestate.h
+2 -1
View File
@@ -435,7 +435,8 @@ public:
*/
virtual void DoSetSplitter( int pos,
int splitterColumn = 0,
wxPGSplitterPositionFlags flags = 0 );
wxPGSplitterPositionFlags flags =
wxPGSplitterPositionFlags::Null );
bool EnableCategories( bool enable );
interface/wx/ribbon/art.h
+13 -346
View File
@@ -740,7 +740,7 @@ public:
than or equal to zero, which is the minimum pixel width for the tab.
*/
virtual void GetBarTabWidth(
wxDC& dc,
wxReadOnlyDC& dc,
wxWindow* wnd,
const wxString& label,
const wxBitmap& bitmap,
@@ -763,7 +763,7 @@ public:
The tabs which will acquire the returned height.
*/
virtual int GetTabCtrlHeight(
wxDC& dc,
wxReadOnlyDC& dc,
wxWindow* wnd,
const wxRibbonPageTabInfoArray& pages) = 0;
@@ -781,7 +781,7 @@ public:
regardless of its state).
*/
virtual wxSize GetScrollButtonMinimumSize(
wxDC& dc,
wxReadOnlyDC& dc,
wxWindow* wnd,
long style) = 0;
@@ -803,7 +803,7 @@ public:
@see GetPanelClientSize()
*/
virtual wxSize GetPanelSize(
wxDC& dc,
wxReadOnlyDC& dc,
const wxRibbonPanel* wnd,
wxSize client_size,
wxPoint* client_offset) = 0;
@@ -826,7 +826,7 @@ public:
@see GetPanelSize()
*/
virtual wxSize GetPanelClientSize(
wxDC& dc,
wxReadOnlyDC& dc,
const wxRibbonPanel* wnd,
wxSize size,
wxPoint* client_offset) = 0;
@@ -844,7 +844,7 @@ public:
@since 2.9.4
*/
virtual wxRect GetPanelExtButtonArea(
wxDC& dc,
wxReadOnlyDC& dc,
const wxRibbonPanel* wnd,
wxRect rect) = 0;
@@ -863,7 +863,7 @@ public:
@see GetGalleryClientSize()
*/
virtual wxSize GetGallerySize(
wxDC& dc,
wxReadOnlyDC& dc,
const wxRibbonGallery* wnd,
wxSize client_size) = 0;
@@ -893,7 +893,7 @@ public:
occupies.
*/
virtual wxSize GetGalleryClientSize(
wxDC& dc,
wxReadOnlyDC& dc,
const wxRibbonGallery* wnd,
wxSize size,
wxPoint* client_offset,
@@ -919,7 +919,7 @@ public:
The size of the page after the resize.
*/
virtual wxRect GetPageBackgroundRedrawArea(
wxDC& dc,
wxReadOnlyDC& dc,
const wxRibbonPage* wnd,
wxSize page_old_size,
wxSize page_new_size) = 0;
@@ -959,7 +959,7 @@ public:
@return @true if a size exists for the button, @false otherwise.
*/
virtual bool GetButtonBarButtonSize(
wxDC& dc,
wxReadOnlyDC& dc,
wxWindow* wnd,
wxRibbonButtonKind kind,
wxRibbonButtonBarButtonState size,
@@ -995,7 +995,7 @@ public:
@since 3.1.2
*/
virtual wxCoord GetButtonBarButtonTextWidth(
wxDC& dc, const wxString& label,
wxReadOnlyDC& dc, const wxString& label,
wxRibbonButtonKind kind,
wxRibbonButtonBarButtonState size) = 0;
@@ -1015,7 +1015,7 @@ public:
minimised panel (@c wxEAST or @c wxSOUTH depending on the style).
*/
virtual wxSize GetMinimisedPanelMinimumSize(
wxDC& dc,
wxReadOnlyDC& dc,
const wxRibbonPanel* wnd,
wxSize* desired_bitmap_size,
wxDirection* expanded_panel_direction) = 0;
@@ -1040,7 +1040,7 @@ public:
size which counts as the dropdown part.
*/
virtual wxSize GetToolSize(
wxDC& dc,
wxReadOnlyDC& dc,
wxWindow* wnd,
wxSize bitmap_size,
wxRibbonButtonKind kind,
@@ -1075,210 +1075,6 @@ class wxRibbonMSWArtProvider : public wxRibbonArtProvider
{
public:
wxRibbonMSWArtProvider(bool set_colour_scheme = true);
virtual ~wxRibbonMSWArtProvider();
wxRibbonArtProvider* Clone() const;
void SetFlags(long flags);
long GetFlags() const;
int GetMetric(int id) const;
void SetMetric(int id, int new_val);
void SetFont(int id, const wxFont& font);
wxFont GetFont(int id) const;
wxColour GetColour(int id) const;
void SetColour(int id, const wxColour& colour);
void GetColourScheme(wxColour* primary,
wxColour* secondary,
wxColour* tertiary) const;
void SetColourScheme(const wxColour& primary,
const wxColour& secondary,
const wxColour& tertiary);
int GetTabCtrlHeight(
wxDC& dc,
wxWindow* wnd,
const wxRibbonPageTabInfoArray& pages);
void DrawTabCtrlBackground(
wxDC& dc,
wxWindow* wnd,
const wxRect& rect);
void DrawTab(wxDC& dc,
wxWindow* wnd,
const wxRibbonPageTabInfo& tab);
void DrawTabSeparator(
wxDC& dc,
wxWindow* wnd,
const wxRect& rect,
double visibility);
void DrawPageBackground(
wxDC& dc,
wxWindow* wnd,
const wxRect& rect);
void DrawScrollButton(
wxDC& dc,
wxWindow* wnd,
const wxRect& rect,
long style);
void DrawPanelBackground(
wxDC& dc,
wxRibbonPanel* wnd,
const wxRect& rect);
void DrawGalleryBackground(
wxDC& dc,
wxRibbonGallery* wnd,
const wxRect& rect);
void DrawGalleryItemBackground(
wxDC& dc,
wxRibbonGallery* wnd,
const wxRect& rect,
wxRibbonGalleryItem* item);
void DrawMinimisedPanel(
wxDC& dc,
wxRibbonPanel* wnd,
const wxRect& rect,
wxBitmap& bitmap);
void DrawButtonBarBackground(
wxDC& dc,
wxWindow* wnd,
const wxRect& rect);
void DrawButtonBarButton(
wxDC& dc,
wxWindow* wnd,
const wxRect& rect,
wxRibbonButtonKind kind,
long state,
const wxString& label,
const wxBitmap& bitmap_large,
const wxBitmap& bitmap_small);
void DrawToolBarBackground(
wxDC& dc,
wxWindow* wnd,
const wxRect& rect);
void DrawToolGroupBackground(
wxDC& dc,
wxWindow* wnd,
const wxRect& rect);
void DrawTool(
wxDC& dc,
wxWindow* wnd,
const wxRect& rect,
const wxBitmap& bitmap,
wxRibbonButtonKind kind,
long state);
void DrawToggleButton(
wxDC& dc,
wxRibbonBar* wnd,
const wxRect& rect,
wxRibbonDisplayMode mode);
void DrawHelpButton(wxDC& dc,
wxRibbonBar* wnd,
const wxRect& rect);
void GetBarTabWidth(
wxDC& dc,
wxWindow* wnd,
const wxString& label,
const wxBitmap& bitmap,
int* ideal,
int* small_begin_need_separator,
int* small_must_have_separator,
int* minimum);
wxSize GetScrollButtonMinimumSize(
wxDC& dc,
wxWindow* wnd,
long style);
wxSize GetPanelSize(
wxDC& dc,
const wxRibbonPanel* wnd,
wxSize client_size,
wxPoint* client_offset);
wxSize GetPanelClientSize(
wxDC& dc,
const wxRibbonPanel* wnd,
wxSize size,
wxPoint* client_offset);
wxRect GetPanelExtButtonArea(
wxDC& dc,
const wxRibbonPanel* wnd,
wxRect rect);
wxSize GetGallerySize(
wxDC& dc,
const wxRibbonGallery* wnd,
wxSize client_size);
wxSize GetGalleryClientSize(
wxDC& dc,
const wxRibbonGallery* wnd,
wxSize size,
wxPoint* client_offset,
wxRect* scroll_up_button,
wxRect* scroll_down_button,
wxRect* extension_button);
wxRect GetPageBackgroundRedrawArea(
wxDC& dc,
const wxRibbonPage* wnd,
wxSize page_old_size,
wxSize page_new_size);
bool GetButtonBarButtonSize(
wxDC& dc,
wxWindow* wnd,
wxRibbonButtonKind kind,
wxRibbonButtonBarButtonState size,
const wxString& label,
wxCoord text_min_width,
wxSize bitmap_size_large,
wxSize bitmap_size_small,
wxSize* button_size,
wxRect* normal_region,
wxRect* dropdown_region);
wxCoord GetButtonBarButtonTextWidth(
wxDC& dc,
const wxString& label,
wxRibbonButtonKind kind,
wxRibbonButtonBarButtonState size);
wxSize GetMinimisedPanelMinimumSize(
wxDC& dc,
const wxRibbonPanel* wnd,
wxSize* desired_bitmap_size,
wxDirection* expanded_panel_direction);
wxSize GetToolSize(
wxDC& dc,
wxWindow* wnd,
wxSize bitmap_size,
wxRibbonButtonKind kind,
bool is_first,
bool is_last,
wxRect* dropdown_region);
wxRect GetBarToggleButtonArea(const wxRect& rect);
wxRect GetRibbonHelpButtonArea(const wxRect& rect);
};
@@ -1286,133 +1082,4 @@ class wxRibbonAUIArtProvider : public wxRibbonMSWArtProvider
{
public:
wxRibbonAUIArtProvider();
virtual ~wxRibbonAUIArtProvider();
wxRibbonArtProvider* Clone() const;
wxColour GetColour(int id) const;
void SetColour(int id, const wxColour& colour);
void SetColourScheme(const wxColour& primary,
const wxColour& secondary,
const wxColour& tertiary);
void SetFont(int id, const wxFont& font);
wxSize GetScrollButtonMinimumSize(
wxDC& dc,
wxWindow* wnd,
long style);
void DrawScrollButton(
wxDC& dc,
wxWindow* wnd,
const wxRect& rect,
long style);
wxSize GetPanelSize(
wxDC& dc,
const wxRibbonPanel* wnd,
wxSize client_size,
wxPoint* client_offset);
wxSize GetPanelClientSize(
wxDC& dc,
const wxRibbonPanel* wnd,
wxSize size,
wxPoint* client_offset);
wxRect GetPanelExtButtonArea(
wxDC& dc,
const wxRibbonPanel* wnd,
wxRect rect);
void DrawTabCtrlBackground(
wxDC& dc,
wxWindow* wnd,
const wxRect& rect);
int GetTabCtrlHeight(
wxDC& dc,
wxWindow* wnd,
const wxRibbonPageTabInfoArray& pages);
void GetBarTabWidth(
wxDC& dc,
wxWindow* wnd,
const wxString& label,
const wxBitmap& bitmap,
int* ideal,
int* small_begin_need_separator,
int* small_must_have_separator,
int* minimum);
void DrawTab(wxDC& dc,
wxWindow* wnd,
const wxRibbonPageTabInfo& tab);
void DrawTabSeparator(
wxDC& dc,
wxWindow* wnd,
const wxRect& rect,
double visibility);
void DrawPageBackground(
wxDC& dc,
wxWindow* wnd,
const wxRect& rect);
void DrawPanelBackground(
wxDC& dc,
wxRibbonPanel* wnd,
const wxRect& rect);
void DrawMinimisedPanel(
wxDC& dc,
wxRibbonPanel* wnd,
const wxRect& rect,
wxBitmap& bitmap);
void DrawGalleryBackground(
wxDC& dc,
wxRibbonGallery* wnd,
const wxRect& rect);
void DrawGalleryItemBackground(
wxDC& dc,
wxRibbonGallery* wnd,
const wxRect& rect,
wxRibbonGalleryItem* item);
void DrawButtonBarBackground(
wxDC& dc,
wxWindow* wnd,
const wxRect& rect);
void DrawButtonBarButton(
wxDC& dc,
wxWindow* wnd,
const wxRect& rect,
wxRibbonButtonKind kind,
long state,
const wxString& label,
const wxBitmap& bitmap_large,
const wxBitmap& bitmap_small);
void DrawToolBarBackground(
wxDC& dc,
wxWindow* wnd,
const wxRect& rect);
void DrawToolGroupBackground(
wxDC& dc,
wxWindow* wnd,
const wxRect& rect);
void DrawTool(
wxDC& dc,
wxWindow* wnd,
const wxRect& rect,
const wxBitmap& bitmap,
wxRibbonButtonKind kind,
long state);
};
interface/wx/xml/xml.h
+4 -4
View File
@@ -565,10 +565,10 @@ enum wxXmlDocumentLoadFlag
*/
struct wxXmlParseError
{
wxString message; ///< Error description
int line; ///< Line number where error occurred
int column; ///< Column number where error occurred
int byte_offset; ///< Byte offset where error occurred
wxString message; ///< Error description
int line = 0; ///< Line number where error occurred
int column = 0; ///< Column number where error occurred
wxFileOffset offset = 0;///< Byte offset where error occurred
};