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

final prototype fixes to a*h headers; s/WXTYPE/wxEventType

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52815 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Francesco Montorsi
2008-03-25 16:01:21 +00:00
parent 222180ffe9
commit 1d497b996f
8 changed files with 83 additions and 107 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
interface/archive.h
View File

@@ -127,7 +127,7 @@ public:
thing read from @a stream. thing read from @a stream.
*/ */
virtual bool CopyEntry(wxArchiveEntry* entry, virtual bool CopyEntry(wxArchiveEntry* entry,
wxArchiveInputStream& stream); wxArchiveInputStream& stream) = 0;
/** /**
Create a new directory entry (see wxArchiveEntry::IsDir) with the given Create a new directory entry (see wxArchiveEntry::IsDir) with the given
@@ -137,13 +137,13 @@ public:
a name with a trailing path separator. a name with a trailing path separator.
*/ */
virtual bool PutNextDirEntry(const wxString& name, virtual bool PutNextDirEntry(const wxString& name,
const wxDateTime& dt = wxDateTime::Now()); const wxDateTime& dt = wxDateTime::Now()) = 0;
/** /**
Takes ownership of entry and uses it to create a new entry in the archive. Takes ownership of entry and uses it to create a new entry in the archive.
The entry's data can then be written by writing to this wxArchiveOutputStream. The entry's data can then be written by writing to this wxArchiveOutputStream.
*/ */
virtual bool PutNextEntry(wxArchiveEntry* entry); virtual bool PutNextEntry(wxArchiveEntry* entry) = 0;
/** /**
Create a new entry with the given name, timestamp and size. The entry's Create a new entry with the given name, timestamp and size. The entry's
@@ -151,7 +151,7 @@ public:
*/ */
virtual bool PutNextEntry(const wxString& name, virtual bool PutNextEntry(const wxString& name,
const wxDateTime& dt = wxDateTime::Now(), const wxDateTime& dt = wxDateTime::Now(),
wxFileOffset size = wxInvalidOffset); wxFileOffset size = wxInvalidOffset) = 0;
}; };
@@ -219,7 +219,7 @@ public:
@see GetName() @see GetName()
*/ */
virtual void SetName(const wxString& name, virtual void SetName(const wxString& name,
wxPathFormat format = wxPATH_NATIVE); wxPathFormat format = wxPATH_NATIVE) = 0;
/** /**
Returns the size of the entry's data in bytes. Returns the size of the entry's data in bytes.

38
interface/aui/auibook.h
View File

@@ -269,30 +269,21 @@ public:
/** /**
Draws a button. Draws a button.
*/ */
void DrawButton(wxDC& dc, wxWindow* wnd, const wxRect& in_rect, virtual void DrawButton(wxDC& dc, wxWindow* wnd, const wxRect& in_rect,
int bitmap_id, int bitmap_id, int button_state, int orientation,
int button_state, wxRect* out_rect) = 0;
int orientation,
const wxBitmap& bitmap_override,
wxRect* out_rect);
/** /**
Draws a tab. Draws a tab.
*/ */
void DrawTab(wxDC& dc, wxWindow* wnd, const wxRect& in_rect, virtual void DrawTab(wxDC& dc, wxWindow* wnd, const wxAuiNotebookPage& page,
const wxString& caption, const wxRect& rect, int close_button_state,
const wxBitmap& bitmap, wxRect* out_tab_rect, wxRect* out_button_rect, int* x_extent) = 0;
bool active,
int close_button_state,
wxRect* out_tab_rect,
wxRect* out_button_rect,
int* x_extent);
/** /**
Returns the tab control size. Returns the tab control size.
*/ */
int GetBestTabCtrlSize(wxWindow* wnd, virtual int GetBestTabCtrlSize(wxWindow*, const wxAuiNotebookPageArray&, const wxSize&) = 0;
wxAuiNotebookPageArray& pages);
/** /**
Returns the indent size. Returns the indent size.
@@ -302,12 +293,9 @@ public:
/** /**
Returns the tab size for the given caption, bitmap and state. Returns the tab size for the given caption, bitmap and state.
*/ */
wxSize GetTabSize(wxDC& dc, wxWindow* wnd, virtual wxSize GetTabSize(wxDC& dc, wxWindow* wnd, const wxString& caption,
const wxString& caption, const wxBitmap& bitmap, bool active,
const wxBitmap& bitmap, int close_button_state, int* x_extent) = 0;
bool active,
int close_button_state,
int* x_extent);
/** /**
Sets flags. Sets flags.
@@ -333,11 +321,5 @@ public:
Sets sizing information. Sets sizing information.
*/ */
virtual void SetSizingInfo(const wxSize& tab_ctrl_size, size_t tab_count) = 0; virtual void SetSizingInfo(const wxSize& tab_ctrl_size, size_t tab_count) = 0;
/**
Pops up a menu to show the list of windows managed by wxAui.
*/
int ShowWindowList(wxWindow* wnd, const wxArrayString& items,
int active_idx);
}; };

34
interface/aui/dockart.h
View File

@@ -108,49 +108,41 @@ public:
/** /**
Draws a background. Draws a background.
*/ */
virtual void DrawBackground(wxDC& dc, wxWindow* window, virtual void DrawBackground(wxDC& dc, wxWindow* window, int orientation,
int orientation, const wxRect& rect) = 0;
const wxRect& rect);
/** /**
Draws a border. Draws a border.
*/ */
virtual void DrawBorder(wxDC& dc, wxWindow* window, virtual void DrawBorder(wxDC& dc, wxWindow* window, const wxRect& rect,
const wxRect& rect, wxAuiPaneInfo& pane) = 0;
wxAuiPaneInfo& pane);
/** /**
Draws a caption. Draws a caption.
*/ */
virtual void DrawCaption(wxDC& dc, wxWindow* window, virtual void DrawCaption(wxDC& dc, wxWindow* window, const wxString& text,
const wxString& text, const wxRect& rect, wxAuiPaneInfo& pane) = 0;
const wxRect& rect,
wxAuiPaneInfo& pane);
/** /**
Draws a gripper. Draws a gripper.
*/ */
virtual void DrawGripper(wxDC& dc, wxWindow* window, virtual void DrawGripper(wxDC& dc, wxWindow* window, const wxRect& rect,
const wxRect& rect, wxAuiPaneInfo& pane) = 0;
wxAuiPaneInfo& pane);
/** /**
Draws a button in the pane's title bar. Draws a button in the pane's title bar.
@a button can be one of the values of @b wxAuiButtonId. @a button can be one of the values of @b wxAuiButtonId.
@a button_state can be one of the values of @b wxAuiPaneButtonState. @a button_state can be one of the values of @b wxAuiPaneButtonState.
*/ */
virtual void DrawPaneButton(wxDC& dc, wxWindow* window, virtual void DrawPaneButton(wxDC& dc, wxWindow* window, int button,
int button, int button_state, const wxRect& rect,
int button_state, wxAuiPaneInfo& pane) = 0;
const wxRect& rect,
wxAuiPaneInfo& pane);
/** /**
Draws a sash between two windows. Draws a sash between two windows.
*/ */
virtual void DrawSash(wxDC& dc, wxWindow* window, virtual void DrawSash(wxDC& dc, wxWindow* window, int orientation,
int orientation, const wxRect& rect) = 0;
const wxRect& rect);
/** /**
Get the colour of a certain setting. Get the colour of a certain setting.
@a id can be one of the colour values of @b wxAuiPaneDockArtSetting. @a id can be one of the colour values of @b wxAuiPaneDockArtSetting.

18
interface/aui/framemanager.h
View File

@@ -241,13 +241,6 @@ public:
bool LoadPerspective(const wxString& perspective, bool LoadPerspective(const wxString& perspective,
bool update = true); bool update = true);
/**
ProcessDockResult() is a protected member of the wxAUI layout manager.
It can be overridden by derived classes to provide custom docking calculations.
*/
bool ProcessDockResult(wxAuiPaneInfo& target,
const wxAuiPaneInfo& new_pos);
/** /**
SavePaneInfo() is similar to SavePerspective, with the exception that it only SavePaneInfo() is similar to SavePerspective, with the exception that it only
saves information about a single pane. It is used in combination with saves information about a single pane. It is used in combination with
@@ -328,6 +321,15 @@ public:
pane flicker to be avoided by updating the whole layout at one time. pane flicker to be avoided by updating the whole layout at one time.
*/ */
void Update(); void Update();
protected:
/**
ProcessDockResult() is a protected member of the wxAUI layout manager.
It can be overridden by derived classes to provide custom docking calculations.
*/
virtual bool ProcessDockResult(wxAuiPaneInfo& target,
const wxAuiPaneInfo& new_pos);
}; };
@@ -764,6 +766,6 @@ public:
/** /**
Makes a copy of the wxAuiPaneInfo object. Makes a copy of the wxAuiPaneInfo object.
*/ */
wxAuiPaneInfo& operator operator=(const wxAuiPaneInfo& c); wxAuiPaneInfo& operator=(const wxAuiPaneInfo& c);
}; };

4
interface/checkbox.h
View File

@@ -75,7 +75,7 @@ public:
const wxPoint& pos = wxDefaultPosition, const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize, const wxSize& size = wxDefaultSize,
long style = 0, long style = 0,
const wxValidator& val, const wxValidator& val = wxDefaultValidator,
const wxString& name = "checkBox"); const wxString& name = "checkBox");
//@} //@}
@@ -93,7 +93,7 @@ public:
const wxPoint& pos = wxDefaultPosition, const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize, const wxSize& size = wxDefaultSize,
long style = 0, long style = 0,
const wxValidator& val, const wxValidator& val = wxDefaultValidator,
const wxString& name = "checkBox"); const wxString& name = "checkBox");
/** /**

58
interface/datetime.h
View File

@@ -25,7 +25,7 @@ public:
Same as @ref setdate() Set Same as @ref setdate() Set
*/ */
wxDateTime(wxDateTime_t day, Month month = Inv_Month, wxDateTime(wxDateTime_t day, Month month = Inv_Month,
int Inv_Year, wxDateTime_t hour = 0, int year = Inv_Year, wxDateTime_t hour = 0,
wxDateTime_t minute = 0, wxDateTime_t minute = 0,
wxDateTime_t second = 0, wxDateTime_t second = 0,
wxDateTime_t millisec = 0); wxDateTime_t millisec = 0);
@@ -322,7 +322,7 @@ public:
DOS DOS
format. format.
*/ */
unsigned long GetAsDOS() const; long unsigned int GetAsDOS() const;
/** /**
Get the beginning of DST for the given country in the given year (current one Get the beginning of DST for the given country in the given year (current one
@@ -370,13 +370,13 @@ public:
/** /**
Returns the day in the given timezone (local one by default). Returns the day in the given timezone (local one by default).
*/ */
wxDateTime_t GetDay(const TimeZone& tz = Local) const; short unsigned int GetDay(const TimeZone& tz = Local) const;
/** /**
Returns the day of the year (in 1...366 range) in the given timezone Returns the day of the year (in 1...366 range) in the given timezone
(local one by default). (local one by default).
*/ */
wxDateTime_t GetDayOfYear(const TimeZone& tz = Local) const; short unsigned int GetDayOfYear(const TimeZone& tz = Local) const;
/** /**
Returns the end of DST for the given country in the given year (current one by Returns the end of DST for the given country in the given year (current one by
@@ -390,7 +390,7 @@ public:
/** /**
Returns the hour in the given timezone (local one by default). Returns the hour in the given timezone (local one by default).
*/ */
wxDateTime_t GetHour(const TimeZone& tz = Local) const; short unsigned int GetHour(const TimeZone& tz = Local) const;
/** /**
Synonym for GetJulianDayNumber(). Synonym for GetJulianDayNumber().
@@ -428,12 +428,12 @@ public:
/** /**
Returns the milliseconds in the given timezone (local one by default). Returns the milliseconds in the given timezone (local one by default).
*/ */
wxDateTime_t GetMillisecond(const TimeZone& tz = Local) const; short unsigned int GetMillisecond(const TimeZone& tz = Local) const;
/** /**
Returns the minute in the given timezone (local one by default). Returns the minute in the given timezone (local one by default).
*/ */
wxDateTime_t GetMinute(const TimeZone& tz = Local) const; short unsigned int GetMinute(const TimeZone& tz = Local) const;
/** /**
Returns the @e Modified Julian Day Number (MJD) which is, by definition, Returns the @e Modified Julian Day Number (MJD) which is, by definition,
@@ -493,7 +493,7 @@ public:
/** /**
Returns the seconds in the given timezone (local one by default). Returns the seconds in the given timezone (local one by default).
*/ */
wxDateTime_t GetSecond(const TimeZone& tz = Local) const; short unsigned int GetSecond(const TimeZone& tz = Local) const;
/** /**
Returns the number of seconds since Jan 1, 1970. An assert failure will occur Returns the number of seconds since Jan 1, 1970. An assert failure will occur
@@ -579,7 +579,7 @@ public:
Returns the copy of this object to which Returns the copy of this object to which
SetToYearDay() was applied. SetToYearDay() was applied.
*/ */
wxDateTime GetYearDay(wxDateTime_t yday) const; wxDateTime GetYearDay(short unsigned int) const;
/** /**
Returns @true if IsStrictlyBetween() Returns @true if IsStrictlyBetween()
@@ -690,7 +690,7 @@ public:
This is the same as calling MakeTimezone() with This is the same as calling MakeTimezone() with
the argument @c GMT0. the argument @c GMT0.
*/ */
wxDateTime MakeUTC(bool noDST = false); wxDateTime& MakeUTC(bool noDST = false);
/** /**
Returns the object corresponding to the current time. Returns the object corresponding to the current time.
@@ -893,7 +893,7 @@ public:
/** /**
Reset time to midnight (00:00:00) without changing the date. Reset time to midnight (00:00:00) without changing the date.
*/ */
wxDateTime ResetTime(); wxDateTime& ResetTime();
/** /**
Sets the date and time from the parameters. Sets the date and time from the parameters.
@@ -918,7 +918,7 @@ public:
/** /**
Sets the day without changing other date components. Sets the day without changing other date components.
*/ */
wxDateTime SetDay(wxDateTime_t day); wxDateTime& SetDay(short unsigned int);
/** /**
Sets the date from the date and time in Sets the date from the date and time in
@@ -930,33 +930,33 @@ public:
/** /**
Sets the hour without changing other date components. Sets the hour without changing other date components.
*/ */
wxDateTime SetHour(wxDateTime_t hour); wxDateTime& SetHour(short unsigned int);
/** /**
Sets the millisecond without changing other date components. Sets the millisecond without changing other date components.
*/ */
wxDateTime SetMillisecond(wxDateTime_t millisecond); wxDateTime& SetMillisecond(short unsigned int);
/** /**
Sets the minute without changing other date components. Sets the minute without changing other date components.
*/ */
wxDateTime SetMinute(wxDateTime_t minute); wxDateTime& SetMinute(short unsigned int);
/** /**
Sets the month without changing other date components. Sets the month without changing other date components.
*/ */
wxDateTime SetMonth(Month month); wxDateTime& SetMonth(Month month);
/** /**
Sets the second without changing other date components. Sets the second without changing other date components.
*/ */
wxDateTime SetSecond(wxDateTime_t second); wxDateTime& SetSecond(short unsigned int);
/** /**
Sets the date and time of to the current values. Same as assigning the result Sets the date and time of to the current values. Same as assigning the result
of Now() to this object. of Now() to this object.
*/ */
wxDateTime SetToCurrent(); wxDateTime& SetToCurrent();
/** /**
Sets the date to the last day in the specified month (the current one by Sets the date to the last day in the specified month (the current one by
@@ -980,14 +980,14 @@ public:
date. date.
Returns the reference to the modified object itself. Returns the reference to the modified object itself.
*/ */
wxDateTime SetToNextWeekDay(WeekDay weekday); wxDateTime& SetToNextWeekDay(WeekDay weekday);
/** /**
Sets the date so that it will be the last @a weekday before the current Sets the date so that it will be the last @a weekday before the current
date. date.
Returns the reference to the modified object itself. Returns the reference to the modified object itself.
*/ */
wxDateTime SetToPrevWeekDay(WeekDay weekday); wxDateTime& SetToPrevWeekDay(WeekDay weekday);
/** /**
Sets the date to the @e n-th @a weekday in the given month of the given Sets the date to the @e n-th @a weekday in the given month of the given
@@ -1031,12 +1031,12 @@ public:
the other ones. the other ones.
Returns the reference to the modified object itself. Returns the reference to the modified object itself.
*/ */
wxDateTime SetToYearDay(wxDateTime_t yday); wxDateTime& SetToYearDay(short unsigned int);
/** /**
Sets the year without changing other date components. Sets the year without changing other date components.
*/ */
wxDateTime SetYear(int year); wxDateTime& SetYear(int year);
/** /**
For convenience, all static functions are collected here. These functions For convenience, all static functions are collected here. These functions
@@ -1328,25 +1328,25 @@ public:
Sets the number of days (without modifying any other components) in this date Sets the number of days (without modifying any other components) in this date
span. span.
*/ */
wxDateSpan SetDays(int n); wxDateSpan& SetDays(int n);
/** /**
Sets the number of months (without modifying any other components) in this Sets the number of months (without modifying any other components) in this
date span. date span.
*/ */
wxDateSpan SetMonths(int n); wxDateSpan& SetMonths(int n);
/** /**
Sets the number of weeks (without modifying any other components) in this date Sets the number of weeks (without modifying any other components) in this date
span. span.
*/ */
wxDateSpan SetWeeks(int n); wxDateSpan& SetWeeks(int n);
/** /**
Sets the number of years (without modifying any other components) in this date Sets the number of years (without modifying any other components) in this date
span. span.
*/ */
wxDateSpan SetYears(int n); wxDateSpan& SetYears(int n);
//@{ //@{
/** /**
@@ -1389,14 +1389,14 @@ public:
/** /**
Returns @true if this date span is different from the other one. Returns @true if this date span is different from the other one.
*/ */
bool operator!=(wxDateSpan& other) const; bool operator!=(const wxDateSpan&) const;
/** /**
Returns @true if this date span is equal to the other one. Two date spans Returns @true if this date span is equal to the other one. Two date spans
are considered equal if and only if they have the same number of years and are considered equal if and only if they have the same number of years and
months and the same total number of days (counting both days and weeks). months and the same total number of days (counting both days and weeks).
*/ */
bool operator==(wxDateSpan& other) const; bool operator==(const wxDateSpan&) const;
}; };
@@ -1513,7 +1513,7 @@ public:
The same applies to all other format specifiers: if they follow a specifier of The same applies to all other format specifiers: if they follow a specifier of
larger unit, only the rest part is taken, otherwise the full value is used. larger unit, only the rest part is taken, otherwise the full value is used.
*/ */
wxString Format(const wxChar* format = wxDefaultTimeSpanFormat); wxString Format(const wxString& = wxDefaultTimeSpanFormat) const;
/** /**
Format() Format()

24
interface/event.h
View File

@@ -74,7 +74,7 @@ public:
Constructor. Currently, the only valid event types are wxEVT_CHAR and Constructor. Currently, the only valid event types are wxEVT_CHAR and
wxEVT_CHAR_HOOK. wxEVT_CHAR_HOOK.
*/ */
wxKeyEvent(WXTYPE keyEventType); wxKeyEvent(wxEventType keyEventType);
/** /**
Returns @true if the Alt key was down at the time of the key event. Returns @true if the Alt key was down at the time of the key event.
@@ -270,7 +270,7 @@ public:
/** /**
Constructor. Constructor.
*/ */
wxJoystickEvent(WXTYPE eventType = 0, int state = 0, wxJoystickEvent(wxEventType eventType = 0, int state = 0,
int joystick = wxJOYSTICK1, int joystick = wxJOYSTICK1,
int change = 0); int change = 0);
@@ -369,7 +369,7 @@ public:
/** /**
Constructor. Constructor.
*/ */
wxScrollWinEvent(WXTYPE commandType = 0, int pos = 0, wxScrollWinEvent(wxEventType commandType = 0, int pos = 0,
int orientation = 0); int orientation = 0);
/** /**
@@ -769,7 +769,7 @@ public:
@b wxEVT_MOTION @b wxEVT_MOTION
@b wxEVT_MOUSEWHEEL @b wxEVT_MOUSEWHEEL
*/ */
wxMouseEvent(WXTYPE mouseEventType = 0); wxMouseEvent(wxEventType mouseEventType = 0);
/** /**
Returns @true if the Alt key was down at the time of the event. Returns @true if the Alt key was down at the time of the event.
@@ -1179,7 +1179,7 @@ public:
/** /**
Constructor. Constructor.
*/ */
wxDropFilesEvent(WXTYPE id = 0, int noFiles = 0, wxDropFilesEvent(wxEventType id = 0, int noFiles = 0,
wxString* files = NULL); wxString* files = NULL);
/** /**
@@ -1236,7 +1236,7 @@ public:
/** /**
Constructor. Constructor.
*/ */
wxCommandEvent(WXTYPE commandEventType = 0, int id = 0); wxCommandEvent(wxEventType commandEventType = 0, int id = 0);
/** /**
Deprecated, use IsChecked() instead. Deprecated, use IsChecked() instead.
@@ -1351,7 +1351,7 @@ public:
/** /**
Constructor. Constructor.
*/ */
wxActivateEvent(WXTYPE eventType = 0, bool active = true, wxActivateEvent(wxEventType eventType = wxEVT_NULL, bool active = true,
int id = 0); int id = 0);
/** /**
@@ -1393,7 +1393,7 @@ public:
/** /**
Constructor. Constructor.
*/ */
wxContextMenuEvent(WXTYPE id = 0, int id = 0, wxContextMenuEvent(wxEventType id = 0, int id = 0,
const wxPoint& pos = wxDefaultPosition); const wxPoint& pos = wxDefaultPosition);
/** /**
@@ -1478,7 +1478,7 @@ public:
/** /**
Constructor. Constructor.
*/ */
wxFocusEvent(WXTYPE eventType = 0, int id = 0); wxFocusEvent(wxEventType eventType = 0, int id = 0);
/** /**
Returns the window associated with this event, that is the window which had the Returns the window associated with this event, that is the window which had the
@@ -1728,7 +1728,7 @@ public:
/** /**
Constructor. Constructor.
*/ */
wxScrollEvent(WXTYPE commandType = 0, int id = 0, int pos = 0, wxScrollEvent(wxEventType commandType = 0, int id = 0, int pos = 0,
int orientation = 0); int orientation = 0);
/** /**
@@ -2047,7 +2047,7 @@ public:
/** /**
Constructor. Constructor.
*/ */
wxCloseEvent(WXTYPE commandEventType = 0, int id = 0); wxCloseEvent(wxEventType commandEventType = 0, int id = 0);
/** /**
Returns @true if you can veto a system shutdown or a window close event. Returns @true if you can veto a system shutdown or a window close event.
@@ -2113,7 +2113,7 @@ public:
/** /**
Constructor. Constructor.
*/ */
wxMenuEvent(WXTYPE id = 0, int id = 0, wxMenu* menu = NULL); wxMenuEvent(wxEventType id = 0, int id = 0, wxMenu* menu = NULL);
/** /**
Returns the menu which is being opened or closed. This method should only be Returns the menu which is being opened or closed. This method should only be

2
interface/listctrl.h
View File

@@ -951,7 +951,7 @@ public:
/** /**
Constructor. Constructor.
*/ */
wxListEvent(WXTYPE commandType = 0, int id = 0); wxListEvent(wxEventType commandType = 0, int id = 0);
/** /**
For @c EVT_LIST_CACHE_HINT event only: return the first item which the For @c EVT_LIST_CACHE_HINT event only: return the first item which the