AuroraMiddleware/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

add const qualifiers

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52414 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Francesco Montorsi 2008-03-09 16:24:26 +00:00
parent 1fee6e2577
commit 328f5751e8
193 changed files with 2525 additions and 2513 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
interface/accel.h
View File

@ -42,17 +42,17 @@ public:
/**
Returns the command identifier for the accelerator table entry.
*/
int GetCommand();
int GetCommand() const;
/**
Returns the flags for the accelerator table entry.
*/
int GetFlags();
int GetFlags() const;
/**
Returns the keycode for the accelerator table entry.
*/
int GetKeyCode();
int GetKeyCode() const;
/**
Sets the accelerator entry parameters.
@ -124,7 +124,7 @@ public:
/**
Returns @true if the accelerator table is valid.
*/
bool IsOk();
bool IsOk() const;
/**
Assignment operator, using @ref overview_trefcount "reference counting".

16
interface/animate.h
View File

@ -83,18 +83,18 @@ public:
/**
Returns the animation associated with this control.
*/
wxAnimation GetAnimation();
wxAnimation GetAnimation() const;
/**
Returns the inactive bitmap shown in this control when the;
see SetInactiveBitmap() for more info.
*/
wxBitmap GetInactiveBitmap();
wxBitmap GetInactiveBitmap() const;
/**
Returns @true if the animation is being played.
*/
bool IsPlaying();
bool IsPlaying() const;
/**
Loads the animation from the given file and calls SetAnimation().
@ -197,27 +197,27 @@ public:
Returns the delay for the i-th frame in milliseconds.
If @c -1 is returned the frame is to be displayed forever.
*/
int GetDelay(unsigned int i);
int GetDelay(unsigned int i) const;
/**
Returns the i-th frame as a wxImage.
*/
wxImage GetFrame(unsigned int i);
wxImage GetFrame(unsigned int i) const;
/**
Returns the number of frames for this animation.
*/
unsigned int GetFrameCount();
unsigned int GetFrameCount() const;
/**
Returns the size of the animation.
*/
wxSize GetSize();
wxSize GetSize() const;
/**
Returns @true if animation data is present.
*/
bool IsOk();
bool IsOk() const;
/**
Loads an animation from the given stream.

22
interface/app.h
View File

@ -97,7 +97,7 @@ public:
By default, returns the same string as GetAppName().
This function is new since wxWidgets version 2.9.0
*/
wxString GetAppDisplayName();
wxString GetAppDisplayName() const;
/**
Returns the application name.
@ -107,7 +107,7 @@ public:
@see GetAppDisplayName()
*/
wxString GetAppName();
wxString GetAppName() const;
/**
Gets the class name of the application. The class name may be used in a
@ -116,7 +116,7 @@ public:
@see SetClassName()
*/
wxString GetClassName();
wxString GetClassName() const;
/**
Returns @true if the application will exit when the top-level window is deleted,
@ -126,7 +126,7 @@ public:
@see SetExitOnFrameDelete(), @ref overview_wxappshutdownoverview "wxApp
shutdown overview"
*/
bool GetExitOnFrameDelete();
bool GetExitOnFrameDelete() const;
/**
Returns the one and only global application object.
@ -145,7 +145,7 @@ public:
@see SetTopWindow()
*/
virtual wxWindow* GetTopWindow();
virtual wxWindow* GetTopWindow() const;
/**
Returns a pointer to the wxAppTraits object for the application.
@ -160,7 +160,7 @@ public:
@see SetUseBestVisual()
*/
bool GetUseBestVisual();
bool GetUseBestVisual() const;
/**
Returns the user-readable vendor name. The difference between this string
@ -171,12 +171,12 @@ public:
By default, returns the same string as GetVendorName().
This function is new since wxWidgets version 2.9.0
*/
wxString GetVendorDisplayName();
wxString GetVendorDisplayName() const;
/**
Returns the application's vendor name.
*/
wxString GetVendorName();
wxString GetVendorName() const;
/**
This function simply invokes the given method @a func of the specified
@ -187,7 +187,7 @@ public:
*/
virtual void HandleEvent(wxEvtHandler handler,
wxEventFunction func,
wxEvent& event);
wxEvent& event) const;
/**
Returns @true if the application is active, i.e. if one of its windows is
@ -196,7 +196,7 @@ public:
wxTopLevelWindow::RequestUserAttention
to do it.
*/
bool IsActive();
bool IsActive() const;
/**
Returns @true if the main event loop is currently running, i.e. if the
@ -483,7 +483,7 @@ public:
@param theme
The name of the new theme or an absolute path to a gtkrc-theme-file
*/
bool SetNativeTheme();
bool SetNativeTheme(const wxStringamp;);
/**
Sets the 'top' window. You can call this from within OnInit() to

4
interface/apptrait.h
View File

@ -73,7 +73,7 @@ public:
to figure out, which desktop environment is running. The method
returns an empty string otherwise and on all other platforms.
*/
virtual wxString GetDesktopEnvironment();
virtual wxString GetDesktopEnvironment() const;
/**
Returns the wxStandardPaths object for the application.
@ -105,7 +105,7 @@ public:
Returns @true if the library was built as wxUniversal. Always returns
@false for wxBase-only apps.
*/
bool IsUsingUniversalWidgets();
bool IsUsingUniversalWidgets() const;
/**
Shows the assert dialog with the specified message in GUI mode or just prints

46
interface/archive.h
View File

@ -173,14 +173,14 @@ public:
/**
Returns a copy of this entry object.
*/
wxArchiveEntry* Clone();
wxArchiveEntry* Clone() const;
//@{
/**
The entry's timestamp.
*/
wxDateTime GetDateTime();
void SetDateTime(const wxDateTime& dt);
const void SetDateTime(const wxDateTime& dt);
//@}
//@{
@ -192,8 +192,8 @@ public:
Similarly, setting a name with a trailing path separator sets IsDir().
*/
wxString GetName(wxPathFormat format = wxPATH_NATIVE);
void SetName(const wxString& name,
wxPathFormat format = wxPATH_NATIVE);
const void SetName(const wxString& name,
wxPathFormat format = wxPATH_NATIVE);
//@}
//@{
@ -201,14 +201,14 @@ public:
The size of the entry's data in bytes.
*/
off_t GetSize();
void SetSize(off_t size);
const void SetSize(off_t size);
//@}
/**
Returns the path format used internally within the archive to store
filenames.
*/
wxPathFormat GetInternalFormat();
wxPathFormat GetInternalFormat() const;
/**
Returns the entry's filename in the internal format used within the
@ -219,12 +219,12 @@ public:
@see @ref overview_wxarcbyname "Looking up an archive entry by name"
*/
wxString GetInternalName();
wxString GetInternalName() const;
/**
Returns a numeric value unique to the entry within the archive.
*/
off_t GetOffset();
off_t GetOffset() const;
//@{
/**
@ -237,7 +237,7 @@ public:
restore files, even if the archive contains no explicit directory entries.
*/
bool IsDir();
void SetIsDir(bool isDir = true);
const void SetIsDir(bool isDir = true);
//@}
//@{
@ -245,7 +245,7 @@ public:
True if the entry is a read-only file.
*/
bool IsReadOnly();
void SetIsReadOnly(bool isReadOnly = true);
const void SetIsReadOnly(bool isReadOnly = true);
//@}
//@{
@ -303,7 +303,7 @@ public:
can be a complete filename rather than just an extension.
*/
bool CanHandle(const wxChar* protocol,
wxStreamProtocolType type = wxSTREAM_PROTOCOL);
wxStreamProtocolType type = wxSTREAM_PROTOCOL) const;
/**
A static member that finds a factory that can handle a given protocol, MIME
@ -322,7 +322,7 @@ public:
constructor, is wxConvLocal.
*/
wxMBConv GetConv();
void SetConv(wxMBConv& conv);
const void SetConv(wxMBConv& conv);
//@}
//@{
@ -333,8 +333,8 @@ public:
GetFirst()/GetNext() return a pointer to a factory or @NULL if no more
are available. They do not give away ownership of the factory.
*/
static const wxArchiveClassFactory* GetFirst();
const wxArchiveClassFactory* GetNext();
static const wxArchiveClassFactory* GetFirst() const;
const wxArchiveClassFactory* GetNext() const;
//@}
/**
@ -343,13 +343,13 @@ public:
wxZipEntry::GetInternalName.
*/
wxString GetInternalName(const wxString& name,
wxPathFormat format = wxPATH_NATIVE);
wxPathFormat format = wxPATH_NATIVE) const;
/**
Returns the wxFileSystem protocol supported by this factory. Equivalent
to wxString(*GetProtcols()).
*/
wxString GetProtocol();
wxString GetProtocol() const;
/**
Returns the protocols, MIME types or file extensions supported by this
@ -357,13 +357,13 @@ public:
ownership of the array or strings.
For example, to list the file extensions a factory supports:
*/
const wxChar* const* GetProtocols(wxStreamProtocolType type = wxSTREAM_PROTOCOL);
const wxChar* const* GetProtocols(wxStreamProtocolType type = wxSTREAM_PROTOCOL) const;
/**
Create a new wxArchiveEntry object of the
appropriate type.
*/
wxArchiveEntry* NewEntry();
wxArchiveEntry* NewEntry() const;
//@{
/**
@ -371,10 +371,10 @@ public:
If the parent stream is passed as a pointer then the new archive stream
takes ownership of it. If it is passed by reference then it does not.
*/
wxArchiveInputStream* NewStream(wxInputStream& stream);
wxArchiveOutputStream* NewStream(wxOutputStream& stream);
wxArchiveInputStream* NewStream(wxInputStream* stream);
wxArchiveOutputStream* NewStream(wxOutputStream* stream);
wxArchiveInputStream* NewStream(wxInputStream& stream) const;
const wxArchiveOutputStream* NewStream(wxOutputStream& stream) const;
const wxArchiveInputStream* NewStream(wxInputStream* stream) const;
const wxArchiveOutputStream* NewStream(wxOutputStream* stream) const;
//@}
/**
@ -554,7 +554,7 @@ public:
Returns an entry object from the archive input stream, giving away
ownership.
*/
const T operator*();
const T operator*() const;
//@{
/**

8
interface/arrstr.h
View File

@ -113,7 +113,7 @@ public:
/**
Returns the number of items in the array.
*/
size_t GetCount();
size_t GetCount() const;
/**
Search the element in the array, starting from the beginning if
@ -154,7 +154,7 @@ public:
See also @ref operatorindex() operator[] for the operator
version.
*/
wxString Item(size_t nIndex);
wxString Item(size_t nIndex) const;
/**
Returns the last element of the array. Attempt to access the last element of
@ -200,7 +200,7 @@ Warning:
Compares 2 arrays respecting the case. Returns @true if the arrays have
different number of elements or if the elements don't match pairwise.
*/
bool operator !=(const wxArrayString& array);
bool operator !=(const wxArrayString& array) const;
/**
Assignment operator.
@ -211,7 +211,7 @@ Warning:
Compares 2 arrays respecting the case. Returns @true only if the arrays have
the same number of elements and the same strings in the same order.
*/
bool operator ==(const wxArrayString& array);
bool operator ==(const wxArrayString& array) const;
/**
Return the array element at position @e nIndex. An assert failure will

50
interface/aui/aui.h
View File

@ -97,7 +97,7 @@ public:
Returns the current art provider being used.
See also: wxAuiDockArt.
*/
wxAuiDockArt* GetArtProvider();
wxAuiDockArt* GetArtProvider() const;
/**
Returns the current dock constraint values. See SetDockSizeConstraint() for
@ -108,12 +108,12 @@ public:
/**
Returns the current manager's flags.
*/
unsigned int GetFlags();
unsigned int GetFlags() const;
/**
Returns the frame currently being managed by wxAuiManager.
*/
wxWindow* GetManagedWindow();
wxWindow* GetManagedWindow() const;
/**
Calling this method will return the wxAuiManager for a given window. The @a
@ -426,50 +426,50 @@ public:
/**
HasBorder() returns @true if the pane displays a border.
*/
bool HasBorder();
bool HasBorder() const;
/**
HasCaption() returns @true if the pane displays a caption.
*/
bool HasCaption();
bool HasCaption() const;
/**
HasCloseButton() returns @true if the pane displays a button to close the pane.
*/
bool HasCloseButton();
bool HasCloseButton() const;
/**
HasFlag() returns @true if the the property specified by flag is active for the
pane.
*/
bool HasFlag(unsigned int flag);
bool HasFlag(unsigned int flag) const;
/**
HasGripper() returns @true if the pane displays a gripper.
*/
bool HasGripper();
bool HasGripper() const;
/**
HasGripper() returns @true if the pane displays a gripper at the top.
*/
bool HasGripperTop();
bool HasGripperTop() const;
/**
HasMaximizeButton() returns @true if the pane displays a button to maximize the
pane.
*/
bool HasMaximizeButton();
bool HasMaximizeButton() const;
/**
HasMinimizeButton() returns @true if the pane displays a button to minimize the
pane.
*/
bool HasMinimizeButton();
bool HasMinimizeButton() const;
/**
HasPinButton() returns @true if the pane displays a button to float the pane.
*/
bool HasPinButton();
bool HasPinButton() const;
/**
Hide() indicates that a pane should be hidden.
@ -480,73 +480,73 @@ public:
IsBottomDockable() returns @true if the pane can be docked at the bottom of the
managed frame.
*/
bool IsBottomDockable();
bool IsBottomDockable() const;
/**
IsDocked() returns @true if the pane is docked.
*/
bool IsDocked();
bool IsDocked() const;
/**
IsFixed() returns @true if the pane cannot be resized.
*/
bool IsFixed();
bool IsFixed() const;
/**
IsFloatable() returns @true if the pane can be undocked and displayed as a
floating window.
*/
bool IsFloatable();
bool IsFloatable() const;
/**
IsFloating() returns @true if the pane is floating.
*/
bool IsFloating();
bool IsFloating() const;
/**
IsLeftDockable() returns @true if the pane can be docked on the left of the
managed frame.
*/
bool IsLeftDockable();
bool IsLeftDockable() const;
/**
IsMoveable() returns @true if the docked frame can be undocked or moved to
another dock position.
*/
bool IsMovable();
bool IsMovable() const;
/**
IsOk() returns @true if the wxAuiPaneInfo structure is valid. A pane structure
is valid if it has an associated window.
*/
bool IsOk();
bool IsOk() const;
/**
IsResizable() returns @true if the pane can be resized.
*/
bool IsResizable();
bool IsResizable() const;
/**
IsRightDockable() returns @true if the pane can be docked on the right of the
managed frame.
*/
bool IsRightDockable();
bool IsRightDockable() const;
/**
IsShown() returns @true if the pane is currently shown.
*/
bool IsShown();
bool IsShown() const;
/**
IsToolbar() returns @true if the pane contains a toolbar.
*/
bool IsToolbar();
bool IsToolbar() const;
/**
IsTopDockable() returns @true if the pane can be docked at the top of the
managed frame.
*/
bool IsTopDockable();
bool IsTopDockable() const;
/**
Layer() determines the layer of the docked pane. The dock layer is similar to

16
interface/aui/auibook.h
View File

@ -103,7 +103,7 @@ public:
/**
Returns the associated art provider.
*/
wxAuiTabArt* GetArtProvider();
wxAuiTabArt* GetArtProvider() const;
/**
Returns the desired height of the notebook for the given page height. Use this
@ -115,38 +115,38 @@ public:
/**
Returns the page specified by the given index.
*/
wxWindow* GetPage(size_t page_idx);
wxWindow* GetPage(size_t page_idx) const;
/**
Returns the tab bitmap for the page.
*/
wxBitmap GetPageBitmap(size_t page);
wxBitmap GetPageBitmap(size_t page) const;
/**
Returns the number of pages in the notebook.
*/
size_t GetPageCount();
size_t GetPageCount() const;
/**
Returns the page index for the specified window. If the window is not found in
the notebook, wxNOT_FOUND is returned.
*/
int GetPageIndex(wxWindow* page_wnd);
int GetPageIndex(wxWindow* page_wnd) const;
/**
Returns the tab label for the page.
*/
wxString GetPageText(size_t page);
wxString GetPageText(size_t page) const;
/**
Returns the currently selected page.
*/
int GetSelection();
int GetSelection() const;
/**
Returns the height of the tab control.
*/
int GetTabCtrlHeight();
int GetTabCtrlHeight() const;
/**
InsertPage() is similar to AddPage, but allows the ability to specify the

20
interface/bitmap.h
View File

@ -70,17 +70,17 @@ public:
/**
Gets the file extension associated with this handler.
*/
const wxString GetExtension();
const wxString GetExtension() const;
/**
Gets the name of this handler.
*/
const wxString GetName();
const wxString GetName() const;
/**
Gets the bitmap type associated with this handler.
*/
long GetType();
long GetType() const;
/**
Loads a bitmap from a file or resource, putting the resulting data into @e
@ -400,7 +400,7 @@ public:
Gets the colour depth of the bitmap. A value of 1 indicates a
monochrome bitmap.
*/
int GetDepth();
int GetDepth() const;
/**
Returns the static list of bitmap format handlers.
@ -412,7 +412,7 @@ public:
/**
Gets the height of the bitmap in pixels.
*/
int GetHeight();
int GetHeight() const;
/**
Gets the associated mask (if any) which may have been loaded from a file
@ -420,7 +420,7 @@ public:
@see SetMask(), wxMask
*/
wxMask* GetMask();
wxMask* GetMask() const;
/**
Gets the associated palette (if any) which may have been loaded from a file
@ -428,20 +428,20 @@ public:
@see wxPalette
*/
wxPalette* GetPalette();
wxPalette* GetPalette() const;
/**
Returns a sub bitmap of the current one as long as the rect belongs entirely to
the bitmap. This function preserves bit depth and mask information.
*/
wxBitmap GetSubBitmap(const wxRect& rect);
wxBitmap GetSubBitmap(const wxRect& rect) const;
/**
Gets the width of the bitmap in pixels.
@see GetHeight()
*/
int GetWidth();
int GetWidth() const;
/**
Adds the standard bitmap format handlers, which, depending on wxWidgets
@ -467,7 +467,7 @@ public:
/**
Returns @true if bitmap data is present.
*/
bool IsOk();
bool IsOk() const;
/**
Loads a bitmap from a file or resource.

10
interface/bmpbuttn.h
View File

@ -114,7 +114,7 @@ public:
@see SetBitmapDisabled()
*/
const wxBitmap GetBitmapDisabled();
wxBitmap GetBitmapDisabled();
const wxBitmap& GetBitmapDisabled();
//@}
//@{
@ -126,7 +126,7 @@ public:
@see SetBitmapFocus()
*/
const wxBitmap GetBitmapFocus();
wxBitmap GetBitmapFocus();
const wxBitmap& GetBitmapFocus();
//@}
//@{
@ -136,7 +136,7 @@ public:
@see SetBitmapHover()
*/
const wxBitmap GetBitmapHover();
wxBitmap GetBitmapHover();
const wxBitmap& GetBitmapHover();
//@}
//@{
@ -148,7 +148,7 @@ public:
@see SetBitmapLabel()
*/
const wxBitmap GetBitmapLabel();
wxBitmap GetBitmapLabel();
const wxBitmap& GetBitmapLabel();
//@}
/**
@ -158,7 +158,7 @@ public:
@see SetBitmapSelected()
*/
wxBitmap GetBitmapSelected();
wxBitmap GetBitmapSelected() const;
/**
Sets the bitmap for the disabled button appearance.

4
interface/bmpcbox.h
View File

@ -143,12 +143,12 @@ public:
/**
Returns size of bitmaps used in the list.
*/
wxSize GetBitmapSize();
wxSize GetBitmapSize() const;
/**
Returns the bitmap of the item with the given index.
*/
wxBitmap GetItemBitmap(unsigned int n);
wxBitmap GetItemBitmap(unsigned int n) const;
//@{
/**

10
interface/brush.h
View File

@ -193,7 +193,7 @@ public:
@see SetColour()
*/
wxColour GetColour();
wxColour GetColour() const;
/**
Gets a pointer to the stipple bitmap. If the brush does not have a wxSTIPPLE
@ -203,7 +203,7 @@ public:
@see SetStipple()
*/
wxBitmap* GetStipple();
wxBitmap* GetStipple() const;
/**
Returns the brush style, one of:
@ -250,21 +250,21 @@ public:
@see SetStyle(), SetColour(), SetStipple()
*/
int GetStyle();
int GetStyle() const;
/**
Returns @true if the style of the brush is any of hatched fills.
@see GetStyle()
*/
bool IsHatch();
bool IsHatch() const;
/**
Returns @true if the brush is initialised. It will return @false if the default
constructor has been used (for example, the brush is a member of a class, or
@NULL has been assigned to it).
*/
bool IsOk();
bool IsOk() const;
//@{
/**

2
interface/button.h
View File

@ -117,7 +117,7 @@ public:
@see SetLabel()
*/
wxString GetLabel();
wxString GetLabel() const;
/**
This sets the button to be the default item for the panel or dialog

40
interface/calctrl.h
View File

@ -27,7 +27,7 @@ public:
@c EVT_CALENDAR_WEEKDAY_CLICKED handler. It doesn't make sense to call
this function in other handlers.
*/
wxDateTime::WeekDay GetWeekDay();
wxDateTime::WeekDay GetWeekDay() const;
/**
Sets the week day carried by the event, normally only used by the library
@ -70,59 +70,59 @@ public:
/**
Returns the background colour to use for the item with this attribute.
*/
const wxColour GetBackgroundColour();
const wxColour GetBackgroundColour() const;
/**
Returns the border to use for the item with this attribute.
*/
wxCalendarDateBorder GetBorder();
wxCalendarDateBorder GetBorder() const;
/**
Returns the border colour to use for the item with this attribute.
*/
const wxColour GetBorderColour();
const wxColour GetBorderColour() const;
/**
Returns the font to use for the item with this attribute.
*/
const wxFont GetFont();
const wxFont GetFont() const;
/**
Returns the text colour to use for the item with this attribute.
*/
const wxColour GetTextColour();
const wxColour GetTextColour() const;
/**
Returns @true if this attribute specifies a non-default text background
colour.
*/
bool HasBackgroundColour();
bool HasBackgroundColour() const;
/**
Returns @true if this attribute specifies a non-default (i.e. any) border.
*/
bool HasBorder();
bool HasBorder() const;
/**
Returns @true if this attribute specifies a non-default border colour.
*/
bool HasBorderColour();
bool HasBorderColour() const;
/**
Returns @true if this attribute specifies a non-default font.
*/
bool HasFont();
bool HasFont() const;
/**
Returns @true if this item has a non-default text foreground colour.
*/
bool HasTextColour();
bool HasTextColour() const;
/**
Returns @true if this attribute specifies that this item should be
displayed as a holiday.
*/
bool IsHoliday();
bool IsHoliday() const;
/**
Sets the text background colour to use.
@ -270,54 +270,54 @@ public:
Returns the attribute for the given date (should be in the range 1...31).
The returned pointer may be @NULL.
*/
wxCalendarDateAttr* GetAttr(size_t day);
wxCalendarDateAttr* GetAttr(size_t day) const;
/**
Gets the currently selected date.
*/
const wxDateTime GetDate();
const wxDateTime GetDate() const;
/**
Gets the background colour of the header part of the calendar window.
@see SetHeaderColours()
*/
const wxColour GetHeaderColourBg();
const wxColour GetHeaderColourBg() const;
/**
Gets the foreground colour of the header part of the calendar window.
@see SetHeaderColours()
*/
const wxColour GetHeaderColourFg();
const wxColour GetHeaderColourFg() const;
/**
Gets the background highlight colour.
@see SetHighlightColours()
*/
const wxColour GetHighlightColourBg();
const wxColour GetHighlightColourBg() const;
/**
Gets the foreground highlight colour.
@see SetHighlightColours()
*/
const wxColour GetHighlightColourFg();
const wxColour GetHighlightColourFg() const;
/**
Return the background colour currently used for holiday highlighting.
@see SetHolidayColours()
*/
const wxColour GetHolidayColourBg();
const wxColour GetHolidayColourBg() const;
/**
Return the foreground colour currently used for holiday highlighting.
@see SetHolidayColours()
*/
const wxColour GetHolidayColourFg();
const wxColour GetHolidayColourFg() const;
/**
Returns one of @c wxCAL_HITTEST_XXX

14
interface/caret.h
View File

@ -69,8 +69,8 @@ public:
Returns a 2-element list
@c ( x, y )
*/
void GetPosition(int* x, int* y);
wxPoint GetPosition();
void GetPosition(int* x, int* y) const;
const wxPoint GetPosition() const;
//@}
//@{
@ -86,14 +86,14 @@ public:
Returns a 2-element list
@c ( width, height )
*/
void GetSize(int* width, int* height);
wxSize GetSize();
void GetSize(int* width, int* height) const;
const wxSize GetSize() const;
//@}
/**
Get the window the caret is associated with.
*/
wxWindow* GetWindow();
wxWindow* GetWindow() const;
/**
Same as wxCaret::Show(@false).
@ -103,14 +103,14 @@ public:
/**
Returns @true if the caret was created successfully.
*/
bool IsOk();
bool IsOk() const;
/**
Returns @true if the caret is visible and @false if it is permanently
hidden (if it is is blinking and not shown currently but will be after the
next blink, this method still returns @true).
*/
bool IsVisible();
bool IsVisible() const;
//@{
/**

10
interface/checkbox.h
View File

@ -106,14 +106,14 @@ public:
Asserts when the function is used with a 2-state
checkbox.
*/
wxCheckBoxState Get3StateValue();
wxCheckBoxState Get3StateValue() const;
/**
Gets the state of a 2-state checkbox.
@returns Returns @true if it is checked, @false otherwise.
*/
bool GetValue();
bool GetValue() const;
/**
Returns whether or not the checkbox is a 3-state checkbox.
@ -121,7 +121,7 @@ public:
@returns Returns @true if this checkbox is a 3-state checkbox, @false if
it's a 2-state checkbox.
*/
bool Is3State();
bool Is3State() const;
/**
Returns whether or not the user can set the checkbox to the third state.
@ -130,14 +130,14 @@ public:
checkbox, @false if it can only be set programmatically
or if it's a 2-state checkbox.
*/
bool Is3rdStateAllowedForUser();
bool Is3rdStateAllowedForUser() const;
/**
This is just a maybe more readable synonym for
GetValue(): just as the latter, it returns
@true if the checkbox is checked and @false otherwise.
*/
bool IsChecked();
bool IsChecked() const;
/**
Sets the checkbox to the given state. This does not cause a

12
interface/choicdlg.h
View File

@ -104,12 +104,12 @@ public:
/**
Returns array with indexes of selected items.
*/
wxArrayInt GetSelection();
wxArrayInt GetSelection() const;
/**
Sets selected items from the array of selected items' indexes.
*/
void SetSelections(const wxArrayInt& selections);
void SetSelections(const wxArrayInt& selections) const;
/**
Shows the dialog, returning either wxID_OK or wxID_CANCEL.
@ -222,22 +222,22 @@ public:
/**
Returns the index of selected item.
*/
int GetSelection();
int GetSelection() const;
/**
Returns the client data associated with the selection.
*/
char* GetSelectionClientData();
char* GetSelectionClientData() const;
/**
Returns the selected string.
*/
wxString GetStringSelection();
wxString GetStringSelection() const;
/**
Sets the index of the initially selected item.
*/
void SetSelection(int selection);
void SetSelection(int selection) const;
/**
Shows the dialog, returning either wxID_OK or wxID_CANCEL.

4
interface/choice.h
View File

@ -109,7 +109,7 @@ public:
@remarks This is implemented for Motif only and always returns 1 for the
other platforms.
*/
int GetColumns();
int GetColumns() const;
/**
Unlike wxControlWithItems::GetSelection which only
@ -122,7 +122,7 @@ public:
wxControlWithItems::GetSelection itself behaved like
this).
*/
int GetCurrentSelection();
int GetCurrentSelection() const;
/**
Sets the number of columns in this choice item.

4
interface/clipbrd.h
View File

@ -111,7 +111,7 @@ public:
/**
Returns @true if the clipboard has been opened.
*/
bool IsOpened();
bool IsOpened() const;
/**
Returns @true if there is data which matches the data format of the given data
@ -124,7 +124,7 @@ public:
one.
See @ref useprimary() UsePrimarySelection for more information.
*/
bool IsUsingPrimarySelection();
bool IsUsingPrimarySelection() const;
/**
Call this function to open the clipboard before calling SetData()

6
interface/clntdata.h
View File

@ -43,12 +43,12 @@ public:
/**
Get the untyped client data.
*/
void* GetClientData();
void* GetClientData() const;
/**
Get a pointer to the client data object.
*/
wxClientData* GetClientObject();
wxClientData* GetClientObject() const;
/**
Set the untyped client data.
@ -133,7 +133,7 @@ public:
/**
Get string client data.
*/
const wxString GetData();
const wxString GetData() const;
/**
Set string client data.

4
interface/clrpicker.h
View File

@ -85,7 +85,7 @@ public:
/**
Returns the currently selected colour.
*/
wxColour GetColour();
wxColour GetColour() const;
//@{
/**
@ -122,7 +122,7 @@ public:
/**
Retrieve the colour the user has just selected.
*/
wxColour GetColour();
wxColour GetColour() const;
/**
Set the colour associated with the event.

12
interface/cmdline.h
View File

@ -196,22 +196,22 @@ public:
Returns @true if an option taking a date value was found and stores the
value in the provided pointer (which should not be @NULL).
*/
bool Found(const wxString& name);
bool Found(const wxString& name, wxString* value);
bool Found(const wxString& name, long* value);
bool Found(const wxString& name, wxDateTime* value);
bool Found(const wxString& name) const;
const bool Found(const wxString& name, wxString* value) const;
const bool Found(const wxString& name, long* value) const;
const bool Found(const wxString& name, wxDateTime* value) const;
//@}
/**
Returns the value of Nth parameter (as string only).
*/
wxString GetParam(size_t n = 0u);
wxString GetParam(size_t n = 0u) const;
/**
Returns the number of parameters found. This function makes sense mostly if you
had used @c wxCMD_LINE_PARAM_MULTIPLE flag.
*/
size_t GetParamCount();
size_t GetParamCount() const;
/**
After calling Parse() (and if it returned 0),

14
interface/cmdproc.h
View File

@ -126,37 +126,37 @@ public:
/**
Returns the list of commands.
*/
wxList GetCommands();
wxList GetCommands() const;
/**
Returns the edit menu associated with the command processor.
*/
wxMenu* GetEditMenu();
wxMenu* GetEditMenu() const;
/**
Returns the maximum number of commands that the command processor stores.
*/
int GetMaxCommands();
int GetMaxCommands() const;
/**
Returns the string that will be appended to the Redo menu item.
*/
const wxString GetRedoAccelerator();
const wxString GetRedoAccelerator() const;
/**
Returns the string that will be shown for the redo menu item.
*/
wxString GetRedoMenuLabel();
wxString GetRedoMenuLabel() const;
/**
Returns the string that will be appended to the Undo menu item.
*/
const wxString GetUndoAccelerator();
const wxString GetUndoAccelerator() const;
/**
Returns the string that will be shown for the undo menu item.
*/
wxString GetUndoMenuLabel();
wxString GetUndoMenuLabel() const;
/**
Initializes the command processor, setting the current command to the

74
interface/cmndata.h
View File

@ -183,74 +183,74 @@ public:
as orientation)
instead of showing a dialog. Windows only.
*/
bool GetDefaultInfo();
bool GetDefaultInfo() const;
/**
Returns @true if the page setup dialog will take its minimum margin values from
the currently
selected printer properties. Windows only.
*/
bool GetDefaultMinMargins();
bool GetDefaultMinMargins() const;
/**
Returns @true if the printer setup button is enabled.
*/
bool GetEnableHelp();
bool GetEnableHelp() const;
/**
Returns @true if the margin controls are enabled (Windows only).
*/
bool GetEnableMargins();
bool GetEnableMargins() const;
/**
Returns @true if the orientation control is enabled (Windows only).
*/
bool GetEnableOrientation();
bool GetEnableOrientation() const;
/**
Returns @true if the paper size control is enabled (Windows only).
*/
bool GetEnablePaper();
bool GetEnablePaper() const;
/**
Returns @true if the printer setup button is enabled.
*/
bool GetEnablePrinter();
bool GetEnablePrinter() const;
/**
Returns the right (x) and bottom (y) margins in millimetres.
*/
wxPoint GetMarginBottomRight();
wxPoint GetMarginBottomRight() const;
/**
Returns the left (x) and top (y) margins in millimetres.
*/
wxPoint GetMarginTopLeft();
wxPoint GetMarginTopLeft() const;
/**
Returns the right (x) and bottom (y) minimum margins the user can enter
(Windows only). Units
are in millimetres
*/
wxPoint GetMinMarginBottomRight();
wxPoint GetMinMarginBottomRight() const;
/**
Returns the left (x) and top (y) minimum margins the user can enter (Windows
only). Units
are in millimetres
*/
wxPoint GetMinMarginTopLeft();
wxPoint GetMinMarginTopLeft() const;
/**
Returns the paper id (stored in the internal wxPrintData object).
For further information, see wxPrintData::SetPaperId.
*/
wxPaperSize GetPaperId();
wxPaperSize GetPaperId() const;
/**
Returns the paper size in millimetres.
*/
wxSize GetPaperSize();
wxSize GetPaperSize() const;
/**
Returns a reference to the @ref overview_wxprintdata "print data" associated
@ -263,7 +263,7 @@ public:
This can return @false on Windows if the current printer is not set, for example.
On all other platforms, it returns @true.
*/
bool IsOk();
bool IsOk() const;
/**
Pass @true if the dialog will simply return default printer information (such as
@ -369,20 +369,20 @@ public:
Has no meaning under other platforms.
The default value is @true.
*/
bool GetChooseFull();
bool GetChooseFull() const;
/**
Gets the current colour associated with the colour dialog.
The default colour is black.
*/
wxColour GetColour();
wxColour GetColour() const;
/**
Gets the @e ith custom colour associated with the colour dialog. @a i should
be an integer between 0 and 15.
The default custom colours are invalid colours.
*/
wxColour GetCustomColour(int i);
wxColour GetCustomColour(int i) const;
/**
Under Windows, tells the Windows colour dialog to display the full dialog
@ -449,45 +449,45 @@ public:
the bin (@c wxPRINTBIN_DEFAULT is returned).
See SetBin() for the full list of bin values.
*/
wxPrintBin GetBin();
wxPrintBin GetBin() const;
/**
Returns @true if collation is on.
*/
bool GetCollate();
bool GetCollate() const;
/**
Returns @true if colour printing is on.
*/
bool GetColour();
bool GetColour() const;
/**
Returns the duplex mode. One of wxDUPLEX_SIMPLEX, wxDUPLEX_HORIZONTAL,
wxDUPLEX_VERTICAL.
*/
wxDuplexMode GetDuplex();
wxDuplexMode GetDuplex() const;
/**
Returns the number of copies requested by the user.
*/
int GetNoCopies();
int GetNoCopies() const;
/**
Gets the orientation. This can be wxLANDSCAPE or wxPORTRAIT.
*/
int GetOrientation();
int GetOrientation() const;
/**
Returns the paper size id. For more information, see SetPaperId().
*/
wxPaperSize GetPaperId();
wxPaperSize GetPaperId() const;
/**
Returns the printer name. If the printer name is the empty string, it indicates
that the default
printer should be used.
*/
const wxString GetPrinterName();
const wxString GetPrinterName() const;
/**
Returns the current print quality. This can be a positive integer, denoting the
@ -498,14 +498,14 @@ public:
back a positive integer
indicating the current resolution setting.
*/
wxPrintQuality GetQuality();
wxPrintQuality GetQuality() const;
/**
Returns @true if the print data is valid for using in print dialogs.
This can return @false on Windows if the current printer is not set, for example.
On all other platforms, it returns @true.
*/
bool IsOk();
bool IsOk() const;
/**
Sets the current bin. Possible values are:
@ -630,32 +630,32 @@ public:
/**
Returns @true if the user requested that all pages be printed.
*/
bool GetAllPages();
bool GetAllPages() const;
/**
Returns @true if the user requested that the document(s) be collated.
*/
bool GetCollate();
bool GetCollate() const;
/**
Returns the @e from page number, as entered by the user.
*/
int GetFromPage();
int GetFromPage() const;
/**
Returns the @e maximum page number.
*/
int GetMaxPage();
int GetMaxPage() const;
/**
Returns the @e minimum page number.
*/
int GetMinPage();
int GetMinPage() const;
/**
Returns the number of copies requested by the user.
*/
int GetNoCopies();
int GetNoCopies() const;
/**
Returns a reference to the internal wxPrintData object.
@ -665,26 +665,26 @@ public:
/**
Returns @true if the user has selected printing to a file.
*/
bool GetPrintToFile();
bool GetPrintToFile() const;
/**
Returns @true if the user requested that the selection be printed (where
'selection' is
a concept specific to the application).
*/
bool GetSelection();
bool GetSelection() const;
/**
Returns the @e to page number, as entered by the user.
*/
int GetToPage();
int GetToPage() const;
/**
Returns @true if the print data is valid for using in print dialogs.
This can return @false on Windows if the current printer is not set, for example.
On all other platforms, it returns @true.
*/
bool IsOk();
bool IsOk() const;
/**
Sets the 'Collate' checkbox to @true or @false.

8
interface/collpane.h
View File

@ -31,7 +31,7 @@ public:
/**
Returns @true if the pane has been collapsed.
*/
bool GetCollapsed();
bool GetCollapsed() const;
/**
Sets this as a collapsed pane event (if @a collapsed is @true) or as an
@ -158,15 +158,15 @@ public:
Returns a pointer to the pane window. Add controls to the returned wxWindow
to make them collapsible.
*/
wxWindow* GetPane();
wxWindow* GetPane() const;
/**
Returns @true if the pane window is currently hidden.
*/
bool IsCollapsed();
bool IsCollapsed() const;
/**
Returns @true if the pane window is currently shown.
*/
bool IsExpanded();
bool IsExpanded() const;
};

15
interface/colour.h
View File

@ -79,12 +79,12 @@ public:
Returns the alpha value, on platforms where alpha is not yet supported, this
always returns wxALPHA_OPAQUE.
*/
unsigned char Alpha();
unsigned char Alpha() const;
/**
Returns the blue intensity.
*/
unsigned char Blue();
unsigned char Blue() const;
//@{
/**
@ -93,7 +93,8 @@ public:
This function is new since wxWidgets version 2.7.0
*/
wxString GetAsString(long flags);
wxC2S_NAME wxC2S_CSS_SYNTAX, to obtain
const wxC2S_NAME, to obtain the colour name (e.g.
wxColour(255,0,0) - "red"), wxC2S_CSS_SYNTAX, to obtain
the colour in the "rgb(r,g,b)" or "rgba(r,g,b,a)" syntax
(e.g. wxColour(255,0,0,85) - "rgba(255,0,0,0.333)"), and
wxC2S_HTML_SYNTAX, to obtain the colour as "#" followed
@ -109,23 +110,23 @@ public:
On X, an allocated pixel value is returned.
-1 is returned if the pixel is invalid (on X, unallocated).
*/
long GetPixel();
long GetPixel() const;
/**
Returns the green intensity.
*/
unsigned char Green();
unsigned char Green() const;
/**
Returns @true if the colour object is valid (the colour has been initialised
with RGB values).
*/
bool IsOk();
bool IsOk() const;
/**
Returns the red intensity.
*/
unsigned char Red();
unsigned char Red() const;
//@{
/**

32
interface/combo.h
View File

@ -71,7 +71,7 @@ public:
The derived class must implement this to return
string representation of the value.
*/
wxString GetStringValue();
wxString GetStringValue() const;
/**
The derived class must implement this to initialize
@ -85,7 +85,7 @@ public:
Utility method that returns @true if Create has been called.
Useful in conjunction with LazyCreate().
*/
bool IsCreated();
bool IsCreated() const;
/**
The derived class may implement this to return
@ -300,7 +300,7 @@ public:
@returns A reference to the disabled state bitmap.
*/
const wxBitmap GetBitmapDisabled();
const wxBitmap GetBitmapDisabled() const;
/**
Returns button mouse hover bitmap that has been set with
@ -308,7 +308,7 @@ public:
@returns A reference to the mouse hover state bitmap.
*/
const wxBitmap GetBitmapHover();
const wxBitmap GetBitmapHover() const;
/**
Returns default button bitmap that has been set with
@ -316,7 +316,7 @@ public:
@returns A reference to the normal state bitmap.
*/
const wxBitmap GetBitmapNormal();
const wxBitmap GetBitmapNormal() const;
/**
Returns depressed button bitmap that has been set with
@ -324,7 +324,7 @@ public:
@returns A reference to the depressed state bitmap.
*/
const wxBitmap GetBitmapPressed();
const wxBitmap GetBitmapPressed() const;
/**
Returns current size of the dropdown button.
@ -336,7 +336,7 @@ public:
@see SetCustomPaintWidth().
*/
int GetCustomPaintWidth();
int GetCustomPaintWidth() const;
/**
Returns features supported by wxComboCtrl. If needed feature is missing,
@ -352,12 +352,12 @@ public:
@b Note: Under wxMSW, this function always returns 0 if the combo control
doesn't have the focus.
*/
long GetInsertionPoint();
long GetInsertionPoint() const;
/**
Returns the last position in the combo control text field.
*/
long GetLastPosition();
long GetLastPosition() const;
/**
Returns current popup interface that has been set with SetPopupControl.
@ -367,29 +367,29 @@ public:
/**
Returns popup window containing the popup control.
*/
wxWindow* GetPopupWindow();
wxWindow* GetPopupWindow() const;
/**
Get the text control which is part of the combo control.
*/
wxTextCtrl* GetTextCtrl();
wxTextCtrl* GetTextCtrl() const;
/**
Returns actual indentation in pixels.
*/
wxCoord GetTextIndent();
wxCoord GetTextIndent() const;
/**
Returns area covered by the text field (includes everything except
borders and the dropdown button).
*/
const wxRect GetTextRect();
const wxRect GetTextRect() const;
/**
Returns text representation of the current value. For writable
combo control it always returns the value in the text field.
*/
wxString GetValue();
wxString GetValue() const;
/**
Dismisses the popup window.
@ -399,7 +399,7 @@ public:
/**
Returns @true if the popup is currently shown
*/
bool IsPopupShown();
bool IsPopupShown() const;
/**
Returns @true if the popup window is in the given state.
@ -418,7 +418,7 @@ public:
Popup window is fully visible.
*/
bool IsPopupWindowState(int state);
bool IsPopupWindowState(int state) const;
/**
Implement in a derived class to define what happens on

20
interface/combobox.h
View File

@ -123,33 +123,33 @@ public:
to the clipboard.
Only available on Windows.
*/
bool CanCopy();
bool CanCopy() const;
/**
Returns @true if the combobox is editable and there is a text selection to copy
to the clipboard.
Only available on Windows.
*/
bool CanCut();
bool CanCut() const;
/**
Returns @true if the combobox is editable and there is text on the clipboard
that can be pasted into the
text field. Only available on Windows.
*/
bool CanPaste();
bool CanPaste() const;
/**
Returns @true if the combobox is editable and the last undo can be redone.
Only available on Windows.
*/
bool CanRedo();
bool CanRedo() const;
/**
Returns @true if the combobox is editable and the last edit can be undone.
Only available on Windows.
*/
bool CanUndo();
bool CanUndo() const;
/**
Copies the selected text to the clipboard.
@ -191,19 +191,19 @@ public:
returns the item currently selected in the dropdown list if it's open or the
same thing as wxControlWithItems::GetSelection otherwise.
*/
int GetCurrentSelection();
int GetCurrentSelection() const;
/**
Returns the insertion point for the combobox's text field.
@b Note: Under wxMSW, this function always returns 0 if the combobox
doesn't have the focus.
*/
long GetInsertionPoint();
long GetInsertionPoint() const;
/**
Returns the last position in the combobox text field.
*/
virtual wxTextPos GetLastPosition();
virtual wxTextPos GetLastPosition() const;
/**
This is the same as wxTextCtrl::GetSelection
@ -211,12 +211,12 @@ public:
different method from wxControlWithItems::GetSelection.
Currently this method is only implemented in wxMSW and wxGTK.
*/
void GetSelection(long* from, long* to);
void GetSelection(long* from, long* to) const;
/**
Returns the current value in the combobox text field.
*/
wxString GetValue();
wxString GetValue() const;
/**
Pastes text from the clipboard to the text field.

73
interface/config.h
View File

@ -201,7 +201,7 @@ public:
/**
returns @true if either a group or an entry with a given name exists
*/
bool Exists(wxString& strName);
bool Exists(wxString& strName) const;
/**
permanently writes all changes (otherwise, they're only written from object's
@ -219,7 +219,7 @@ public:
/**
Returns the application name.
*/
wxString GetAppName();
wxString GetAppName() const;
/**
Returns the type of the given entry or @e Unknown if the entry doesn't
@ -229,68 +229,68 @@ public:
key with wxRegConfig will fail.
The result is an element of enum EntryType:
*/
enum wxConfigBase::EntryType GetEntryType(const wxString& name);
enum wxConfigBase::EntryType GetEntryType(const wxString& name) const;
/**
Gets the first entry.
*/
bool GetFirstEntry(wxString& str, long& index);
bool GetFirstEntry(wxString& str, long& index) const;
/**
Gets the first group.
*/
bool GetFirstGroup(wxString& str, long& index);
bool GetFirstGroup(wxString& str, long& index) const;
/**
Gets the next entry.
*/
bool GetNextEntry(wxString& str, long& index);
bool GetNextEntry(wxString& str, long& index) const;
/**
Gets the next group.
*/
bool GetNextGroup(wxString& str, long& index);
bool GetNextGroup(wxString& str, long& index) const;
/**
*/
uint GetNumberOfEntries(bool bRecursive = false);
uint GetNumberOfEntries(bool bRecursive = false) const;
/**
Get number of entries/subgroups in the current group, with or without its
subgroups.
*/
uint GetNumberOfGroups(bool bRecursive = false);
uint GetNumberOfGroups(bool bRecursive = false) const;
/**
Retrieve the current path (always as absolute path).
*/
const wxString GetPath();
const wxString GetPath() const;
/**
Returns the vendor name.
*/
wxString GetVendorName();
wxString GetVendorName() const;
/**
returns @true if the entry by this name exists
*/
bool HasEntry(wxString& strName);
bool HasEntry(wxString& strName) const;
/**
returns @true if the group by this name exists
*/
bool HasGroup(const wxString& strName);
bool HasGroup(const wxString& strName) const;
/**
Returns @true if we are expanding environment variables in key values.
*/
bool IsExpandingEnvVars();
bool IsExpandingEnvVars() const;
/**
Returns @true if we are writing defaults back to the config file.
*/
bool IsRecordingDefaults();
bool IsRecordingDefaults() const;
/**
These function are the core of wxConfigBase class: they allow you to read and
@ -399,48 +399,51 @@ public:
Returns a boolean
*/
bool Read(const wxString& key, wxString* str);
bool Read(const wxString& key, wxString* str,
const wxString& defaultVal);
wxString Read(const wxString& key,
const
wxString& defaultVal);
bool Read(const wxString& key, long* l);
bool Read(const wxString& key, long* l, long defaultVal);
bool Read(const wxString& key, double* d);
bool Read(const wxString& key, double* d, double defaultVal);
bool Read(const wxString& key, bool* b);
bool Read(const wxString& key, bool* d, bool defaultVal);
bool Read(const wxString& key, wxMemoryBuffer* buf);
bool Read(const wxString& key, T* value);
bool Read(const wxString& key, T* value,
T const& defaultVal);
bool Read(const wxString& key, wxString* str) const;
const bool Read(const wxString& key, wxString* str,
const wxString& defaultVal) const;
const wxString Read(const wxString& key,
const
wxString& defaultVal) const;
const bool Read(const wxString& key, long* l) const;
const bool Read(const wxString& key, long* l,
long defaultVal) const;
const bool Read(const wxString& key, double* d) const;
const bool Read(const wxString& key, double* d,
double defaultVal) const;
const bool Read(const wxString& key, bool* b) const;
const bool Read(const wxString& key, bool* d,
bool defaultVal) const;
const bool Read(const wxString& key, wxMemoryBuffer* buf) const;
const bool Read(const wxString& key, T* value) const;
const bool Read(const wxString& key, T* value,
T const& defaultVal) const;
//@}
/**
Reads a bool value from the key and returns it. @a defaultVal is returned
if the key is not found.
*/
long ReadBool(const wxString& key, bool defaultVal);
long ReadBool(const wxString& key, bool defaultVal) const;
/**
Reads a double value from the key and returns it. @a defaultVal is returned
if the key is not found.
*/
long ReadDouble(const wxString& key, double defaultVal);
long ReadDouble(const wxString& key, double defaultVal) const;
/**
Reads a long value from the key and returns it. @a defaultVal is returned
if the key is not found.
*/
long ReadLong(const wxString& key, long defaultVal);
long ReadLong(const wxString& key, long defaultVal) const;
/**
Reads a value of type T, for which function
wxFromString is defined, from the key and returns it.
@a defaultVal is returned if the key is not found.
*/
T ReadObject(const wxString& key, T const& defaultVal);
T ReadObject(const wxString& key, T const& defaultVal) const;
/**
The functions in this section allow to rename entries or subgroups of the

4
interface/control.h
View File

@ -37,7 +37,7 @@ public:
any, use GetLabelText() if they are
undesired.
*/
wxString GetLabel();
wxString GetLabel() const;
//@{
/**
@ -45,7 +45,7 @@ public:
version, without the mnemonics characters.
*/
const wxString GetLabelText();
static wxString GetLabelText(const wxString& label);
const static wxString GetLabelText(const wxString& label);
//@}
/**

2
interface/cshelp.h
View File

@ -135,7 +135,7 @@ public:
/**
Returns the help controller associated with this help provider.
*/
wxHelpControllerBase* GetHelpController();
wxHelpControllerBase* GetHelpController() const;
/**
Sets the help controller associated with this help provider.

16
interface/ctrlsub.h
View File

@ -120,7 +120,7 @@ public:
@returns A pointer to the client data, or @NULL if not present.
*/
void* GetClientData(unsigned int n);
void* GetClientData(unsigned int n) const;
/**
Returns a pointer to the client data associated with the given item (if any).
@ -133,14 +133,14 @@ public:
@returns A pointer to the client data, or @NULL if not present.
*/
wxClientData* GetClientObject(unsigned int n);
wxClientData* GetClientObject(unsigned int n) const;
/**
Returns the number of items in the control.
@see IsEmpty()
*/
unsigned int GetCount();
unsigned int GetCount() const;
/**
Returns the index of the selected item or @c wxNOT_FOUND if no item is
@ -154,7 +154,7 @@ public:
@see SetSelection(), GetStringSelection()
*/
int GetSelection();
int GetSelection() const;
/**
Returns the label of the item with the given index.
@ -165,7 +165,7 @@ public:
@returns The label of the item or an empty string if the position was
invalid.
*/
wxString GetString(unsigned int n);
wxString GetString(unsigned int n) const;
/**
Returns the label of the selected item or an empty string if no item is
@ -173,12 +173,12 @@ public:
@see GetSelection()
*/
wxString GetStringSelection();
wxString GetStringSelection() const;
/**
Returns the array of the labels of all items in the control.
*/
wxArrayString GetStrings();
wxArrayString GetStrings() const;
//@{
/**
@ -225,7 +225,7 @@ public:
@see GetCount()
*/
bool IsEmpty();
bool IsEmpty() const;
/**
This is the same as SetSelection() and

2
interface/cursor.h
View File

@ -460,7 +460,7 @@ public:
/**
Returns @true if cursor data is present.
*/
bool IsOk();
bool IsOk() const;
/**
Assignment operator, using @ref overview_trefcount "reference counting".

40
interface/dataobj.h
View File

@ -69,12 +69,12 @@ public:
/**
Returns a pointer to the data.
*/
virtual void* GetData();
virtual void* GetData() const;
/**
Returns the data size in bytes.
*/
virtual size_t GetSize();
virtual size_t GetSize() const;
/**
Set the data. The data object will make an internal copy.
@ -135,7 +135,7 @@ public:
the clipboard or the DnD operation. You can use this method to find
out what kind of data object was recieved.
*/
wxDataFormat GetReceivedFormat();
wxDataFormat GetReceivedFormat() const;
};
@ -179,19 +179,19 @@ public:
Copy the data to the buffer, return @true on success. Must be implemented in the
derived class if the object supports rendering its data.
*/
virtual bool GetDataHere(void buf);
virtual bool GetDataHere(void buf) const;
/**
Gets the size of our data. Must be implemented in the derived class if the
object supports rendering its data.
*/
virtual size_t GetDataSize();
virtual size_t GetDataSize() const;
/**
Returns the (one and only one) format supported by this object. It is supposed
that the format is supported in both directions.
*/
const wxDataFormat GetFormat();
const wxDataFormat GetFormat() const;
/**
Copy the data from the buffer, return @true on success. Must be implemented in
@ -246,7 +246,7 @@ public:
wxWidgets' internals. Use this method to get data in bitmap form from
the wxClipboard.
*/
virtual wxBitmap GetBitmap();
virtual wxBitmap GetBitmap() const;
/**
Sets the bitmap associated with the data object. This method is called when the
@ -348,12 +348,12 @@ public:
Returns the name of a custom format (this function will fail for a standard
format).
*/
wxString GetId();
wxString GetId() const;
/**
Returns the platform-specific number identifying the format.
*/
NativeFormat GetType();
NativeFormat GetType() const;
/**
Sets the format to be the custom format identified by the given name.
@ -368,12 +368,12 @@ public:
/**
Returns @true if the formats are different.
*/
bool operator !=(const wxDataFormat& format);
bool operator !=(const wxDataFormat& format) const;
/**
Returns @true if the formats are equal.
*/
bool operator ==(const wxDataFormat& format);
bool operator ==(const wxDataFormat& format) const;
};
@ -407,7 +407,7 @@ public:
/**
Returns the URL stored by this object, as a string.
*/
wxString GetURL();
wxString GetURL() const;
/**
Sets the URL stored by this object.
@ -562,30 +562,30 @@ public:
@e formats. There is enough space for GetFormatCount(dir) formats in it.
*/
virtual void GetAllFormats(wxDataFormat* formats,
Direction dir = Get);
Direction dir = Get) const;
/**
The method will write the data of the format @a format in the buffer @a buf and
return @true on success, @false on failure.
*/
virtual bool GetDataHere(const wxDataFormat& format, void buf);
virtual bool GetDataHere(const wxDataFormat& format, void buf) const;
/**
Returns the data size of the given format @e format.
*/
virtual size_t GetDataSize(const wxDataFormat& format);
virtual size_t GetDataSize(const wxDataFormat& format) const;
/**
Returns the number of available formats for rendering or setting the data.
*/
virtual size_t GetFormatCount(Direction dir = Get);
virtual size_t GetFormatCount(Direction dir = Get) const;
/**
Returns the preferred format for either rendering the data (if @a dir is @c Get,
its default value) or for setting it. Usually this will be the
native format of the wxDataObject.
*/
virtual wxDataFormat GetPreferredFormat(Direction dir = Get);
virtual wxDataFormat GetPreferredFormat(Direction dir = Get) const;
/**
Set the data in the format @a format of the length @a len provided in the
@ -643,7 +643,7 @@ public:
wxWidgets' internals. Use this method to get data in text form from
the wxClipboard.
*/
virtual wxString GetText();
virtual wxString GetText() const;
/**
Returns the data size. By default, returns the size of the text data
@ -652,7 +652,7 @@ public:
to return the text length plus 1 for a trailing zero, but this is not
strictly required.
*/
virtual size_t GetTextLength();
virtual size_t GetTextLength() const;
/**
Sets the text associated with the data object. This method is called
@ -704,5 +704,5 @@ public:
/**
Returns the array of file names.
*/
const wxArrayString GetFilenames();
const wxArrayString GetFilenames() const;
};

92
interface/dataview.h
View File

@ -33,12 +33,12 @@ public:
/**
Gets the icon.
*/
const wxIcon GetIcon();
const wxIcon GetIcon() const;
/**
Gets the text.
*/
wxString GetText();
wxString GetText() const;
/**
Set the icon.
@ -76,13 +76,13 @@ public:
/**
Used to clone the event.
*/
wxEvent* Clone();
wxEvent* Clone() const;
/**
Returns the position of the column in the control or -1
if no column field was set by the event emitter.
*/
int GetColumn();
int GetColumn() const;
/**
Returns a pointer to the wxDataViewColumn from which
@ -93,17 +93,17 @@ public:
/**
Returns the wxDataViewModel associated with the event.
*/
wxDataViewModel* GetModel();
wxDataViewModel* GetModel() const;
/**
Returns a the position of a context menu event in screen coordinates.
*/
wxPoint GetPosition();
wxPoint GetPosition() const;
/**
Returns a reference to a value.
*/
const wxVariant GetValue();
const wxVariant GetValue() const;
/**
@ -206,18 +206,18 @@ public:
/**
Returns the wxDataViewItem at the given @e row.
*/
wxDataViewItem GetItem(unsigned int row);
wxDataViewItem GetItem(unsigned int row) const;
/**
Returns the position of given @e item.
*/
unsigned int GetRow(const wxDataViewItem& item);
unsigned int GetRow(const wxDataViewItem& item) const;
/**
Override this to allow getting values from the model.
*/
void GetValue(wxVariant& variant, unsigned int row,
unsigned int col);
unsigned int col) const;
/**
Call this after if the data has to be read again from
@ -407,26 +407,26 @@ public:
an item. Returns the number of items.
*/
virtual unsigned int GetChildren(const wxDataViewItem& item,
wxDataViewItemArray& children);
wxDataViewItemArray& children) const;
/**
Override this to indicate the number of columns in the model.
*/
virtual unsigned int GetColumnCount();
virtual unsigned int GetColumnCount() const;
/**
Override this to indicate what type of data is stored in the
column specified by @e col. This should return a string
indicating the type of data as reported by wxVariant.
*/
virtual wxString GetColumnType(unsigned int col);
virtual wxString GetColumnType(unsigned int col) const;
/**
Override this to indicate which wxDataViewItem representing the parent
of @a item or an invalid wxDataViewItem if the the root item is
the parent item.
*/
virtual wxDataViewItem GetParent(const wxDataViewItem& item);
virtual wxDataViewItem GetParent(const wxDataViewItem& item) const;
/**
Override this to indicate the value of @e item
@ -434,7 +434,7 @@ public:
*/
virtual void GetValue(wxVariant& variant,
const wxDataViewItem& item,
unsigned int col);
unsigned int col) const;
/**
Override this method to indicate if a container item merely
@ -442,7 +442,7 @@ public:
acts a normal item with entries for futher columns. By
default returns @e @false.
*/
virtual bool HasContainerColumns(const wxDataViewItem& item);
virtual bool HasContainerColumns(const wxDataViewItem& item) const;
/**
Override this to indicate that the model provides a default compare
@ -453,13 +453,13 @@ public:
should be used. See also wxDataViewIndexListModel
for a model which makes use of this.
*/
virtual bool HasDefaultCompare();
virtual bool HasDefaultCompare() const;
/**
Override this to indicate of @a item is a container, i.e. if
it can have child items.
*/
virtual bool IsContainer(const wxDataViewItem& item);
virtual bool IsContainer(const wxDataViewItem& item) const;
/**
Call this to inform the model that an item has been added
@ -754,12 +754,12 @@ public:
/**
Returns the ID.
*/
void* GetID();
void* GetID() const;
/**
Returns @true if the ID is not @e @NULL.
*/
bool IsOk();
bool IsOk() const;
};
@ -1011,67 +1011,67 @@ public:
position in the control which may change after reordering
columns by the user.
*/
virtual wxDataViewColumn* GetColumn(unsigned int pos);
virtual wxDataViewColumn* GetColumn(unsigned int pos) const;
/**
Returns the number of columns.
*/
virtual unsigned int GetColumnCount();
virtual unsigned int GetColumnCount() const;
/**
Returns the position of the column or -1 if not found in the control.
*/
virtual int GetColumnPosition(const wxDataViewColumn* column);
virtual int GetColumnPosition(const wxDataViewColumn* column) const;
/**
Returns column containing the expanders.
*/
wxDataViewColumn* GetExpanderColumn();
wxDataViewColumn* GetExpanderColumn() const;
/**
Returns indentation.
*/
int GetIndent();
int GetIndent() const;
/**
Returns item rect.
*/
wxRect GetItemRect(const wxDataViewItem& item,
const wxDataViewColumn* col = NULL);
const wxDataViewColumn* col = NULL) const;
/**
Returns pointer to the data model associated with the
control (if any).
*/
virtual wxDataViewModel* GetModel();
virtual wxDataViewModel* GetModel() const;
/**
Returns first selected item or an invalid item if none is selected.
*/
wxDataViewItem GetSelection();
wxDataViewItem GetSelection() const;
/**
Fills @a sel with currently selected items and returns
their number.
*/
int GetSelections(wxDataViewItemArray& sel);
int GetSelections(wxDataViewItemArray& sel) const;
/**
Returns the wxDataViewColumn currently responsible for sorting
or @NULL if none has been selected.
*/
virtual wxDataViewColumn* GetSortingColumn();
virtual wxDataViewColumn* GetSortingColumn() const;
/**
Hittest.
*/
void HitTest(const wxPoint& point, wxDataViewItem& item,
wxDataViewColumn*& col);
wxDataViewColumn*& col) const;
/**
Return @true if the item is selected.
*/
bool IsSelected(const wxDataViewItem& item);
bool IsSelected(const wxDataViewItem& item) const;
/**
Select the given item.
@ -1481,7 +1481,7 @@ public:
/**
Calls the identical method from wxDataViewTreeStore.
*/
int GetChildCount(const wxDataViewItem& parent);
int GetChildCount(const wxDataViewItem& parent) const;
/**
Returns the image list.
@ -1491,35 +1491,35 @@ public:
/**
Calls the identical method from wxDataViewTreeStore.
*/
wxClientData* GetItemData(const wxDataViewItem& item);
wxClientData* GetItemData(const wxDataViewItem& item) const;
/**
Calls the identical method from wxDataViewTreeStore.
*/
const wxIcon GetItemExpandedIcon(const wxDataViewItem& item);
const wxIcon GetItemExpandedIcon(const wxDataViewItem& item) const;
/**
Calls the identical method from wxDataViewTreeStore.
*/
const wxIcon GetItemIcon(const wxDataViewItem& item);
const wxIcon GetItemIcon(const wxDataViewItem& item) const;
/**
Calls the identical method from wxDataViewTreeStore.
*/
wxString GetItemText(const wxDataViewItem& item);
wxString GetItemText(const wxDataViewItem& item) const;
/**
Calls the identical method from wxDataViewTreeStore.
*/
wxDataViewItem GetNthChild(const wxDataViewItem& parent,
unsigned int pos);
unsigned int pos) const;
//@{
/**
Returns the store.
*/
wxDataViewTreeStore* GetStore();
const wxDataViewTreeStore* GetStore();
wxDataViewTreeStore* GetStore() const;
const wxDataViewTreeStore* GetStore() const;
//@}
/**
@ -1653,33 +1653,33 @@ public:
/**
Return the number of children of item.
*/
int GetChildCount(const wxDataViewItem& parent);
int GetChildCount(const wxDataViewItem& parent) const;
/**
Returns the client data asoociated with the item.
*/
wxClientData* GetItemData(const wxDataViewItem& item);
wxClientData* GetItemData(const wxDataViewItem& item) const;
/**
Returns the icon to display in expanded containers.
*/
const wxIcon GetItemExpandedIcon(const wxDataViewItem& item);
const wxIcon GetItemExpandedIcon(const wxDataViewItem& item) const;
/**
Returns the icon of the item.
*/
const wxIcon GetItemIcon(const wxDataViewItem& item);
const wxIcon GetItemIcon(const wxDataViewItem& item) const;
/**
Returns the text of the item.
*/
wxString GetItemText(const wxDataViewItem& item);
wxString GetItemText(const wxDataViewItem& item) const;
/**
Returns the nth child item of item.
*/
wxDataViewItem GetNthChild(const wxDataViewItem& parent,
unsigned int pos);
unsigned int pos) const;
/**
Inserts a container after @e previous.

4
interface/datectrl.h
View File

@ -119,13 +119,13 @@ public:
@returns @false if no range limits are currently set, @true if at least one
bound is set.
*/
bool GetRange(wxDateTime* dt1, wxDateTime dt2);
bool GetRange(wxDateTime* dt1, wxDateTime dt2) const;
/**
Returns the currently selected. If there is no selection or the selection is
outside of the current range, an invalid object is returned.
*/
wxDateTime GetValue();
wxDateTime GetValue() const;
/**
Please note that this function is only available in the generic version of this

2
interface/dateevt.h
View File

@ -23,7 +23,7 @@ public:
/**
Returns the date.
*/
const wxDateTime GetDate();
const wxDateTime GetDate() const;
/**
Sets the date carried by the event, normally only used by the library

156
interface/datetime.h
View File

@ -78,7 +78,7 @@ public:
Adds the given date span to this object.
*/
wxDateTime Add(const wxDateSpan& diff);
wxDateTime Add(const wxDateSpan& diff);
const wxDateTime& Add(const wxDateSpan& diff);
wxDateTime operator+=(const wxDateSpan& diff);
//@}
@ -265,13 +265,13 @@ public:
@see ParseFormat()
*/
wxString Format(const wxChar* format = wxDefaultDateTimeFormat,
const TimeZone& tz = Local);
const TimeZone& tz = Local) const;
/**
Identical to calling Format() with @c "%x"
argument (which means 'preferred date representation for the current locale').
*/
wxString FormatDate();
wxString FormatDate() const;
/**
Returns the combined date-time representation in the ISO 8601 format
@ -283,25 +283,25 @@ public:
@see FormatISODate(), FormatISOTime(),
ParseISOCombined()
*/
wxString FormatISOCombined(char sep = 'T');
wxString FormatISOCombined(char sep = 'T') const;
/**
This function returns the date representation in the ISO 8601 format
(YYYY-MM-DD).
*/
wxString FormatISODate();
wxString FormatISODate() const;
/**
This function returns the time representation in the ISO 8601 format
(HH:MM:SS).
*/
wxString FormatISOTime();
wxString FormatISOTime() const;
/**
Identical to calling Format() with @c "%X"
argument (which means 'preferred time representation for the current locale').
*/
wxString FormatTime();
wxString FormatTime() const;
/**
Transform the date from the given time zone to the local one. If @a noDST is
@ -309,7 +309,7 @@ public:
Returns the date in the local time zone.
*/
wxDateTime FromTimezone(const TimeZone& tz,
bool noDST = false);
bool noDST = false) const;
/**
Returns the translations of the strings @c AM and @c PM used for time
@ -323,7 +323,7 @@ public:
DOS
format.
*/
unsigned long GetAsDOS();
unsigned long GetAsDOS() const;
/**
Get the beginning of DST for the given country in the given year (current one
@ -338,7 +338,7 @@ public:
/**
Returns the century of this date.
*/
int GetCentury(const TimeZone& tz = Local);
int GetCentury(const TimeZone& tz = Local) const;
/**
Returns the current default country. The default country is used for DST
@ -365,18 +365,18 @@ public:
@see ResetTime()
*/
wxDateTime GetDateOnly();
wxDateTime GetDateOnly() const;
/**
Returns the day in the given timezone (local one by default).
*/
wxDateTime_t GetDay(const TimeZone& tz = Local);
wxDateTime_t GetDay(const TimeZone& tz = Local) const;
/**
Returns the day of the year (in 1...366 range) in the given timezone
(local one by default).
*/
wxDateTime_t GetDayOfYear(const TimeZone& tz = Local);
wxDateTime_t GetDayOfYear(const TimeZone& tz = Local) const;
/**
Returns the end of DST for the given country in the given year (current one by
@ -390,12 +390,12 @@ public:
/**
Returns the hour in the given timezone (local one by default).
*/
wxDateTime_t GetHour(const TimeZone& tz = Local);
wxDateTime_t GetHour(const TimeZone& tz = Local) const;
/**
Synonym for GetJulianDayNumber().
*/
double GetJDN();
double GetJDN() const;
/**
Returns the @ref setjdn() JDN corresponding to this date. Beware
@ -403,14 +403,14 @@ public:
@see GetModifiedJulianDayNumber()
*/
double GetJulianDayNumber();
double GetJulianDayNumber() const;
/**
Returns the copy of this object to which
SetToLastMonthDay() was applied.
*/
wxDateTime GetLastMonthDay(Month month = Inv_Month,
int year = Inv_Year);
int year = Inv_Year) const;
/**
Returns the copy of this object to which
@ -423,17 +423,17 @@ public:
/**
Synonym for GetModifiedJulianDayNumber().
*/
double GetMJD();
double GetMJD() const;
/**
Returns the milliseconds in the given timezone (local one by default).
*/
wxDateTime_t GetMillisecond(const TimeZone& tz = Local);
wxDateTime_t GetMillisecond(const TimeZone& tz = Local) const;
/**
Returns the minute in the given timezone (local one by default).
*/
wxDateTime_t GetMinute(const TimeZone& tz = Local);
wxDateTime_t GetMinute(const TimeZone& tz = Local) const;
/**
Returns the @e Modified Julian Day Number (MJD) which is, by definition,
@ -441,12 +441,12 @@ public:
MJDs correspond to midnights of the dates in the Gregorian calendar and not th
noons like JDN. The MJD 0 is Nov 17, 1858.
*/
double GetModifiedJulianDayNumber();
double GetModifiedJulianDayNumber() const;
/**
Returns the month in the given timezone (local one by default).
*/
Month GetMonth(const TimeZone& tz = Local);
Month GetMonth(const TimeZone& tz = Local) const;
/**
Gets the full (default) or abbreviated (specify @c Name_Abbr name of the
@ -461,7 +461,7 @@ public:
Returns the copy of this object to which
SetToNextWeekDay() was applied.
*/
wxDateTime GetNextWeekDay(WeekDay weekday);
wxDateTime GetNextWeekDay(WeekDay weekday) const;
//@{
/**
@ -480,7 +480,7 @@ public:
Returns the copy of this object to which
SetToPrevWeekDay() was applied.
*/
wxDateTime GetPrevWeekDay(WeekDay weekday);
wxDateTime GetPrevWeekDay(WeekDay weekday) const;
/**
Return the @e Rata Die number of this date.
@ -488,18 +488,18 @@ public:
relative to a base date of December 31 of the year 0. Thus January 1 of the
year 1 is Rata Die day 1.
*/
double GetRataDie();
double GetRataDie() const;
/**
Returns the seconds in the given timezone (local one by default).
*/
wxDateTime_t GetSecond(const TimeZone& tz = Local);
wxDateTime_t GetSecond(const TimeZone& tz = Local) const;
/**
Returns the number of seconds since Jan 1, 1970. An assert failure will occur
if the date is not in the range covered by @c time_t type.
*/
time_t GetTicks();
time_t GetTicks() const;
/**
Returns the current time.
@ -509,7 +509,7 @@ public:
/**
Returns broken down representation of the date and time.
*/
Tm GetTm(const TimeZone& tz = Local);
Tm GetTm(const TimeZone& tz = Local) const;
/**
Returns the current time broken down. Note that this function returns a
@ -527,7 +527,7 @@ public:
*/
wxDateTime GetWeekDay(WeekDay weekday, int n = 1,
Month month = Inv_Month,
int year = Inv_Year);
int year = Inv_Year) const;
/**
Returns the copy of this object to which
@ -535,7 +535,7 @@ public:
applied.
*/
wxDateTime GetWeekDayInSameWeek(WeekDay weekday,
WeekFlags flags = Monday_First);
WeekFlags flags = Monday_First) const;
/**
Gets the full (default) or abbreviated (specify @c Name_Abbr name of the
@ -553,7 +553,7 @@ public:
@ref overview_wxdatetime "week start" conventions.
*/
wxDateTime_t GetWeekOfMonth(WeekFlags flags = Monday_First,
const TimeZone& tz = Local);
const TimeZone& tz = Local) const;
/**
Returns the number of the week of the year this date is in. The first week of
@ -568,18 +568,18 @@ public:
applies to the weeks starting on Monday only.
*/
wxDateTime_t GetWeekOfYear(WeekFlags flags = Monday_First,
const TimeZone& tz = Local);
const TimeZone& tz = Local) const;
/**
Returns the year in the given timezone (local one by default).
*/
int GetYear(const TimeZone& tz = Local);
int GetYear(const TimeZone& tz = Local) const;
/**
Returns the copy of this object to which
SetToYearDay() was applied.
*/
wxDateTime GetYearDay(wxDateTime_t yday);
wxDateTime GetYearDay(wxDateTime_t yday) const;
/**
Returns @true if IsStrictlyBetween()
@ -587,12 +587,12 @@ public:
@see IsStrictlyBetween()
*/
bool IsBetween(const wxDateTime& t1, const wxDateTime& t2);
bool IsBetween(const wxDateTime& t1, const wxDateTime& t2) const;
/**
Returns @true if the DST is applied for this date in the given country.
*/
int IsDST(Country country = Country_Default);
int IsDST(Country country = Country_Default) const;
/**
Returns @true if DST was used n the given year (the current one by
@ -604,31 +604,31 @@ public:
/**
Returns @true if this date precedes the given one.
*/
bool IsEarlierThan(const wxDateTime& datetime);
bool IsEarlierThan(const wxDateTime& datetime) const;
/**
Returns @true if the two dates are strictly identical.
*/
bool IsEqualTo(const wxDateTime& datetime);
bool IsEqualTo(const wxDateTime& datetime) const;
/**
Returns @true if the date is equal to another one up to the given time
interval, i.e. if the absolute difference between the two dates is less than
this interval.
*/
bool IsEqualUpTo(const wxDateTime& dt, const wxTimeSpan& ts);
bool IsEqualUpTo(const wxDateTime& dt, const wxTimeSpan& ts) const;
/**
Returns @true if the given date is later than the date of adoption of the
Gregorian calendar in the given country (and hence the Gregorian calendar
calculations make sense for it).
*/
bool IsGregorianDate(GregorianAdoption country = Gr_Standard);
bool IsGregorianDate(GregorianAdoption country = Gr_Standard) const;
/**
Returns @true if this date is later than the given one.
*/
bool IsLaterThan(const wxDateTime& datetime);
bool IsLaterThan(const wxDateTime& datetime) const;
/**
Returns @true if the @a year is a leap one in the specified calendar.
@ -640,12 +640,12 @@ public:
/**
Returns @true if the date is the same without comparing the time parts.
*/
bool IsSameDate(const wxDateTime& dt);
bool IsSameDate(const wxDateTime& dt) const;
/**
Returns @true if the time is the same (although dates may differ).
*/
bool IsSameTime(const wxDateTime& dt);
bool IsSameTime(const wxDateTime& dt) const;
/**
Returns @true if this date lies strictly between the two others,
@ -653,12 +653,12 @@ public:
@see IsBetween()
*/
bool IsStrictlyBetween(const wxDateTime& t1,
const wxDateTime& t2);
const wxDateTime& t2) const;
/**
Returns @true if the object represents a valid time moment.
*/
bool IsValid();
bool IsValid() const;
/**
This function returns @true if the specified (or default) country is one
@ -670,7 +670,7 @@ public:
/**
Returns @true is this day is not a holiday in the given country.
*/
bool IsWorkDay(Country country = Country_Default);
bool IsWorkDay(Country country = Country_Default) const;
/**
Same as FromTimezone() but modifies the object
@ -1091,7 +1091,7 @@ public:
Subtracts another date from this one and returns the difference between them
as wxTimeSpan.
*/
wxTimeSpan Subtract(const wxDateTime& dt);
wxTimeSpan Subtract(const wxDateTime& dt) const;
/**
Please see the @ref overview_tdatetimezones "time zone overview" for more
@ -1121,13 +1121,13 @@ public:
DST adjustments will be made.
Returns the date in the new time zone.
*/
wxDateTime ToTimezone(const TimeZone& tz, bool noDST = false);
wxDateTime ToTimezone(const TimeZone& tz, bool noDST = false) const;
/**
This is the same as calling ToTimezone() with
the argument @c GMT0.
*/
wxDateTime ToUTC(bool noDST = false);
wxDateTime ToUTC(bool noDST = false) const;
/**
Returns the object corresponding to the midnight of the current day (i.e. the
@ -1229,7 +1229,7 @@ public:
second and third ones modify this object in place.
*/
wxDateSpan Add(const wxDateSpan& other);
wxDateSpan Add(const wxDateSpan& other);
const wxDateSpan& Add(const wxDateSpan& other);
wxDateSpan operator+=(const wxDateSpan& other);
//@}
@ -1253,12 +1253,12 @@ public:
@see GetTotalDays()
*/
int GetDays();
int GetDays() const;
/**
Returns the number of the months (not counting the years) in this date span.
*/
int GetMonths();
int GetMonths() const;
/**
Returns the combined number of days in this date span, counting both weeks and
@ -1266,19 +1266,19 @@ public:
@see GetWeeks(), GetDays()
*/
int GetTotalDays();
int GetTotalDays() const;
/**
Returns the number of weeks in this date span.
@see GetTotalDays()
*/
int GetWeeks();
int GetWeeks() const;
/**
Returns the number of years in this date span.
*/
int GetYears();
int GetYears() const;
/**
Returns a date span object corresponding to one month.
@ -1302,7 +1302,7 @@ public:
object in place.
*/
wxDateSpan Multiply(int factor);
wxDateSpan Multiply(int factor);
const wxDateSpan& Multiply(int factor);
wxDateSpan operator*=(int factor);
//@}
@ -1321,7 +1321,7 @@ public:
@see Neg()
*/
wxDateSpan Negate();
wxDateSpan Negate() const;
/**
Sets the number of days (without modifying any other components) in this date
@ -1353,7 +1353,7 @@ public:
object, the second and third ones modify this object in place.
*/
wxDateSpan Subtract(const wxDateSpan& other);
wxDateSpan Subtract(const wxDateSpan& other);
const wxDateSpan& Subtract(const wxDateSpan& other);
wxDateSpan operator+=(const wxDateSpan& other);
//@}
@ -1388,14 +1388,14 @@ public:
/**
Returns @true if this date span is different from the other one.
*/
bool operator!=(wxDateSpan& other);
bool operator!=(wxDateSpan& other) const;
/**
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
months and the same total number of days (counting both days and weeks).
*/
bool operator==(wxDateSpan& other);
bool operator==(wxDateSpan& other) const;
};
@ -1428,7 +1428,7 @@ public:
Returns the absolute value of the timespan: does not modify the
object.
*/
wxTimeSpan Abs();
wxTimeSpan Abs() const;
/**
GetSeconds()
@ -1450,7 +1450,7 @@ public:
Returns the sum of two timespans.
*/
wxTimeSpan Add(const wxTimeSpan& diff);
wxTimeSpan Add(const wxTimeSpan& diff);
const wxTimeSpan& Add(const wxTimeSpan& diff);
wxTimeSpan operator+=(const wxTimeSpan& diff);
//@}
@ -1522,37 +1522,37 @@ public:
/**
Returns the difference in number of days.
*/
int GetDays();
int GetDays() const;
/**
Returns the difference in number of hours.
*/
int GetHours();
int GetHours() const;
/**
Returns the difference in number of milliseconds.
*/
wxLongLong GetMilliseconds();
wxLongLong GetMilliseconds() const;
/**
Returns the difference in number of minutes.
*/
int GetMinutes();
int GetMinutes() const;
/**
Returns the difference in number of seconds.
*/
wxLongLong GetSeconds();
wxLongLong GetSeconds() const;
/**
Returns the internal representation of timespan.
*/
wxLongLong GetValue();
wxLongLong GetValue() const;
/**
Returns the difference in number of weeks.
*/
int GetWeeks();
int GetWeeks() const;
/**
Returns the timespan for one hour.
@ -1567,36 +1567,36 @@ public:
/**
Returns @true if two timespans are equal.
*/
bool IsEqualTo(const wxTimeSpan& ts);
bool IsEqualTo(const wxTimeSpan& ts) const;
/**
Compares two timespans: works with the absolute values, i.e. -2
hours is longer than 1 hour. Also, it will return @false if
the timespans are equal in absolute value.
*/
bool IsLongerThan(const wxTimeSpan& ts);
bool IsLongerThan(const wxTimeSpan& ts) const;
/**
Returns @true if the timespan is negative.
*/
bool IsNegative();
bool IsNegative() const;
/**
Returns @true if the timespan is empty.
*/
bool IsNull();
bool IsNull() const;
/**
Returns @true if the timespan is positive.
*/
bool IsPositive();
bool IsPositive() const;
/**
Compares two timespans: works with the absolute values, i.e. 1
hour is shorter than -2 hours. Also, it will return @false if
the timespans are equal in absolute value.
*/
bool IsShorterThan(const wxTimeSpan& ts);
bool IsShorterThan(const wxTimeSpan& ts) const;
/**
Returns the timespan for one millisecond.
@ -1623,7 +1623,7 @@ public:
Multiplies timespan by a scalar.
*/
wxTimeSpan Multiply(int n);
wxTimeSpan Multiply(int n);
const wxTimeSpan& Multiply(int n);
wxTimeSpan operator*=(int n);
//@}
@ -1638,7 +1638,7 @@ public:
/**
Returns timespan with inverted sign.
*/
wxTimeSpan Negate();
wxTimeSpan Negate() const;
/**
Add()
@ -1697,7 +1697,7 @@ public:
Returns the difference of two timespans.
*/
wxTimeSpan Subtract(const wxTimeSpan& diff);
wxTimeSpan Subtract(const wxTimeSpan& diff);
const wxTimeSpan& Subtract(const wxTimeSpan& diff);
wxTimeSpan operator-=(const wxTimeSpan& diff);
//@}

38
interface/dc.h
View File

@ -435,19 +435,19 @@ public:
/**
Gets the brush used for painting the background (see wxDC::SetBackground).
*/
const wxBrush GetBackground();
const wxBrush GetBackground() const;
/**
Returns the current background mode: @c wxSOLID or @c wxTRANSPARENT.
@see SetBackgroundMode()
*/
int GetBackgroundMode();
int GetBackgroundMode() const;
/**
Gets the current brush (see wxDC::SetBrush).
*/
const wxBrush GetBrush();
const wxBrush GetBrush() const;
/**
Gets the character height of the currently set font.
@ -470,7 +470,7 @@ public:
@see wxDisplayDepth
*/
int GetDepth();
int GetDepth() const;
/**
Gets the current font. Notice that even although each device context object has
@ -478,7 +478,7 @@ public:
initially and only after calling SetFont() a valid
font is returned.
*/
const wxFont GetFont();
const wxFont GetFont() const;
/**
Gets the current layout direction of the device context. On platforms where RTL
@ -489,7 +489,7 @@ public:
@see SetLayoutDirection()
*/
wxLayoutDirection GetLayoutDirection();
wxLayoutDirection GetLayoutDirection() const;
/**
Gets the current logical function (see wxDC::SetLogicalFunction).
@ -517,14 +517,14 @@ public:
void GetMultiLineTextExtent(const wxString& string, wxCoord* w,
wxCoord* h,
wxCoord* heightLine = NULL,
wxFont* font = NULL);
wxSize GetMultiLineTextExtent(const wxString& string);
wxFont* font = NULL) const;
const wxSize GetMultiLineTextExtent(const wxString& string) const;
//@}
/**
Returns the resolution of the device in pixels per inch.
*/
wxSize GetPPI();
wxSize GetPPI() const;
/**
Fills the @a widths array with the widths from the beginning of
@ -538,12 +538,12 @@ public:
@see GetMultiLineTextExtent(), GetTextExtent()
*/
bool GetPartialTextExtents(const wxString& text,
wxArrayInt& widths);
wxArrayInt& widths) const;
/**
Gets the current pen (see wxDC::SetPen).
*/
const wxPen GetPen();
const wxPen GetPen() const;
/**
Gets in @a colour the colour at the specified location.
@ -571,22 +571,22 @@ public:
Returns a 2-element list
@c ( width, height )
*/
void GetSize(wxCoord* width, wxCoord* height);
wxSize GetSize();
void GetSize(wxCoord* width, wxCoord* height) const;
const wxSize GetSize() const;
//@}
//@{
/**
Returns the horizontal and vertical resolution in millimetres.
*/
void GetSizeMM(wxCoord* width, wxCoord* height);
wxSize GetSizeMM();
void GetSizeMM(wxCoord* width, wxCoord* height) const;
const wxSize GetSizeMM() const;
//@}
/**
Gets the current text background colour (see wxDC::SetTextBackground).
*/
const wxColour GetTextBackground();
const wxColour GetTextBackground() const;
//@{
/**
@ -608,14 +608,14 @@ public:
wxCoord* h,
wxCoord* descent = NULL,
wxCoord* externalLeading = NULL,
const wxFont* font = NULL);
wxSize GetTextExtent(const wxString& string);
const wxFont* font = NULL) const;
const wxSize GetTextExtent(const wxString& string) const;
//@}
/**
Gets the current text foreground colour (see wxDC::SetTextForeground).
*/
const wxColour GetTextForeground();
const wxColour GetTextForeground() const;
/**
Gets the current user scale factor (set by wxDC::SetUserScale).

26
interface/dcsvg.h
View File

@ -334,8 +334,8 @@ public:
Gets the brush used for painting the background (see
wxSVGFileDC::SetBackground).
*/
wxBrush GetBackground();
const wxBrush GetBackground();
wxBrush GetBackground() const;
const wxBrush GetBackground() const;
//@}
/**
@ -343,14 +343,14 @@ public:
@see wxDC::SetBackgroundMode
*/
int GetBackgroundMode();
int GetBackgroundMode() const;
//@{
/**
Gets the current brush (see wxSVGFileDC::SetBrush).
*/
wxBrush GetBrush();
const wxBrush GetBrush();
wxBrush GetBrush() const;
const wxBrush GetBrush() const;
//@}
/**
@ -373,8 +373,8 @@ public:
/**
Gets the current font (see wxSVGFileDC::SetFont).
*/
wxFont GetFont();
const wxFont GetFont();
wxFont GetFont() const;
const wxFont GetFont() const;
//@}
/**
@ -391,8 +391,8 @@ public:
/**
Gets the current pen (see wxSVGFileDC::SetPen).
*/
wxPen GetPen();
const wxPen GetPen();
wxPen GetPen() const;
const wxPen GetPen() const;
//@}
/**
@ -410,8 +410,8 @@ public:
/**
Gets the current text background colour (see wxSVGFileDC::SetTextBackground).
*/
wxColour GetTextBackground();
const wxColour GetTextBackground();
wxColour GetTextBackground() const;
const wxColour GetTextBackground() const;
//@}
/**
@ -437,8 +437,8 @@ public:
/**
Gets the current text foreground colour (see wxSVGFileDC::SetTextForeground).
*/
wxColour GetTextForeground();
const wxColour GetTextForeground();
wxColour GetTextForeground() const;
const wxColour GetTextForeground() const;
//@}
/**

16
interface/debugrpt.h
View File

@ -43,7 +43,7 @@ public:
report should be processed or @false if the user chose to cancel report
generation or removed all files from it.
*/
bool Show(wxDebugReport& dbgrpt);
bool Show(wxDebugReport& dbgrpt) const;
};
@ -69,7 +69,7 @@ public:
/**
Returns the full path of the compressed file (empty if creation failed).
*/
const wxString GetCompressedFileName();
const wxString GetCompressedFileName() const;
};
@ -209,7 +209,7 @@ public:
This method should be used to construct the full name of the files which you
wish to add to the report using AddFile().
*/
const wxString GetDirectory();
const wxString GetDirectory() const;
/**
Retrieves the name (relative to
@ -217,25 +217,25 @@ public:
file with the given index. If @a n is greater than or equal to the number of
filse, @false is returned.
*/
bool GetFile(size_t n, wxString* name, wxString* desc);
bool GetFile(size_t n, wxString* name, wxString* desc) const;
/**
Gets the current number files in this report.
*/
size_t GetFilesCount();
size_t GetFilesCount() const;
/**
Gets the name used as a base name for various files, by default
wxApp::GetAppName is used.
*/
wxString GetReportName();
wxString GetReportName() const;
/**
Returns @true if the object was successfully initialized. If this method
returns
@false the report can't be used.
*/
bool IsOk();
bool IsOk() const;
/**
Processes this report: the base class simply notifies the user that the
@ -283,7 +283,7 @@ public:
wxDebugReportPreview::Show for more
information.
*/
bool Show(wxDebugReport& dbgrpt);
bool Show(wxDebugReport& dbgrpt) const;
};

18
interface/dialog.h
View File

@ -215,7 +215,7 @@ public:
@see SetAffirmativeId()
*/
int GetAffirmativeId();
int GetAffirmativeId() const;
/**
Override this to return a window containing the main content of the dialog.
@ -225,7 +225,7 @@ public:
and allows the @ref overview_wxdialogoverview "layout adaptation code" to know
that only the pages need to be made scrollable.
*/
wxWindow* GetContentWindow();
wxWindow* GetContentWindow() const;
/**
Gets the identifier of the button to map presses of @c ESC
@ -233,7 +233,7 @@ public:
@see SetEscapeId()
*/
int GetEscapeId();
int GetEscapeId() const;
/**
Returns @true if the dialog has been adapted, usually by making it scrollable
@ -241,7 +241,7 @@ public:
See also @ref overview_autoscrollingdialogs "Automatic scrolling dialogs" for
more on layout adaptation.
*/
bool GetLayoutAdaptationDone();
bool GetLayoutAdaptationDone() const;
/**
Gets a value representing the aggressiveness of search for buttons and sizers
@ -258,7 +258,7 @@ public:
See also SetLayoutAdaptationMode() and @ref overview_autoscrollingdialogs
"Automatic scrolling dialogs".
*/
wxDialogLayoutAdaptationMode GetLayoutAdaptationMode();
wxDialogLayoutAdaptationMode GetLayoutAdaptationMode() const;
/**
A static function getting the current layout adapter object.
@ -292,7 +292,7 @@ public:
arbitrary controls are not currently supported.
This function is not available on any other platform.
*/
wxToolBar* GetToolBar();
wxToolBar* GetToolBar() const;
/**
Iconizes or restores the dialog. Windows only.
@ -315,7 +315,7 @@ public:
@remarks Always returns @false under Windows since dialogs cannot be
iconized.
*/
bool IsIconized();
bool IsIconized() const;
/**
A static function returning @true if layout adaptation is enabled for all
@ -331,12 +331,12 @@ public:
See also @ref overview_autoscrollingdialogs "Automatic scrolling dialogs" for
more on layout adaptation.
*/
bool IsMainButton(wxWindowID& id);
bool IsMainButton(wxWindowID& id) const;
/**
Returns @true if the dialog box is modal, @false otherwise.
*/
bool IsModal();
bool IsModal() const;
/**
The default handler for wxEVT_SYS_COLOUR_CHANGED.

18
interface/dialup.h
View File

@ -99,7 +99,7 @@ public:
parameter to Dial() on this machine and returns
their number (may be 0).
*/
size_t GetISPNames(wxArrayString& names);
size_t GetISPNames(wxArrayString& names) const;
/**
Hang up the currently active dial up connection.
@ -113,14 +113,14 @@ public:
guaranteed to be correct, so it is better to ask user for
confirmation or give him a possibility to override it.
*/
bool IsAlwaysOnline();
bool IsAlwaysOnline() const;
/**
Returns @true if (async) dialing is in progress.
@see Dial()
*/
bool IsDialing();
bool IsDialing() const;
/**
Returns @true if the dialup manager was initialized correctly. If this
@ -128,7 +128,7 @@ public:
good idea to call this function and check its result before calling any other
wxDialUpManager methods
*/
bool IsOk();
bool IsOk() const;
/**
Returns @true if the computer is connected to the network: under Windows,
@ -136,14 +136,14 @@ public:
the "well-known host" (as specified by
wxDialUpManager::SetWellKnownHost) is reachable.
*/
bool IsOnline();
bool IsOnline() const;
/**
, @b const wxString&@e commandHangup = wxT("/usr/bin/poff"))
, wxString&@e commandHangup = wxT("/usr/bin/poff"))
This method is for Unix only.
Sets the commands to start up the network and to hang up again.
*/
void SetConnectCommand();
void SetConnectCommand() const;
/**
Sometimes the built-in logic for determining the online status may fail,
@ -187,12 +187,12 @@ public:
Is this a @c CONNECTED or @c DISCONNECTED event? In other words, does it
notify about transition from offline to online state or vice versa?
*/
bool IsConnectedEvent();
bool IsConnectedEvent() const;
/**
Does this event come from wxDialUpManager::Dial() or from some extrenal
process (i.e. does it result from our own attempt to establish the
connection)?
*/
bool IsOwnEvent();
bool IsOwnEvent() const;
};

8
interface/dir.h
View File

@ -175,19 +175,19 @@ public:
*/
bool GetFirst(wxString* filename,
const wxString& filespec = wxEmptyString,
int flags = wxDIR_DEFAULT);
int flags = wxDIR_DEFAULT) const;
/**
Returns the name of the directory itself. The returned string does not have the
trailing path separator (slash or backslash).
*/
wxString GetName();
wxString GetName() const;
/**
Continue enumerating files which satisfy the criteria specified by the last
call to GetFirst().
*/
bool GetNext(wxString* filename);
bool GetNext(wxString* filename) const;
/**
Returns the size (in bytes) of all files recursively found in @c dir or
@ -226,7 +226,7 @@ public:
Returns @true if the directory was successfully opened by a previous call to
Open().
*/
bool IsOpened();
bool IsOpened() const;
/**
Open the directory for enumerating, returns @true on success

14
interface/dirctrl.h
View File

@ -96,33 +96,33 @@ public:
/**
Gets the default path.
*/
wxString GetDefaultPath();
wxString GetDefaultPath() const;
/**
Gets selected filename path only (else empty string).
This function doesn't count a directory as a selection.
*/
wxString GetFilePath();
wxString GetFilePath() const;
/**
Returns the filter string.
*/
wxString GetFilter();
wxString GetFilter() const;
/**
Returns the current filter index (zero-based).
*/
int GetFilterIndex();
int GetFilterIndex() const;
/**
Returns a pointer to the filter list control (if present).
*/
wxDirFilterListCtrl* GetFilterListCtrl();
wxDirFilterListCtrl* GetFilterListCtrl() const;
/**
Gets the currently-selected directory or filename.
*/
wxString GetPath();
wxString GetPath() const;
/**
Returns the root id for the tree control.
@ -132,7 +132,7 @@ public:
/**
Returns a pointer to the tree control.
*/
wxTreeCtrl* GetTreeCtrl();
wxTreeCtrl* GetTreeCtrl() const;
/**
Initializes variables.

4
interface/dirdlg.h
View File

@ -70,12 +70,12 @@ public:
/**
Returns the message that will be displayed on the dialog.
*/
wxString GetMessage();
wxString GetMessage() const;
/**
Returns the default or user-selected path.
*/
wxString GetPath();
wxString GetPath() const;
/**
Sets the message that will be displayed on the dialog.

12
interface/display.h
View File

@ -58,7 +58,7 @@ public:
same as GetGeometry() but it could be less if
there is a taskbar (or equivalent) on this display.
*/
wxRect GetClientArea();
wxRect GetClientArea() const;
/**
Returns the number of connected displays.
@ -68,12 +68,12 @@ public:
/**
Returns the current video mode that this display is in.
*/
wxVideoMode GetCurrentMode();
wxVideoMode GetCurrentMode() const;
/**
Returns the bit depth of the display whose index was passed to the constructor.
*/
int GetDepth();
int GetDepth() const;
/**
Returns the index of the display on which the given point lies. Returns
@ -99,7 +99,7 @@ public:
Returns the bounding rectangle of the display whose index was passed to the
constructor.
*/
wxRect GetGeometry();
wxRect GetGeometry() const;
/**
Fills and returns an array with all the video modes that
@ -107,12 +107,12 @@ public:
supported by this display and match the mode parameter
(if mode is not wxDefaultVideoMode).
*/
wxArrayVideoModes GetModes(const wxVideoMode& mode = wxDefaultVideoMode);
wxArrayVideoModes GetModes(const wxVideoMode& mode = wxDefaultVideoMode) const;
/**
Returns the display's name. A name is not available on all platforms.
*/
wxString GetName();
wxString GetName() const;
/**
Returns @true if the display is the primary display. The primary display is the

4
interface/docmdi.h
View File

@ -109,12 +109,12 @@ public:
/**
Returns the document associated with this frame.
*/
wxDocument* GetDocument();
wxDocument* GetDocument() const;
/**
Returns the view associated with this frame.
*/
wxView* GetView();
wxView* GetView() const;
/**
Sets the currently active view to be the frame's view. You may need

46
interface/docview.h
View File

@ -430,7 +430,7 @@ public:
Returns the directory last selected by the user when opening a file. Initially
empty.
*/
wxString GetLastDirectory();
wxString GetLastDirectory() const;
/**
Returns the number of documents that can be open simultaneously.
@ -688,12 +688,12 @@ public:
/**
Gets a pointer to the document associated with the view.
*/
wxDocument* GetDocument();
wxDocument* GetDocument() const;
/**
Returns a pointer to the document manager instance associated with this view.
*/
wxDocManager* GetDocumentManager();
wxDocManager* GetDocumentManager() const;
/**
Gets the frame associated with the view (if any). Note that this "frame'' is
@ -708,7 +708,7 @@ public:
constructor).
Not currently used by the framework.
*/
wxString GetViewName();
wxString GetViewName() const;
/**
Called when a view is activated by means of Activate(). The default
@ -858,12 +858,12 @@ public:
/**
Returns the document associated with this frame.
*/
wxDocument* GetDocument();
wxDocument* GetDocument() const;
/**
Returns the view associated with this frame.
*/
wxView* GetView();
wxView* GetView() const;
/**
Sets the currently active view to be the frame's view. You may need
@ -954,7 +954,7 @@ public:
/**
Returns the associated @ref overview_wxdocmanager "document manager object".
*/
wxDocManager* GetDocumentManager();
wxDocManager* GetDocumentManager() const;
/**
Deletes all views and documents. If no user input cancelled the
@ -1024,62 +1024,62 @@ public:
Returns a pointer to the command processor associated with this document.
See wxCommandProcessor.
*/
wxCommandProcessor* GetCommandProcessor();
wxCommandProcessor* GetCommandProcessor() const;
/**
Gets a pointer to the associated document manager.
*/
wxDocManager* GetDocumentManager();
wxDocManager* GetDocumentManager() const;
/**
Gets the document type name for this document. See the comment for
documentTypeName.
*/
wxString GetDocumentName();
wxString GetDocumentName() const;
/**
Gets a pointer to the template that created the document.
*/
wxDocTemplate* GetDocumentTemplate();
wxDocTemplate* GetDocumentTemplate() const;
/**
Intended to return a suitable window for using as a parent for document-related
dialog boxes. By default, uses the frame associated with the first view.
*/
wxWindow* GetDocumentWindow();
wxWindow* GetDocumentWindow() const;
/**
Gets the filename associated with this document, or "" if none is
associated.
*/
wxString GetFilename();
wxString GetFilename() const;
/**
A convenience function to get the first view for a document, because
in many cases a document will only have a single view.
See also: GetViews()
*/
wxView* GetFirstView();
wxView* GetFirstView() const;
/**
Gets the title for this document. The document title is used for an associated
frame (if any), and is usually constructed by the framework from
the filename.
*/
wxString GetTitle();
wxString GetTitle() const;
/**
Return the document name suitable to be shown to the user. The default
implementation uses the document title, if any, of the name part of the
document filename if it was set or, otherwise, the string @b unnamed.
*/
virtual wxString GetUserReadableName();
virtual wxString GetUserReadableName() const;
/**
Returns the list whose elements are the views on the document.
See also: GetFirstView()
*/
wxList GetViews();
wxList GetViews() const;
/**
Returns @true if the document has been modified since the last save, @false
@ -1089,7 +1089,7 @@ public:
the document).
See also Modify().
*/
virtual bool IsModified();
virtual bool IsModified() const;
//@{
/**
@ -1353,29 +1353,29 @@ public:
/**
Returns the base identifier for the range used for appending items.
*/
wxWindowID GetBaseId();
wxWindowID GetBaseId() const;
/**
Returns the number of files currently stored in the file history.
*/
size_t GetCount();
size_t GetCount() const;
/**
Returns the file at this index (zero-based).
*/
wxString GetHistoryFile(size_t index);
wxString GetHistoryFile(size_t index) const;
/**
Returns the maximum number of files that can be stored.
*/
int GetMaxFiles();
int GetMaxFiles() const;
/**
Returns the list of menus that are managed by this file history object.
@see UseMenu()
*/
const wxList GetMenus();
const wxList GetMenus() const;
/**
Loads the file history from the given config object. This function should be

4
interface/dragimag.h
View File

@ -148,7 +148,7 @@ public:
(together with
wxDragImage::DoDrawImage) to provide a virtual drawing capability.
*/
virtual wxRect GetImageRect(const wxPoint& pos);
virtual wxRect GetImageRect(const wxPoint& pos) const;
/**
Hides the image. You may wish to call this before updating the window
@ -193,5 +193,5 @@ public:
*/
bool UpdateBackingFromWindow(wxDC& windowDC, wxMemoryDC& destDC,
const wxRect& sourceRect,
const wxRect& destRect);
const wxRect& destRect) const;
};

14
interface/dynarray.h
View File

@ -271,7 +271,7 @@ public:
/**
Return the number of items in the array.
*/
size_t GetCount();
size_t GetCount() const;
//@{
/**
@ -290,8 +290,8 @@ public:
previously added to the array, but fail even if another, identical, element is
in the array.
*/
int Index(T& item, bool searchFromEnd = false);
int Index(T& item);
int Index(T& item, bool searchFromEnd = false) const;
const int Index(T& item) const;
//@}
/**
@ -304,7 +304,7 @@ public:
wxArray::AddAt for a common operation
of "insert only if not found".
*/
size_t IndexForInsert(T item);
size_t IndexForInsert(T item) const;
//@{
/**
@ -324,7 +324,7 @@ public:
/**
Returns @true if the array is empty, @false otherwise.
*/
bool IsEmpty();
bool IsEmpty() const;
/**
Returns the item at the given position in the array. If @a index is out of
@ -333,7 +333,7 @@ public:
The returned value is of type "reference to the array element type" for all of
the array classes.
*/
T Item(size_t index);
T Item(size_t index) const;
/**
Returns the last element in the array, i.e. is the same as Item(GetCount() - 1).
@ -341,7 +341,7 @@ public:
The returned value is of type "reference to the array element type" for all of
the array classes.
*/
T Last();
T Last() const;
/**
To use an array you must first define the array class. This is done with the

16
interface/dynlib.h
View File

@ -35,27 +35,27 @@ public:
@returns @true if the load address and module size were retrieved, @false
if this information is not available.
*/
bool GetAddress(void** addr, size_t len);
bool GetAddress(void** addr, size_t len) const;
/**
Returns the base name of this module, e.g. @c kernel32.dll or
@c libc-2.3.2.so.
*/
wxString GetName();
wxString GetName() const;
/**
Returns the full path of this module if available, e.g.
@c c:\windows\system32\kernel32.dll or
@c /lib/libc-2.3.2.so.
*/
wxString GetPath();
wxString GetPath() const;
/**
Returns the version of this module, e.g. @c 5.2.3790.0 or
@c 2.3.2. The returned string is empty if the version information is not
available.
*/
wxString GetVersion();
wxString GetVersion() const;
};
@ -271,7 +271,7 @@ public:
@see wxDYNLIB_FUNCTION
*/
void* GetSymbol(const wxString& name);
void* GetSymbol(const wxString& name) const;
/**
This function is available only under Windows as it is only useful when
@ -282,7 +282,7 @@ public:
automatically depending on the current build. Otherwise, this method is
identical to GetSymbol().
*/
void* GetSymbolAorW(const wxString& name);
void* GetSymbolAorW(const wxString& name) const;
/**
Returns @true if the symbol with the given @a name is present in the dynamic
@ -290,12 +290,12 @@ public:
this function doesn't log an error message if the symbol is not found.
This function is new since wxWidgets version 2.5.4
*/
bool HasSymbol(const wxString& name);
bool HasSymbol(const wxString& name) const;
/**
Returns @true if the library was successfully loaded, @false otherwise.
*/
bool IsLoaded();
bool IsLoaded() const;
/**
This static method returns an array containing the details

14
interface/encconv.h
View File

@ -46,13 +46,13 @@ public:
/**
Convert wxString and return new wxString object.
*/
bool Convert(const char* input, char* output);
bool Convert(const wchar_t* input, wchar_t* output);
bool Convert(const char* input, wchar_t* output);
bool Convert(const wchar_t* input, char* output);
bool Convert(char* str);
bool Convert(wchar_t* str);
wxString Convert(const wxString& input);
bool Convert(const char* input, char* output) const;
const bool Convert(const wchar_t* input, wchar_t* output) const;
const bool Convert(const char* input, wchar_t* output) const;
const bool Convert(const wchar_t* input, char* output) const;
const bool Convert(char* str) const;
const bool Convert(wchar_t* str) const;
const wxString Convert(const wxString& input) const;
//@}
/**

222
interface/event.h
View File

@ -81,7 +81,7 @@ public:
Notice that GetModifiers() is easier to use
correctly than this function so you should consider using it in new code.
*/
bool AltDown();
bool AltDown() const;
/**
CMD is a pseudo key which is the same as Control for PC and Unix
@ -92,14 +92,14 @@ public:
this is the same as ControlDown() and under
Mac this is the same as MetaDown().
*/
bool CmdDown();
bool CmdDown() const;
/**
Returns @true if the control key was down at the time of the key event.
Notice that GetModifiers() is easier to use
correctly than this function so you should consider using it in new code.
*/
bool ControlDown();
bool ControlDown() const;
/**
Returns the virtual key code. ASCII events return normal ASCII values,
@ -111,7 +111,7 @@ public:
charset. You can obtain the corresponding Unicode character using
GetUnicodeKey().
*/
int GetKeyCode();
int GetKeyCode() const;
/**
Return the bitmask of modifier keys which were pressed when this event
@ -129,14 +129,14 @@ public:
with this function.
*/
int GetModifiers();
int GetModifiers() const;
//@{
/**
Obtains the position (in client coordinates) at which the key was pressed.
*/
wxPoint GetPosition();
void GetPosition(long* x, long* y);
wxPoint GetPosition() const;
const void GetPosition(long* x, long* y) const;
//@}
/**
@ -145,7 +145,7 @@ public:
@b NB: Currently the raw key codes are not supported by all ports, use
@c #ifdef wxHAS_RAW_KEY_CODES to determine if this feature is available.
*/
wxUint32 GetRawKeyCode();
wxUint32 GetRawKeyCode() const;
/**
Returns the low level key flags for this event. The flags are
@ -153,24 +153,24 @@ public:
@b NB: Currently the raw key flags are not supported by all ports, use
@c #ifdef wxHAS_RAW_KEY_CODES to determine if this feature is available.
*/
wxUint32 GetRawKeyFlags();
wxUint32 GetRawKeyFlags() const;
/**
Returns the Unicode character corresponding to this key event.
This function is only available in Unicode build, i.e. when
@c wxUSE_UNICODE is 1.
*/
wxChar GetUnicodeKey();
wxChar GetUnicodeKey() const;
/**
Returns the X position (in client coordinates) of the event.
*/
long GetX();
long GetX() const;
/**
Returns the Y (in client coordinates) position of the event.
*/
long GetY();
long GetY() const;
/**
Returns @true if either CTRL or ALT keys was down
@ -180,21 +180,21 @@ public:
META under X but the key presses even while NUMLOCK is on should
be still processed normally).
*/
bool HasModifiers();
bool HasModifiers() const;
/**
Returns @true if the Meta key was down at the time of the key event.
Notice that GetModifiers() is easier to use
correctly than this function so you should consider using it in new code.
*/
bool MetaDown();
bool MetaDown() const;
/**
Returns @true if the shift key was down at the time of the key event.
Notice that GetModifiers() is easier to use
correctly than this function so you should consider using it in new code.
*/
bool ShiftDown();
bool ShiftDown() const;
/**
bool m_altDown
@ -282,7 +282,7 @@ public:
Can be wxJOY_BUTTONn where n is 1, 2, 3 or 4; or wxJOY_BUTTON_ANY to
indicate any button down event.
*/
bool ButtonDown(int button = wxJOY_BUTTON_ANY);
bool ButtonDown(int button = wxJOY_BUTTON_ANY) const;
/**
Returns @true if the specified button (or any button) was in a down state.
@ -291,7 +291,7 @@ public:
Can be wxJOY_BUTTONn where n is 1, 2, 3 or 4; or wxJOY_BUTTON_ANY to
indicate any button down event.
*/
bool ButtonIsDown(int button = wxJOY_BUTTON_ANY);
bool ButtonIsDown(int button = wxJOY_BUTTON_ANY) const;
/**
Returns @true if the event was an up event from the specified button (or any
@ -301,53 +301,53 @@ public:
Can be wxJOY_BUTTONn where n is 1, 2, 3 or 4; or wxJOY_BUTTON_ANY to
indicate any button down event.
*/
bool ButtonUp(int button = wxJOY_BUTTON_ANY);
bool ButtonUp(int button = wxJOY_BUTTON_ANY) const;
/**
Returns the identifier of the button changing state. This is a wxJOY_BUTTONn
identifier, where
n is one of 1, 2, 3, 4.
*/
int GetButtonChange();
int GetButtonChange() const;
/**
Returns the down state of the buttons. This is a bitlist of wxJOY_BUTTONn
identifiers, where
n is one of 1, 2, 3, 4.
*/
int GetButtonState();
int GetButtonState() const;
/**
Returns the identifier of the joystick generating the event - one of
wxJOYSTICK1 and wxJOYSTICK2.
*/
int GetJoystick();
int GetJoystick() const;
/**
Returns the x, y position of the joystick event.
*/
wxPoint GetPosition();
wxPoint GetPosition() const;
/**
Returns the z position of the joystick event.
*/
int GetZPosition();
int GetZPosition() const;
/**
Returns @true if this was a button up or down event (@e not 'is any button
down?').
*/
bool IsButton();
bool IsButton() const;
/**
Returns @true if this was an x, y move event.
*/
bool IsMove();
bool IsMove() const;
/**
Returns @true if this was a z move event.
*/
bool IsZMove();
bool IsZMove() const;
};
@ -376,14 +376,14 @@ public:
Returns wxHORIZONTAL or wxVERTICAL, depending on the orientation of the
scrollbar.
*/
int GetOrientation();
int GetOrientation() const;
/**
Returns the position of the scrollbar for the thumb track and release events.
Note that this field can't be used for the other events, you need to query
the window itself for the current position in that case.
*/
int GetPosition();
int GetPosition() const;
};
@ -542,12 +542,12 @@ public:
/**
Returns @true if the UI element should be checked.
*/
bool GetChecked();
bool GetChecked() const;
/**
Returns @true if the UI element should be enabled.
*/
bool GetEnabled();
bool GetEnabled() const;
/**
Static function returning a value specifying how wxWidgets
@ -562,35 +562,35 @@ public:
Returns @true if the application has called Check(). For wxWidgets internal use
only.
*/
bool GetSetChecked();
bool GetSetChecked() const;
/**
Returns @true if the application has called Enable(). For wxWidgets internal use
only.
*/
bool GetSetEnabled();
bool GetSetEnabled() const;
/**
Returns @true if the application has called Show(). For wxWidgets internal use
only.
*/
bool GetSetShown();
bool GetSetShown() const;
/**
Returns @true if the application has called SetText(). For wxWidgets internal
use only.
*/
bool GetSetText();
bool GetSetText() const;
/**
Returns @true if the UI element should be shown.
*/
bool GetShown();
bool GetShown() const;
/**
Returns the text that should be set for the UI element.
*/
wxString GetText();
wxString GetText() const;
/**
Returns the current interval between updates in milliseconds.
@ -766,46 +766,46 @@ public:
/**
Returns @true if the event was a first extra button double click.
*/
bool Aux1DClick();
bool Aux1DClick() const;
/**
Returns @true if the first extra button mouse button changed to down.
*/
bool Aux1Down();
bool Aux1Down() const;
/**
Returns @true if the first extra button mouse button is currently down,
independent
of the current event type.
*/
bool Aux1IsDown();
bool Aux1IsDown() const;
/**
Returns @true if the first extra button mouse button changed to up.
*/
bool Aux1Up();
bool Aux1Up() const;
/**
Returns @true if the event was a second extra button double click.
*/
bool Aux2DClick();
bool Aux2DClick() const;
/**
Returns @true if the second extra button mouse button changed to down.
*/
bool Aux2Down();
bool Aux2Down() const;
/**
Returns @true if the second extra button mouse button is currently down,
independent
of the current event type.
*/
bool Aux2IsDown();
bool Aux2IsDown() const;
/**
Returns @true if the second extra button mouse button changed to up.
*/
bool Aux2Up();
bool Aux2Up() const;
/**
Returns @true if the identified mouse button is changing state. Valid
@ -867,7 +867,7 @@ public:
@see wxKeyEvent::CmdDown
*/
bool CmdDown();
bool CmdDown() const;
/**
Returns @true if the control key was down at the time of the event.
@ -894,7 +894,7 @@ public:
double click events, @c wxMOUSE_BTN_MIDDLE and @c wxMOUSE_BTN_RIGHT
for the same events for the middle and the right buttons respectively.
*/
int GetButton();
int GetButton() const;
/**
Returns the number of mouse clicks for this event: 1 for a simple click, 2
@ -904,20 +904,20 @@ public:
they generate different kinds of events however).
This function is new since wxWidgets version 2.9.0
*/
int GetClickCount();
int GetClickCount() const;
/**
Returns the configured number of lines (or whatever) to be scrolled per
wheel action. Defaults to three.
*/
int GetLinesPerAction();
int GetLinesPerAction() const;
/**
Returns the logical mouse position in pixels (i.e. translated according to the
translation set for the DC, which usually indicates that the window has been
scrolled).
*/
wxPoint GetLogicalPosition(const wxDC& dc);
wxPoint GetLogicalPosition(const wxDC& dc) const;
//@{
/**
@ -927,9 +927,9 @@ public:
keyboard combination (e.g. under Windows when the "menu'' key is pressed), the
returned position is @c wxDefaultPosition.
*/
wxPoint GetPosition();
void GetPosition(wxCoord* x, wxCoord* y);
void GetPosition(long* x, long* y);
wxPoint GetPosition() const;
const void GetPosition(wxCoord* x, wxCoord* y) const;
const void GetPosition(long* x, long* y) const;
//@}
/**
@ -937,7 +937,7 @@ public:
taken, and one such action (for example, scrolling one increment)
should occur for each delta.
*/
int GetWheelDelta();
int GetWheelDelta() const;
/**
Get wheel rotation, positive or negative indicates direction of
@ -947,12 +947,12 @@ public:
should be able to either do partial line scrolling or wait until several
events accumulate before scrolling.
*/
int GetWheelRotation();
int GetWheelRotation() const;
/**
Returns X coordinate of the physical mouse event position.
*/
long GetX();
long GetX() const;
/**
Returns Y coordinate of the physical mouse event position.
@ -964,29 +964,29 @@ public:
down event -
that may be tested using @e ButtonDown).
*/
bool IsButton();
bool IsButton() const;
/**
Returns @true if the system has been setup to do page scrolling with
the mouse wheel instead of line scrolling.
*/
bool IsPageScroll();
bool IsPageScroll() const;
/**
Returns @true if the mouse was leaving the window.
See also Entering().
*/
bool Leaving();
bool Leaving() const;
/**
Returns @true if the event was a left double click.
*/
bool LeftDClick();
bool LeftDClick() const;
/**
Returns @true if the left mouse button changed to down.
*/
bool LeftDown();
bool LeftDown() const;
/**
Returns @true if the left mouse button is currently down, independent
@ -1000,71 +1000,71 @@ public:
This event is usually used in the mouse event handlers which process "move
mouse" messages to determine whether the user is (still) dragging the mouse.
*/
bool LeftIsDown();
bool LeftIsDown() const;
/**
Returns @true if the left mouse button changed to up.
*/
bool LeftUp();
bool LeftUp() const;
/**
Returns @true if the Meta key was down at the time of the event.
*/
bool MetaDown();
bool MetaDown() const;
/**
Returns @true if the event was a middle double click.
*/
bool MiddleDClick();
bool MiddleDClick() const;
/**
Returns @true if the middle mouse button changed to down.
*/
bool MiddleDown();
bool MiddleDown() const;
/**
Returns @true if the middle mouse button is currently down, independent
of the current event type.
*/
bool MiddleIsDown();
bool MiddleIsDown() const;
/**
Returns @true if the middle mouse button changed to up.
*/
bool MiddleUp();
bool MiddleUp() const;
/**
Returns @true if this was a motion event and no mouse buttons were pressed.
If any mouse button is held pressed, then this method returns @false and
Dragging() returns @true.
*/
bool Moving();
bool Moving() const;
/**
Returns @true if the event was a right double click.
*/
bool RightDClick();
bool RightDClick() const;
/**
Returns @true if the right mouse button changed to down.
*/
bool RightDown();
bool RightDown() const;
/**
Returns @true if the right mouse button is currently down, independent
of the current event type.
*/
bool RightIsDown();
bool RightIsDown() const;
/**
Returns @true if the right mouse button changed to up.
*/
bool RightUp();
bool RightUp() const;
/**
Returns @true if the shift key was down at the time of the event.
*/
bool ShiftDown();
bool ShiftDown() const;
/**
bool m_altDown
@ -1171,18 +1171,18 @@ public:
/**
Returns an array of filenames.
*/
wxString* GetFiles();
wxString* GetFiles() const;
/**
Returns the number of files dropped.
*/
int GetNumberOfFiles();
int GetNumberOfFiles() const;
/**
Returns the position at which the files were dropped.
Returns an array of filenames.
*/
wxPoint GetPosition();
wxPoint GetPosition() const;
/**
wxString* m_files
@ -1226,7 +1226,7 @@ public:
/**
Deprecated, use IsChecked() instead.
*/
bool Checked();
bool Checked() const;
/**
Returns client data pointer for a listbox or choice selection event
@ -1278,7 +1278,7 @@ public:
Notice that this method can not be used with
wxCheckListBox currently.
*/
bool IsChecked();
bool IsChecked() const;
/**
For a listbox or similar event, returns @true if it is a selection, @false if it
@ -1342,7 +1342,7 @@ public:
/**
Returns @true if the application or window is being activated, @false otherwise.
*/
bool GetActive();
bool GetActive() const;
};
@ -1390,7 +1390,7 @@ public:
If the event originated from a keyboard event, the value returned from this
function will be wxDefaultPosition.
*/
wxPoint GetPosition();
wxPoint GetPosition() const;
/**
Sets the position at which the menu should be shown.
@ -1435,7 +1435,7 @@ public:
/**
Returns the device context associated with the erase event to draw on.
*/
wxDC* GetDC();
wxDC* GetDC() const;
};
@ -1581,7 +1581,7 @@ public:
Returns @true if the change is allowed (Veto()
hasn't been called) or @false otherwise (if it was).
*/
bool IsAllowed();
bool IsAllowed() const;
/**
Prevents the change announced by this event from happening.
@ -1656,13 +1656,13 @@ public:
@see SetOrigin()
*/
wxHelpEvent::Origin GetOrigin();
wxHelpEvent::Origin GetOrigin() const;
/**
Returns the left-click position of the mouse, in screen coordinates. This allows
the application to position the help appropriately.
*/
const wxPoint GetPosition();
const wxPoint GetPosition() const;
/**
Set the help event origin, only used internally by wxWidgets normally.
@ -1710,12 +1710,12 @@ public:
Returns wxHORIZONTAL or wxVERTICAL, depending on the orientation of the
scrollbar.
*/
int GetOrientation();
int GetOrientation() const;
/**
Returns the position of the scrollbar.
*/
int GetPosition();
int GetPosition() const;
};
@ -1783,7 +1783,7 @@ public:
@see RequestMore()
*/
bool MoreRequested();
bool MoreRequested() const;
/**
Tells wxWidgets that more processing is required. This function can be called
@ -1900,25 +1900,25 @@ public:
/**
Returns the child that has the focus, or @NULL.
*/
wxWindow* GetCurrentFocus();
wxWindow* GetCurrentFocus() const;
/**
Returns @true if the navigation was in the forward direction.
*/
bool GetDirection();
bool GetDirection() const;
/**
Returns @true if the navigation event was from a tab key. This is required
for proper navigation over radio buttons.
*/
bool IsFromTab();
bool IsFromTab() const;
/**
Returns @true if the navigation event represents a window change (for
example, from Ctrl-Page Down
in a notebook).
*/
bool IsWindowChange();
bool IsWindowChange() const;
/**
Sets the current focus window member.
@ -1980,7 +1980,7 @@ public:
Returns the window that gained the capture, or @NULL if it was a non-wxWidgets
window.
*/
wxWindow* GetCapturedWindow();
wxWindow* GetCapturedWindow() const;
};
@ -2035,7 +2035,7 @@ public:
shutting down. This method can only be called for end session and query end
session events, it doesn't make sense for close window event.
*/
bool GetLoggingOff();
bool GetLoggingOff() const;
/**
Sets the 'can veto' flag.
@ -2045,12 +2045,12 @@ public:
/**
Sets the 'force' flag.
*/
void SetForce(bool force);
void SetForce(bool force) const;
/**
Sets the 'logging off' flag.
*/
void SetLoggingOff(bool loggingOff);
void SetLoggingOff(bool loggingOff) const;
/**
Call this from your event handler to veto a system shutdown or to signal
@ -2093,20 +2093,20 @@ public:
used with the @c OPEN and @c CLOSE events and even for them the
returned pointer may be @NULL in some ports.
*/
wxMenu* GetMenu();
wxMenu* GetMenu() const;
/**
Returns the menu identifier associated with the event. This method should be
only used with the @c HIGHLIGHT events.
*/
int GetMenuId();
int GetMenuId() const;
/**
Returns @true if the menu which is being opened or closed is a popup menu,
@false if it is a normal one.
This method should only be used with the @c OPEN and @c CLOSE events.
*/
bool IsPopup();
bool IsPopup() const;
};
@ -2314,7 +2314,7 @@ public:
@see SetClientObject(), wxClientData
*/
wxClientData* GetClientObject();
wxClientData* GetClientObject() const;
/**
Returns @true if the event handler is enabled, @false otherwise.
@ -2483,7 +2483,7 @@ public:
Returns @true if the frame has been iconized, @false if it has been
restored.
*/
bool Iconized();
bool Iconized() const;
};
@ -2510,7 +2510,7 @@ public:
/**
Returns the position of the window generating the move change event.
*/
wxPoint GetPosition();
wxPoint GetPosition() const;
};
@ -2553,7 +2553,7 @@ public:
implementing the Clone function is to implement a copy constructor for
a new event (call it MyEvent) and then define the Clone function like this:
*/
virtual wxEvent* Clone();
virtual wxEvent* Clone() const;
/**
Returns the object (usually a window) associated with the
@ -2570,12 +2570,12 @@ public:
/**
Returns the identifier associated with this event, such as a button command id.
*/
int GetId();
int GetId() const;
/**
Returns @true if the event handler should be skipped, @false otherwise.
*/
bool GetSkipped();
bool GetSkipped() const;
/**
Gets the timestamp for the event. The timestamp is the time in milliseconds
@ -2590,7 +2590,7 @@ public:
wxCommandEvent else it returns @false.
Note: Exists only for optimization purposes.
*/
bool IsCommandEvent();
bool IsCommandEvent() const;
/**
Sets the propagation level to the given value (for example returned from an
@ -2622,7 +2622,7 @@ public:
Test if this event should be propagated or not, i.e. if the propagation level
is currently greater than 0.
*/
bool ShouldPropagate();
bool ShouldPropagate() const;
/**
This method can be used inside an event handler to control whether further
@ -2704,7 +2704,7 @@ public:
/**
Returns the entire size of the window generating the size change event.
*/
wxSize GetSize();
wxSize GetSize() const;
};
@ -2736,17 +2736,17 @@ public:
/**
Returns a reference to the cursor specified by this event.
*/
wxCursor GetCursor();
wxCursor GetCursor() const;
/**
Returns the X coordinate of the mouse in client coordinates.
*/
wxCoord GetX();
wxCoord GetX() const;
/**
Returns the Y coordinate of the mouse in client coordinates.
*/
wxCoord GetY();
wxCoord GetY() const;
/**
Returns @true if the cursor specified by this event is a valid cursor.
@ -2754,7 +2754,7 @@ public:
@remarks You cannot specify wxNullCursor with this event, as it is not
considered a valid cursor.
*/
bool HasCursor();
bool HasCursor() const;
/**
Sets the cursor associated with this event.

12
interface/fdrepdlg.h
View File

@ -27,24 +27,24 @@ public:
/**
Return the pointer to the dialog which generated this event.
*/
wxFindReplaceDialog* GetDialog();
wxFindReplaceDialog* GetDialog() const;
/**
Return the string to find (never empty).
*/
wxString GetFindString();
wxString GetFindString() const;
/**
Get the currently selected flags: this is the combination of @c wxFR_DOWN,
@c wxFR_WHOLEWORD and @c wxFR_MATCHCASE flags.
*/
int GetFlags();
int GetFlags() const;
/**
Return the string to replace the search string with (only for replace and
replace all events).
*/
const wxString GetReplaceString();
const wxString GetReplaceString() const;
};
@ -81,7 +81,7 @@ public:
/**
Get the combination of @c wxFindReplaceFlags values.
*/
int GetFlags();
int GetFlags() const;
/**
Get the replacement string.
@ -154,5 +154,5 @@ public:
Get the wxFindReplaceData object used by this
dialog.
*/
const wxFindReplaceData* GetData();
const wxFindReplaceData* GetData() const;
};

12
interface/ffile.h
View File

@ -81,7 +81,7 @@ public:
@see IsOpened()
*/
bool Eof();
bool Eof() const;
/**
Returns @true if an error has occurred on this file, similar to the standard
@ -101,19 +101,19 @@ public:
/**
Returns the type of the file. Possible return values are:
*/
wxFileKind GetKind();
wxFileKind GetKind() const;
/**
Returns @true if the file is opened. Most of the methods of this class may
only
be used for an opened file.
*/
bool IsOpened();
bool IsOpened() const;
/**
Returns the length of the file.
*/
wxFileOffset Length();
wxFileOffset Length() const;
/**
Opens the file, returning @true if successful.
@ -175,7 +175,7 @@ public:
/**
Returns the current position.
*/
wxFileOffset Tell();
wxFileOffset Tell() const;
/**
)
@ -188,5 +188,5 @@ public:
/**
Returns the file pointer associated with the file.
*/
FILE* fp();
FILE* fp() const;
};

18
interface/file.h
View File

@ -79,12 +79,12 @@ public:
/**
Returns @true if the file was successfully opened.
*/
bool IsOpened();
bool IsOpened() const;
/**
Returns the length of the file.
*/
wxFileOffset Length();
wxFileOffset Length() const;
/**
Open the temporary file, returns @true on success, @false if an error
@ -107,7 +107,7 @@ public:
another
error occurred.
*/
wxFileOffset Tell();
wxFileOffset Tell() const;
/**
Write to the file, return @true on success, @false on failure.
@ -220,7 +220,7 @@ public:
Read() repeatedly and tests its return condition instead
of using Eof() as this will not work for special files under Unix.
*/
bool Eof();
bool Eof() const;
/**
Returns @true if the given name specifies an existing regular file (not a
@ -239,17 +239,17 @@ public:
/**
Returns the type of the file. Possible return values are:
*/
wxFileKind GetKind();
wxFileKind GetKind() const;
/**
Returns @true if the file has been opened.
*/
bool IsOpened();
bool IsOpened() const;
/**
Returns the length of the file.
*/
wxFileOffset Length();
wxFileOffset Length() const;
/**
Opens the file, returning @true if successful.
@ -304,7 +304,7 @@ public:
another
error occurred.
*/
wxFileOffset Tell();
wxFileOffset Tell() const;
/**
Writes the contents of the string to the file, returns @true on success.
@ -319,5 +319,5 @@ public:
/**
Returns the file descriptor associated with the file.
*/
int fd();
int fd() const;
};

20
interface/filectrl.h
View File

@ -93,14 +93,14 @@ public:
Returns the current directory of the file control (i.e. the directory shown by
it).
*/
wxString GetDirectory();
wxString GetDirectory() const;
/**
Returns the currently selected filename.
For the controls having the @c wxFC_MULTIPLE style, use GetFilenames()
instead
*/
wxString GetFilename();
wxString GetFilename() const;
/**
Fills the array @a filenames with the filenames only of selected items. This
@ -110,19 +110,19 @@ public:
@remarks filenames is emptied first.
*/
void GetFilenames(wxArrayString& filenames);
void GetFilenames(wxArrayString& filenames) const;
/**
Returns the zero-based index of the currently selected filter.
*/
int GetFilterIndex();
int GetFilterIndex() const;
/**
Returns the full path (directory and filename) of the currently selected file.
For the controls having the @c wxFC_MULTIPLE style, use GetPaths()
instead
*/
wxString GetPath();
wxString GetPath() const;
/**
Fills the array @a paths with the full paths of the files chosen. This
@ -131,12 +131,12 @@ public:
@remarks paths is emptied first.
*/
void GetPaths(wxArrayString& paths);
void GetPaths(wxArrayString& paths) const;
/**
Returns the current wildcard.
*/
wxString GetWildcard();
wxString GetWildcard() const;
/**
Sets(changes) the current directory displayed in the control.
@ -193,19 +193,19 @@ public:
In case of a @b EVT_FILECTRL_FOLDERCHANGED, this method returns the new
directory.
*/
wxString GetDirectory();
wxString GetDirectory() const;
/**
Returns the file selected(assuming it is only one file).
*/
wxString GetFile();
wxString GetFile() const;
/**
Returns the files selected.
In case of a @b EVT_FILECTRL_SELECTIONCHANGED, this method returns the
files selected after the event.
*/
wxArrayString GetFiles();
wxArrayString GetFiles() const;
/**
Sets the files changed by this event.

18
interface/filedlg.h
View File

@ -90,7 +90,7 @@ public:
/**
Returns the default directory.
*/
wxString GetDirectory();
wxString GetDirectory() const;
/**
If functions
@ -98,12 +98,12 @@ public:
and ShowModal() were called,
returns the extra window. Otherwise returns @NULL.
*/
wxWindow* GetExtraControl();
wxWindow* GetExtraControl() const;
/**
Returns the default filename.
*/
wxString GetFilename();
wxString GetFilename() const;
/**
Fills the array @a filenames with the names of the files chosen. This
@ -114,7 +114,7 @@ public:
of each referenced file by appending the directory containing the shortcuts
to the filename.
*/
void GetFilenames(wxArrayString& filenames);
void GetFilenames(wxArrayString& filenames) const;
/**
Returns the index into the list of filters supplied, optionally, in the
@ -123,29 +123,29 @@ public:
dialog is first displayed.
After the dialog is shown, this is the index selected by the user.
*/
int GetFilterIndex();
int GetFilterIndex() const;
/**
Returns the message that will be displayed on the dialog.
*/
wxString GetMessage();
wxString GetMessage() const;
/**
Returns the full path (directory and filename) of the selected file.
*/
wxString GetPath();
wxString GetPath() const;
/**
Fills the array @a paths with the full paths of the files chosen. This
function should only be used with the dialogs which have @c wxFD_MULTIPLE style,
use GetPath() for the others.
*/
void GetPaths(wxArrayString& paths);
void GetPaths(wxArrayString& paths) const;
/**
Returns the file dialog wildcard.
*/
wxString GetWildcard();
wxString GetWildcard() const;
/**
Sets the default directory.

4
interface/filefn.h
View File

@ -73,7 +73,7 @@ public:
to the value returned wxPathList::FindValidPath) or an
empty string.
*/
wxString FindAbsoluteValidPath(const wxString& file);
wxString FindAbsoluteValidPath(const wxString& file) const;
/**
Searches the given file in all paths stored in this class.
@ -92,7 +92,7 @@ public:
(see wxGetCwd and wxSetWorkingDirectory)
may affect the value returned by this function!
*/
wxString FindValidPath(const wxString& file);
wxString FindValidPath(const wxString& file) const;
};

68
interface/filename.h
View File

@ -189,7 +189,7 @@ public:
Returns @true if the directory with this name exists.
*/
bool DirExists();
static bool DirExists(const wxString& dir);
const static bool DirExists(const wxString& dir);
//@}
/**
@ -319,7 +319,7 @@ public:
@see DirExists()
*/
bool FileExists();
static bool FileExists(const wxString& file);
const static bool FileExists(const wxString& file);
//@}
/**
@ -344,17 +344,17 @@ public:
/**
Returns the number of directories in the file name.
*/
size_t GetDirCount();
size_t GetDirCount() const;
/**
Returns the directories in string array form.
*/
const wxArrayString GetDirs();
const wxArrayString GetDirs() const;
/**
Returns the file name extension.
*/
wxString GetExt();
wxString GetExt() const;
/**
Returns the characters that can't be used in filenames and directory names for
@ -370,12 +370,12 @@ public:
/**
Returns the full name (including extension but excluding directories).
*/
wxString GetFullName();
wxString GetFullName() const;
/**
Returns the full path with name and extension.
*/
wxString GetFullPath(wxPathFormat format = wxPATH_NATIVE);
wxString GetFullPath(wxPathFormat format = wxPATH_NATIVE) const;
/**
Returns the home directory.
@ -398,27 +398,27 @@ public:
*/
wxString GetHumanReadableSize(const wxString& failmsg = "Not available",
int precision = 1);
static wxString GetHumanReadableSize(const wxULongLong& bytes,
const wxString& nullsize = "Not available",
int precision = 1);
const static wxString GetHumanReadableSize(const wxULongLong& bytes,
const wxString& nullsize = "Not available",
int precision = 1);
//@}
/**
Return the long form of the path (returns identity on non-Windows platforms)
*/
wxString GetLongPath();
wxString GetLongPath() const;
/**
Returns the last time the file was last modified.
*/
wxDateTime GetModificationTime();
wxDateTime GetModificationTime() const;
/**
Returns the name part of the filename (without extension).
@see GetFullName()
*/
wxString GetName();
wxString GetName() const;
/**
Returns the path part of the filename (without the name or extension). The
@ -437,7 +437,7 @@ public:
the path.
*/
wxString GetPath(int flags = wxPATH_GET_VOLUME,
wxPathFormat format = wxPATH_NATIVE);
wxPathFormat format = wxPATH_NATIVE) const;
/**
Returns the usually used path separator for this format. For all formats but
@ -472,12 +472,12 @@ public:
This is the same as calling GetPath()
@c (wxPATH_GET_VOLUME | wxPATH_GET_SEPARATOR, format).
*/
wxString GetPathWithSep(wxPathFormat format = wxPATH_NATIVE);
wxString GetPathWithSep(wxPathFormat format = wxPATH_NATIVE) const;
/**
Return the short form of the path (returns identity on non-Windows platforms).
*/
wxString GetShortPath();
wxString GetShortPath() const;
//@{
/**
@ -488,7 +488,7 @@ public:
by another process) the returned value is @c wxInvalidSize.
*/
wxULongLong GetSize();
static wxULongLong GetSize(const wxString& filename);
const static wxULongLong GetSize(const wxString& filename);
//@}
/**
@ -515,14 +515,14 @@ public:
@returns @true on success, @false if we failed to retrieve the times.
*/
bool GetTimes(wxDateTime* dtAccess, wxDateTime* dtMod,
wxDateTime* dtCreate);
wxDateTime* dtCreate) const;
/**
Returns the string containing the volume for this file name, empty if it
doesn't have one or if the file system doesn't support volumes at all (for
example, Unix).
*/
wxString GetVolume();
wxString GetVolume() const;
/**
Returns the string separating the volume from the path for this format.
@ -532,17 +532,17 @@ public:
/**
Returns @true if an extension is present.
*/
bool HasExt();
bool HasExt() const;
/**
Returns @true if a name is present.
*/
bool HasName();
bool HasName() const;
/**
Returns @true if a volume specifier is present.
*/
bool HasVolume();
bool HasVolume() const;
/**
Inserts a directory component before the zero-based position in the directory
@ -567,7 +567,7 @@ public:
DirExists() or
FileExists() for this.
*/
bool IsDir();
bool IsDir() const;
//@{
/**
@ -578,7 +578,7 @@ public:
doesn't imply that you have read permissions on the files contained.
*/
bool IsDirReadable();
static bool IsDirReadable(const wxString& dir);
const static bool IsDirReadable(const wxString& dir);
//@}
//@{
@ -589,7 +589,7 @@ public:
directory.
*/
bool IsDirWritable();
static bool IsDirWritable(const wxString& dir);
const static bool IsDirWritable(const wxString& dir);
//@}
//@{
@ -598,7 +598,7 @@ public:
permissions on it.
*/
bool IsFileExecutable();
static bool IsFileExecutable(const wxString& file);
const static bool IsFileExecutable(const wxString& file);
//@}
//@{
@ -607,7 +607,7 @@ public:
permissions on it.
*/
bool IsFileReadable();
static bool IsFileReadable(const wxString& file);
const static bool IsFileReadable(const wxString& file);
//@}
//@{
@ -616,7 +616,7 @@ public:
permissions on it.
*/
bool IsFileWritable();
static bool IsFileWritable(const wxString& file);
const static bool IsFileWritable(const wxString& file);
//@}
/**
@ -625,7 +625,7 @@ public:
Clear() may reset the object to the uninitialized,
invalid state (the former only do it on failure).
*/
bool IsOk();
bool IsOk() const;
/**
Returns @true if the char is a path separator for this format.
@ -871,7 +871,7 @@ public:
Compares the filename using the rules of this platform.
*/
bool SameAs(const wxFileName& filepath,
wxPathFormat format = wxPATH_NATIVE);
wxPathFormat format = wxPATH_NATIVE) const;
//@{
/**
@ -981,8 +981,8 @@ public:
Returns @true if the filenames are different. The string @e filenames
is interpreted as a path in the native filename format.
*/
bool operator operator!=(const wxFileName& filename);
bool operator operator!=(const wxString& filename);
bool operator operator!=(const wxFileName& filename) const;
const bool operator operator!=(const wxString& filename) const;
//@}
//@{
@ -998,7 +998,7 @@ public:
Returns @true if the filenames are equal. The string @e filenames is
interpreted as a path in the native filename format.
*/
bool operator operator==(const wxFileName& filename);
bool operator operator==(const wxString& filename);
bool operator operator==(const wxFileName& filename) const;
const bool operator operator==(const wxString& filename) const;
//@}
};

10
interface/filepicker.h
View File

@ -106,12 +106,12 @@ public:
Similar to GetPath() but returns the path of
the currently selected file as a wxFileName object.
*/
wxFileName GetFileName();
wxFileName GetFileName() const;
/**
Returns the absolute path of the currently selected file.
*/
wxString GetPath();
wxString GetPath() const;
/**
This method does the same thing as SetPath() but
@ -220,12 +220,12 @@ public:
object.
This function is equivalent to GetPath()
*/
wxFileName GetDirName();
wxFileName GetDirName() const;
/**
Returns the absolute path of the currently selected directory.
*/
wxString GetPath();
wxString GetPath() const;
/**
Just like SetPath() but this function takes a
@ -268,7 +268,7 @@ public:
/**
Retrieve the absolute path of the file/directory the user has just selected.
*/
wxString GetPath();
wxString GetPath() const;
/**
Set the absolute path of the file/directory associated with the event.

18
interface/filesys.h
View File

@ -184,25 +184,25 @@ public:
for example myanim.avi#200 may refer to position in animation
or reality.wrl#MyView may refer to a predefined view in VRML.
*/
const wxString GetAnchor();
const wxString GetAnchor() const;
/**
Returns full location of the file, including path and protocol.
Examples :
*/
const wxString GetLocation();
const wxString GetLocation() const;
/**
Returns the MIME type of the content of this file. It is either
extension-based (see wxMimeTypesManager) or extracted from
HTTP protocol Content-Type header.
*/
const wxString GetMimeType();
const wxString GetMimeType() const;
/**
Returns time when this file was modified.
*/
wxDateTime GetModificationTime();
wxDateTime GetModificationTime() const;
/**
Returns pointer to the stream. You can use the returned
@ -212,7 +212,7 @@ public:
this by default. wxHtml uses local cache to work around
this and to speed up the connection).
*/
wxInputStream* GetStream();
wxInputStream* GetStream() const;
};
@ -282,14 +282,14 @@ public:
Example: GetAnchor("index.htm#chapter2") == "chapter2"
@b Note: the anchor is NOT part of the left location.
*/
wxString GetAnchor(const wxString& location);
wxString GetAnchor(const wxString& location) const;
/**
Returns the left location string extracted from @e location.
Example: GetLeftLocation("file:myzipfile.zip#zip:index.htm") ==
"file:myzipfile.zip"
*/
wxString GetLeftLocation(const wxString& location);
wxString GetLeftLocation(const wxString& location) const;
/**
Returns the MIME type based on @b extension of @e location. (While
@ -303,13 +303,13 @@ public:
Returns the protocol string extracted from @e location.
Example: GetProtocol("file:myzipfile.zip#zip:index.htm") == "zip"
*/
wxString GetProtocol(const wxString& location);
wxString GetProtocol(const wxString& location) const;
/**
Returns the right location string extracted from @e location.
Example : GetRightLocation("file:myzipfile.zip#zip:index.htm") == "index.htm"
*/
wxString GetRightLocation(const wxString& location);
wxString GetRightLocation(const wxString& location) const;
/**
Opens the file and returns wxFSFile pointer or @NULL if failed.

18
interface/font.h
View File

@ -303,7 +303,7 @@ public:
@see SetFaceName()
*/
wxString GetFaceName();
wxString GetFaceName() const;
/**
Gets the font family. See SetFamily() for a list of valid
@ -311,7 +311,7 @@ public:
@see SetFamily()
*/
wxFontFamily GetFamily();
wxFontFamily GetFamily() const;
/**
Returns the platform-dependent string completely describing this font.
@ -322,7 +322,7 @@ public:
@see SetNativeFontInfo(),GetNativeFontInfoUserDesc()
*/
wxString GetNativeFontInfoDesc();
wxString GetNativeFontInfoDesc() const;
/**
Returns a user-friendly string for this font object. Returned string is always
@ -339,7 +339,7 @@ public:
@see SetPointSize()
*/
int GetPointSize();
int GetPointSize() const;
/**
Gets the font style. See wxFont() for a list of valid
@ -347,14 +347,14 @@ public:
@see SetStyle()
*/
int GetStyle();
int GetStyle() const;
/**
Returns @true if the font is underlined, @false otherwise.
@see SetUnderlined()
*/
bool GetUnderlined();
bool GetUnderlined() const;
/**
Gets the font weight. See wxFont() for a list of valid
@ -362,18 +362,18 @@ public:
@see SetWeight()
*/
wxFontWeight GetWeight();
wxFontWeight GetWeight() const;
/**
Returns @true if the font is a fixed width (or monospaced) font,
@false if it is a proportional one or font is invalid.
*/
bool IsFixedWidth();
bool IsFixedWidth() const;
/**
Returns @true if this object is a valid font, @false otherwise.
*/
bool IsOk();
bool IsOk() const;
//@{
/**

2
interface/fontdlg.h
View File

@ -50,7 +50,7 @@ public:
dialog.
*/
const wxFontData GetFontData();
wxFontData GetFontData();
const wxFontData& GetFontData();
//@}
/**

6
interface/fontpicker.h
View File

@ -91,13 +91,13 @@ public:
/**
Returns the maximum point size value allowed for the user-chosen font.
*/
unsigned int GetMaxPointSize();
unsigned int GetMaxPointSize() const;
/**
Returns the currently selected font.
Note that this function is completely different from wxWindow::GetFont.
*/
wxFont GetSelectedFont();
wxFont GetSelectedFont() const;
/**
Sets the maximum point size value allowed for the user-chosen font.
@ -144,7 +144,7 @@ public:
/**
Retrieve the font the user has just selected.
*/
wxFont GetFont();
wxFont GetFont() const;
/**
Set the font associated with the event.

8
interface/frame.h
View File

@ -214,14 +214,14 @@ public:
Returns the origin of the frame client area (in client coordinates). It may be
different from (0, 0) if the frame has a toolbar.
*/
wxPoint GetClientAreaOrigin();
wxPoint GetClientAreaOrigin() const;
/**
Returns a pointer to the menubar currently associated with the frame (if any).
@see SetMenuBar(), wxMenuBar, wxMenu
*/
wxMenuBar* GetMenuBar();
wxMenuBar* GetMenuBar() const;
/**
Returns a pointer to the status bar currently associated with the frame (if
@ -229,7 +229,7 @@ public:
@see CreateStatusBar(), wxStatusBar
*/
wxStatusBar* GetStatusBar();
wxStatusBar* GetStatusBar() const;
/**
Returns the status bar pane used to display menu and toolbar help.
@ -243,7 +243,7 @@ public:
@see CreateToolBar(), wxToolBar, SetToolBar()
*/
wxToolBar* GetToolBar();
wxToolBar* GetToolBar() const;
/**
Virtual function called when a status bar is requested by CreateStatusBar().

10
interface/gauge.h
View File

@ -100,14 +100,14 @@ public:
@see SetBezelFace()
*/
int GetBezelFace();
int GetBezelFace() const;
/**
Returns the maximum position of the gauge.
@see SetRange()
*/
int GetRange();
int GetRange() const;
/**
Returns the 3D shadow margin width.
@ -116,20 +116,20 @@ public:
@see SetShadowWidth()
*/
int GetShadowWidth();
int GetShadowWidth() const;
/**
Returns the current position of the gauge.
@see SetValue()
*/
int GetValue();
int GetValue() const;
/**
Returns @true if the gauge is vertical (has @c wxGA_VERTICAL style) and
@false otherwise.
*/
bool IsVertical();
bool IsVertical() const;
/**
Switch the gauge to indeterminate mode (if required) and makes the gauge move

28
interface/gbsizer.h
View File

@ -31,12 +31,12 @@ public:
/**
Get the current column value.
*/
int GetCol();
int GetCol() const;
/**
Get the current row value.
*/
int GetRow();
int GetRow() const;
/**
Set a new column value.
@ -51,12 +51,12 @@ public:
/**
Is the wxGBPosition valid? (An invalid wxGBPosition is (-1,-1). )
*/
bool operator!(const wxGBPosition& p);
bool operator!(const wxGBPosition& p) const;
/**
Compare equality of two wxGBPositions.
*/
bool operator operator==(const wxGBPosition& p);
bool operator operator==(const wxGBPosition& p) const;
};
@ -160,12 +160,12 @@ public:
Get the size of the specified cell, including hgap and vgap. Only
valid after a Layout.
*/
wxSize GetCellSize(int row, int col);
wxSize GetCellSize(int row, int col) const;
/**
Get the size used for cells in the grid with no item.
*/
wxSize GetEmptyCellSize();
wxSize GetEmptyCellSize() const;
//@{
/**
@ -265,16 +265,16 @@ public:
/**
Get the grid position of the item.
*/
wxGBPosition GetPos();
void GetPos(int& row, int& col);
wxGBPosition GetPos() const;
const void GetPos(int& row, int& col) const;
//@}
//@{
/**
Get the row and column spanning of the item.
*/
wxGBSpan GetSpan();
void GetSpan(int& rowspan, int& colspan);
wxGBSpan GetSpan() const;
const void GetSpan(int& rowspan, int& colspan) const;
//@}
//@{
@ -330,12 +330,12 @@ public:
/**
Get the current colspan value.
*/
int GetColspan();
int GetColspan() const;
/**
Get the current rowspan value.
*/
int GetRowspan();
int GetRowspan() const;
/**
Set a new colspan value.
@ -350,10 +350,10 @@ public:
/**
Is the wxGBSpan valid? (An invalid wxGBSpan is (-1,-1). )
*/
bool operator!(const wxGBSpan& o);
bool operator!(const wxGBSpan& o) const;
/**
Compare equality of two wxGBSpans.
*/
bool operator operator==(const wxGBSpan& o);
bool operator operator==(const wxGBSpan& o) const;
};

70
interface/gdicmn.h
View File

@ -70,8 +70,8 @@ public:
@c wxHORIZONTAL flag, then it is only centered in this direction while
the other component of its position remains unchanged.
*/
wxRect CentreIn(const wxRect& r, int dir = wxBOTH);
wxRect CenterIn(const wxRect& r, int dir = wxBOTH);
wxRect CentreIn(const wxRect& r, int dir = wxBOTH) const;
const wxRect CenterIn(const wxRect& r, int dir = wxBOTH) const;
//@}
//@{
@ -79,9 +79,9 @@ public:
Returns @true if the given rectangle is completely inside this rectangle
(or touches its boundary) and @false otherwise.
*/
bool Contains(int x, int y);
bool Contains(const wxPoint& pt);
bool Contains(const wxRect& rect);
bool Contains(int x, int y) const;
const bool Contains(const wxPoint& pt) const;
const bool Contains(const wxRect& rect) const;
//@}
//@{
@ -93,84 +93,84 @@ public:
@see Inflate()
*/
void Deflate(wxCoord dx, wxCoord dy);
void Deflate(const wxSize& diff);
void Deflate(wxCoord diff);
wxRect Deflate(wxCoord dx, wxCoord dy);
void Deflate(wxCoord dx, wxCoord dy) const;
void Deflate(const wxSize& diff) const;
void Deflate(wxCoord diff) const;
wxRect Deflate(wxCoord dx, wxCoord dy) const;
//@}
/**
Gets the bottom point of the rectangle.
*/
int GetBottom();
int GetBottom() const;
/**
Gets the position of the bottom left corner.
*/
wxPoint GetBottomLeft();
wxPoint GetBottomLeft() const;
/**
Gets the position of the bottom right corner.
*/
wxPoint GetBottomRight();
wxPoint GetBottomRight() const;
/**
Gets the height member.
*/
int GetHeight();
int GetHeight() const;
/**
Gets the left point of the rectangle (the same as wxRect::GetX).
*/
int GetLeft();
int GetLeft() const;
/**
Gets the position.
*/
wxPoint GetPosition();
wxPoint GetPosition() const;
/**
Gets the right point of the rectangle.
*/
int GetRight();
int GetRight() const;
/**
Gets the size.
@see SetSize()
*/
wxSize GetSize();
wxSize GetSize() const;
/**
Gets the top point of the rectangle (the same as wxRect::GetY).
*/
int GetTop();
int GetTop() const;
/**
Gets the position of the top left corner of the rectangle, same as
GetPosition().
*/
wxPoint GetTopLeft();
wxPoint GetTopLeft() const;
/**
Gets the position of the top right corner.
*/
wxPoint GetTopRight();
wxPoint GetTopRight() const;
/**
Gets the width member.
*/
int GetWidth();
int GetWidth() const;
/**
Gets the x member.
*/
int GetX();
int GetX() const;
/**
Gets the y member.
*/
int GetY();
int GetY() const;
//@{
/**
@ -202,10 +202,10 @@ public:
@see Deflate()
*/
void Inflate(wxCoord dx, wxCoord dy);
void Inflate(const wxSize& diff);
void Inflate(wxCoord diff);
wxRect Inflate(wxCoord dx, wxCoord dy);
void Inflate(wxCoord dx, wxCoord dy) const;
void Inflate(const wxSize& diff) const;
void Inflate(wxCoord diff) const;
wxRect Inflate(wxCoord dx, wxCoord dy) const;
//@}
//@{
@ -215,20 +215,20 @@ public:
other one modifies this rectangle in place.
*/
wxRect Intersect(const wxRect& rect);
wxRect Intersect(const wxRect& rect);
const wxRect& Intersect(const wxRect& rect);
//@}
/**
Returns @true if this rectangle has a non-empty intersection with the
rectangle @a rect and @false otherwise.
*/
bool Intersects(const wxRect& rect);
bool Intersects(const wxRect& rect) const;
/**
Returns @true if this rectangle has a width or height less than or equal to
0 and @false otherwise.
*/
bool IsEmpty();
bool IsEmpty() const;
//@{
/**
@ -274,7 +274,7 @@ public:
other one modifies this rectangle in place.
*/
wxRect Union(const wxRect& rect);
wxRect Union(const wxRect& rect);
const wxRect& Union(const wxRect& rect);
//@}
/**
@ -470,7 +470,7 @@ public:
Finds a colour name given the colour. Returns an empty string if the colour is
not found in the database.
*/
wxString FindName(const wxColour& colour);
wxString FindName(const wxColour& colour) const;
};
@ -574,12 +574,12 @@ public:
/**
Gets the height member.
*/
int GetHeight();
int GetHeight() const;
/**
Gets the width member.
*/
int GetWidth();
int GetWidth() const;
//@{
/**
@ -610,7 +610,7 @@ public:
This method is typically used before calling
SetDefaults().
*/
bool IsFullySpecified();
bool IsFullySpecified() const;
//@{
/**

56
interface/graphics.h
View File

@ -107,33 +107,33 @@ public:
Returns @true if the point is within the path.
*/
bool Contains(const wxPoint2DDouble& c,
int fillStyle = wxODDEVEN_RULE);
bool Contains(wxDouble x, wxDouble y,
int fillStyle = wxODDEVEN_RULE);
int fillStyle = wxODDEVEN_RULE) const;
const bool Contains(wxDouble x, wxDouble y,
int fillStyle = wxODDEVEN_RULE) const;
//@}
//@{
/**
Gets the bounding box enclosing all points (possibly including control points).
*/
wxRect2DDouble GetBox();
void GetBox(wxDouble* x, wxDouble* y, wxDouble* w,
wxDouble* h);
wxRect2DDouble GetBox() const;
const void GetBox(wxDouble* x, wxDouble* y, wxDouble* w,
wxDouble* h) const;
//@}
//@{
/**
Gets the last point of the current path, (0,0) if not yet set.
*/
void GetCurrentPoint(wxDouble* x, wxDouble* y);
wxPoint2DDouble GetCurrentPoint();
void GetCurrentPoint(wxDouble* x, wxDouble* y) const;
const wxPoint2DDouble GetCurrentPoint() const;
//@}
/**
Returns the native path (CGPathRef for Core Graphics, Path pointer for GDIPlus
and a cairo_path_t pointer for cairo).
*/
void* GetNativePath();
void* GetNativePath() const;
//@{
/**
@ -153,7 +153,7 @@ public:
some deallocations necessary (eg on cairo the native path returned by
GetNativePath is newly allocated each time).
*/
void UnGetNativePath(void* p);
void UnGetNativePath(void* p) const;
};
@ -177,12 +177,12 @@ public:
Returns the renderer that was used to create this instance, or @NULL if it has
not been initialized yet
*/
wxGraphicsRenderer* GetRenderer();
wxGraphicsRenderer* GetRenderer() const;
/**
Is this object valid (@false) or still empty (@true)?
*/
bool IsNull();
bool IsNull() const;
};
@ -230,13 +230,13 @@ public:
/**
Creates a native brush from a wxBrush.
*/
wxGraphicsBrush CreateBrush(const wxBrush& brush);
wxGraphicsBrush CreateBrush(const wxBrush& brush) const;
/**
Creates a native graphics font from a wxFont and a text colour.
*/
wxGraphicsFont CreateFont(const wxFont& font,
const wxColour& col = wxBLACK);
const wxColour& col = wxBLACK) const;
/**
Creates a wxGraphicsContext from a native context. This native context must be
@ -263,7 +263,7 @@ public:
wxDouble x2,
wxDouble y2,
const wxColouramp;c1,
const wxColouramp;c2);
const wxColouramp;c2) const;
/**
Creates a native affine transformation matrix from the passed in values. The
@ -273,17 +273,17 @@ public:
wxDouble c = 0.0,
wxDouble d = 1.0,
wxDouble tx = 0.0,
wxDouble ty = 0.0);
wxDouble ty = 0.0) const;
/**
Creates a native graphics path which is initially empty.
*/
wxGraphicsPath CreatePath();
wxGraphicsPath CreatePath() const;
/**
Creates a native pen from a wxPen.
*/
wxGraphicsPen CreatePen(const wxPen& pen);
wxGraphicsPen CreatePen(const wxPen& pen) const;
/**
Creates a native brush, having a radial gradient originating at (xo,yc) with
@ -295,7 +295,7 @@ public:
wxDouble yc,
wxDouble radius,
const wxColour& oColor,
const wxColour& cColor);
const wxColour& cColor) const;
/**
Draws the bitmap. In case of a mono bitmap, this is treated as a mask and the
@ -366,7 +366,7 @@ public:
@a text to the corresponding character of @e text.
*/
void GetPartialTextExtents(const wxString& text,
wxArrayDouble& widths);
wxArrayDouble& widths) const;
/**
Gets the dimensions of the string using the currently selected font.
@ -379,12 +379,12 @@ public:
void GetTextExtent(const wxString& text, wxDouble* width,
wxDouble* height,
wxDouble* descent,
wxDouble* externalLeading);
wxDouble* externalLeading) const;
/**
Gets the current transformation matrix of this context.
*/
wxGraphicsMatrix GetTransform();
wxGraphicsMatrix GetTransform() const;
/**
Resets the clipping to original shape.
@ -623,13 +623,13 @@ public:
*/
void Get(wxDouble* a = NULL, wxDouble* b = NULL, wxDouble* c = NULL,
wxDouble* d = NULL, wxDouble* tx = NULL,
wxDouble* ty = NULL);
wxDouble* ty = NULL) const;
/**
Returns the native representation of the matrix. For CoreGraphics this is a
CFAffineMatrix pointer. For GDIPlus a Matrix Pointer and for Cairo a cairo_matrix_t pointer.
*/
void* GetNativeMatrix();
void* GetNativeMatrix() const;
/**
Inverts the matrix.
@ -639,12 +639,12 @@ public:
/**
Returns @true if the elements of the transformation matrix are equal.
*/
bool IsEqual(const wxGraphicsMatrix& t);
bool IsEqual(const wxGraphicsMatrix& t) const;
/**
Return @true if this is the identity matrix.
*/
bool IsIdentity();
bool IsIdentity() const;
/**
Rotates this matrix (radians).
@ -668,12 +668,12 @@ public:
Applies this matrix to a distance (ie. performs all transforms except
translations)
*/
void TransformDistance(wxDouble* dx, wxDouble* dy);
void TransformDistance(wxDouble* dx, wxDouble* dy) const;
/**
Applies this matrix to a point.
*/
void TransformPoint(wxDouble* x, wxDouble* y);
void TransformPoint(wxDouble* x, wxDouble* y) const;
/**
Translates this matrix.

228
interface/grid.h
View File

@ -33,12 +33,12 @@ public:
/**
Returns the precision ( see @ref constr() wxGridCellFloatRenderer ).
*/
int GetPrecision();
int GetPrecision() const;
/**
Returns the width ( see @ref constr() wxGridCellFloatRenderer ).
*/
int GetWidth();
int GetWidth() const;
/**
Parameters string format is "width[,precision]".
@ -129,7 +129,7 @@ public:
/**
get the currently used attr provider (may be @NULL)
*/
wxGridCellAttrProvider* GetAttrProvider();
wxGridCellAttrProvider* GetAttrProvider() const;
/**
@ -185,7 +185,7 @@ public:
/**
*/
wxGrid* GetView();
wxGrid* GetView() const;
/**
@ -219,9 +219,9 @@ public:
void SetColAttr(wxGridCellAttr* attr, int col);
/**
, @b const@e wxString)
, @e wxString)
*/
void SetColLabelValue();
void SetColLabelValue() const;
/**
@ -229,9 +229,9 @@ public:
void SetRowAttr(wxGridCellAttr* attr, int row);
/**
, @b const@e wxString)
, @e wxString)
*/
void SetRowLabelValue();
void SetRowLabelValue() const;
/**
@ -315,7 +315,7 @@ public:
/**
Create a new object which is the copy of this one.
*/
wxGridCellEditor* Clone();
wxGridCellEditor* Clone() const;
/**
Creates the actual edit control.
@ -638,7 +638,7 @@ public:
/**
*/
wxGridCellRenderer* Clone();
wxGridCellRenderer* Clone() const;
/**
Draw the given cell on the provided DC inside the given rectangle
@ -685,13 +685,13 @@ public:
/**
String representation of the value.
*/
wxString GetString();
wxString GetString() const;
/**
If the return value is @true, the editor uses a wxSpinCtrl to get user input,
otherwise it uses a wxTextCtrl.
*/
bool HasRange();
bool HasRange() const;
/**
Parameters string format is "min,max".
@ -810,7 +810,7 @@ public:
/**
Creates a new copy of this object.
*/
wxGridCellAttr* Clone();
wxGridCellAttr* Clone() const;
/**
@ -820,62 +820,62 @@ public:
/**
See SetAlignment() for the returned values.
*/
void GetAlignment(int* hAlign, int* vAlign);
void GetAlignment(int* hAlign, int* vAlign) const;
/**
*/
const wxColour GetBackgroundColour();
const wxColour GetBackgroundColour() const;
/**
*/
wxGridCellEditor* GetEditor(wxGrid* grid, int row, int col);
wxGridCellEditor* GetEditor(wxGrid* grid, int row, int col) const;
/**
*/
const wxFont GetFont();
const wxFont GetFont() const;
/**
*/
wxGridCellRenderer* GetRenderer(wxGrid* grid, int row, int col);
wxGridCellRenderer* GetRenderer(wxGrid* grid, int row, int col) const;
/**
*/
const wxColour GetTextColour();
const wxColour GetTextColour() const;
/**
*/
bool HasAlignment();
bool HasAlignment() const;
/**
*/
bool HasBackgroundColour();
bool HasBackgroundColour() const;
/**
*/
bool HasEditor();
bool HasEditor() const;
/**
*/
bool HasFont();
bool HasFont() const;
/**
*/
bool HasRenderer();
bool HasRenderer() const;
/**
accessors
*/
bool HasTextColour();
bool HasTextColour() const;
/**
This class is ref counted: it is created with ref count of 1, so
@ -887,7 +887,7 @@ public:
/**
*/
bool IsReadOnly();
bool IsReadOnly() const;
/**
Sets the alignment. @a hAlign can be one of @c wxALIGN_LEFT,
@ -1242,14 +1242,14 @@ public:
to the client size of the grid window.
*/
wxRect BlockToDeviceRect(const wxGridCellCoords& topLeft,
const wxGridCellCoords& bottomRight);
const wxGridCellCoords& bottomRight) const;
/**
Returns @true if columns can be moved by dragging with the mouse. Columns can be
moved
by dragging on their labels.
*/
bool CanDragColMove();
bool CanDragColMove() const;
/**
Returns @true if columns can be resized by dragging with the mouse. Columns can
@ -1259,13 +1259,13 @@ public:
resized by dragging the right edge of the column in the grid cell area
(see wxGrid::EnableDragGridSize).
*/
bool CanDragColSize();
bool CanDragColSize() const;
/**
Return @true if the dragging of grid lines to resize rows and columns is enabled
or @false otherwise.
*/
bool CanDragGridSize();
bool CanDragGridSize() const;
/**
Returns @true if rows can be resized by dragging with the mouse. Rows can be
@ -1275,19 +1275,19 @@ public:
resized by dragging the lower edge of the row in the grid cell area
(see wxGrid::EnableDragGridSize).
*/
bool CanDragRowSize();
bool CanDragRowSize() const;
/**
Returns @true if the in-place edit control for the current grid cell can be used
and
@false otherwise (e.g. if the current cell is read-only).
*/
bool CanEnableCellControl();
bool CanEnableCellControl() const;
/**
Do we have some place to store attributes in?
*/
bool CanHaveAttributes();
bool CanHaveAttributes() const;
/**
EnableDragRowSize()
@ -1324,8 +1324,8 @@ public:
logical
coordinates.
*/
wxRect CellToRect(int row, int col);
wxRect CellToRect(const wxGridCellCoords& coords);
wxRect CellToRect(int row, int col) const;
const wxRect CellToRect(const wxGridCellCoords& coords) const;
//@}
/**
@ -1521,7 +1521,7 @@ public:
without (yet) matching calls to EndBatch(). While
the grid's batch count is greater than zero the display will not be updated.
*/
int GetBatchCount();
int GetBatchCount() const;
/**
Sets the arguments to the horizontal and vertical text alignment values for the
@ -1531,12 +1531,12 @@ public:
Vertical alignment will be one of wxALIGN_TOP, wxALIGN_CENTRE or wxALIGN_BOTTOM.
*/
void GetCellAlignment(int row, int col, int* horiz, int* vert);
void GetCellAlignment(int row, int col, int* horiz, int* vert) const;
/**
Returns the background colour of the cell at the specified location.
*/
wxColour GetCellBackgroundColour(int row, int col);
wxColour GetCellBackgroundColour(int row, int col) const;
/**
Returns a pointer to the editor for the cell at the specified location.
@ -1544,12 +1544,12 @@ public:
the @ref overview_gridoverview "wxGrid overview" for more information about
cell editors and renderers.
*/
wxGridCellEditor* GetCellEditor(int row, int col);
wxGridCellEditor* GetCellEditor(int row, int col) const;
/**
Returns the font for text in the grid cell at the specified location.
*/
wxFont GetCellFont(int row, int col);
wxFont GetCellFont(int row, int col) const;
/**
Returns a pointer to the renderer for the grid cell at the specified location.
@ -1557,12 +1557,12 @@ public:
the @ref overview_gridoverview "wxGrid overview" for more information about
cell editors and renderers.
*/
wxGridCellRenderer* GetCellRenderer(int row, int col);
wxGridCellRenderer* GetCellRenderer(int row, int col) const;
/**
Returns the text colour for the grid cell at the specified location.
*/
wxColour GetCellTextColour(int row, int col);
wxColour GetCellTextColour(int row, int col) const;
//@{
/**
@ -1579,14 +1579,14 @@ public:
See wxGridTableBase::CanGetValueAs
and the @ref overview_gridoverview "wxGrid overview" for more information.
*/
wxString GetCellValue(int row, int col);
wxString GetCellValue(const wxGridCellCoords& coords);
wxString GetCellValue(int row, int col) const;
const wxString GetCellValue(const wxGridCellCoords& coords) const;
//@}
/**
Returns the column ID of the specified column position.
*/
int GetColAt(int colPos);
int GetColAt(int colPos) const;
/**
Returns the pen used for vertical grid lines. This virtual function may be
@ -1603,12 +1603,12 @@ public:
Vertical alignment will be one of wxALIGN_TOP, wxALIGN_CENTRE or wxALIGN_BOTTOM.
*/
void GetColLabelAlignment(int* horiz, int* vert);
void GetColLabelAlignment(int* horiz, int* vert) const;
/**
Returns the current height of the column labels.
*/
int GetColLabelSize();
int GetColLabelSize() const;
/**
Returns the specified column label. The default grid table class provides
@ -1618,39 +1618,39 @@ public:
wxGridTableBase::GetColLabelValue to provide
your own labels.
*/
wxString GetColLabelValue(int col);
wxString GetColLabelValue(int col) const;
/**
*/
int GetColLeft(int col);
int GetColLeft(int col) const;
/**
This returns the value of the lowest column width that can be handled
correctly. See
member SetColMinimalAcceptableWidth() for details.
*/
int GetColMinimalAcceptableWidth();
int GetColMinimalAcceptableWidth() const;
/**
Get the minimal width of the given column/row.
*/
int GetColMinimalWidth(int col);
int GetColMinimalWidth(int col) const;
/**
Returns the position of the specified column.
*/
int GetColPos(int colID);
int GetColPos(int colID) const;
/**
*/
int GetColRight(int col);
int GetColRight(int col) const;
/**
Returns the width of the specified column.
*/
int GetColSize(int col);
int GetColSize(int col) const;
/**
Sets the arguments to the current default horizontal and vertical text alignment
@ -1660,32 +1660,32 @@ public:
Vertical alignment will be one of wxALIGN_TOP, wxALIGN_CENTRE or wxALIGN_BOTTOM.
*/
void GetDefaultCellAlignment(int* horiz, int* vert);
void GetDefaultCellAlignment(int* horiz, int* vert) const;
/**
Returns the current default background colour for grid cells.
*/
wxColour GetDefaultCellBackgroundColour();
wxColour GetDefaultCellBackgroundColour() const;
/**
Returns the current default font for grid cell text.
*/
wxFont GetDefaultCellFont();
wxFont GetDefaultCellFont() const;
/**
Returns the current default colour for grid cell text.
*/
wxColour GetDefaultCellTextColour();
wxColour GetDefaultCellTextColour() const;
/**
Returns the default height for column labels.
*/
int GetDefaultColLabelSize();
int GetDefaultColLabelSize() const;
/**
Returns the current default width for grid columns.
*/
int GetDefaultColSize();
int GetDefaultColSize() const;
/**
Returns a pointer to the current default grid cell editor.
@ -1693,20 +1693,20 @@ public:
the @ref overview_gridoverview "wxGrid overview" for more information about
cell editors and renderers.
*/
wxGridCellEditor* GetDefaultEditor();
wxGridCellEditor* GetDefaultEditor() const;
//@{
/**
*/
wxGridCellEditor* GetDefaultEditorForCell(int row, int col);
wxGridCellEditor* GetDefaultEditorForCell(const wxGridCellCoords& c);
wxGridCellEditor* GetDefaultEditorForCell(int row, int col) const;
const wxGridCellEditor* GetDefaultEditorForCell(const wxGridCellCoords& c) const;
//@}
/**
*/
wxGridCellEditor* GetDefaultEditorForType(const wxString& typeName);
wxGridCellEditor* GetDefaultEditorForType(const wxString& typeName) const;
/**
Returns the pen used for grid lines. This virtual function may be overridden in
@ -1723,77 +1723,77 @@ public:
the @ref overview_gridoverview "wxGrid overview" for more information about
cell editors and renderers.
*/
wxGridCellRenderer* GetDefaultRenderer();
wxGridCellRenderer* GetDefaultRenderer() const;
/**
*/
wxGridCellRenderer* GetDefaultRendererForCell(int row, int col);
wxGridCellRenderer* GetDefaultRendererForCell(int row, int col) const;
/**
*/
wxGridCellRenderer* GetDefaultRendererForType(const wxString& typeName);
wxGridCellRenderer* GetDefaultRendererForType(const wxString& typeName) const;
/**
Returns the default width for the row labels.
*/
int GetDefaultRowLabelSize();
int GetDefaultRowLabelSize() const;
/**
Returns the current default height for grid rows.
*/
int GetDefaultRowSize();
int GetDefaultRowSize() const;
/**
Returns the current grid cell column position.
*/
int GetGridCursorCol();
int GetGridCursorCol() const;
/**
Returns the current grid cell row position.
*/
int GetGridCursorRow();
int GetGridCursorRow() const;
/**
Returns the colour used for grid lines.
@see GetDefaultGridLinePen()
*/
wxColour GetGridLineColour();
wxColour GetGridLineColour() const;
/**
Returns the colour used for the background of row and column labels.
*/
wxColour GetLabelBackgroundColour();
wxColour GetLabelBackgroundColour() const;
/**
Returns the font used for row and column labels.
*/
wxFont GetLabelFont();
wxFont GetLabelFont() const;
/**
Returns the colour used for row and column label text.
*/
wxColour GetLabelTextColour();
wxColour GetLabelTextColour() const;
/**
Returns the total number of grid columns (actually the number of columns in the
underlying grid
table).
*/
int GetNumberCols();
int GetNumberCols() const;
/**
Returns the total number of grid rows (actually the number of rows in the
underlying grid table).
*/
int GetNumberRows();
int GetNumberRows() const;
/**
*/
wxGridCellAttr* GetOrCreateCellAttr(int row, int col);
wxGridCellAttr* GetOrCreateCellAttr(int row, int col) const;
/**
Returns the pen used for horizontal grid lines. This virtual function may be
@ -1809,12 +1809,12 @@ public:
Vertical alignment will be one of wxTOP, wxCENTRE or wxBOTTOM.
*/
void GetRowLabelAlignment(int* horiz, int* vert);
void GetRowLabelAlignment(int* horiz, int* vert) const;
/**
Returns the current width of the row labels.
*/
int GetRowLabelSize();
int GetRowLabelSize() const;
/**
Returns the specified row label. The default grid table class provides numeric
@ -1823,90 +1823,90 @@ public:
wxGridTableBase::GetRowLabelValue to provide
your own labels.
*/
wxString GetRowLabelValue(int row);
wxString GetRowLabelValue(int row) const;
/**
This returns the value of the lowest row width that can be handled correctly.
See
member SetRowMinimalAcceptableHeight() for details.
*/
int GetRowMinimalAcceptableHeight();
int GetRowMinimalAcceptableHeight() const;
/**
*/
int GetRowMinimalHeight(int col);
int GetRowMinimalHeight(int col) const;
/**
Returns the height of the specified row.
*/
int GetRowSize(int row);
int GetRowSize(int row) const;
/**
Returns the number of pixels per horizontal scroll increment. The default is 15.
@see GetScrollLineY(), SetScrollLineX(), SetScrollLineY()
*/
int GetScrollLineX();
int GetScrollLineX() const;
/**
Returns the number of pixels per vertical scroll increment. The default is 15.
@see GetScrollLineX(), SetScrollLineX(), SetScrollLineY()
*/
int GetScrollLineY();
int GetScrollLineY() const;
/**
Returns an array of singly selected cells.
*/
wxGridCellCoordsArray GetSelectedCells();
wxGridCellCoordsArray GetSelectedCells() const;
/**
Returns an array of selected cols.
*/
wxArrayInt GetSelectedCols();
wxArrayInt GetSelectedCols() const;
/**
Returns an array of selected rows.
*/
wxArrayInt GetSelectedRows();
wxArrayInt GetSelectedRows() const;
/**
Access or update the selection fore/back colours
*/
wxColour GetSelectionBackground();
wxColour GetSelectionBackground() const;
/**
Returns an array of the bottom right corners of blocks of selected cells,
see GetSelectionBlockTopLeft().
*/
wxGridCellCoordsArray GetSelectionBlockBottomRight();
wxGridCellCoordsArray GetSelectionBlockBottomRight() const;
/**
Returns an array of the top left corners of blocks of selected cells,
see GetSelectionBlockBottomRight().
*/
wxGridCellCoordsArray GetSelectionBlockTopLeft();
wxGridCellCoordsArray GetSelectionBlockTopLeft() const;
/**
*/
wxColour GetSelectionForeground();
wxColour GetSelectionForeground() const;
/**
Returns the current selection mode, see SetSelectionMode().
*/
wxGrid::wxGridSelectionModes GetSelectionMode();
wxGrid::wxGridSelectionModes GetSelectionMode() const;
/**
Returns a base pointer to the current table object.
*/
wxGridTableBase* GetTable();
wxGridTableBase* GetTable() const;
/**
Returned number of whole cols visible.
*/
int GetViewWidth();
int GetViewWidth() const;
/**
EnableGridLines()
@ -1928,7 +1928,7 @@ public:
/**
Returns @true if drawing of grid lines is turned on, @false otherwise.
*/
bool GridLinesEnabled();
bool GridLinesEnabled() const;
/**
Hides the in-place cell edit control.
@ -2002,39 +2002,39 @@ public:
/**
Returns @true if the in-place edit control is currently enabled.
*/
bool IsCellEditControlEnabled();
bool IsCellEditControlEnabled() const;
/**
Returns @true if the current cell has been set to read-only
(see wxGrid::SetReadOnly).
*/
bool IsCurrentCellReadOnly();
bool IsCurrentCellReadOnly() const;
/**
Returns @false if the whole grid has been set as read-only or @true otherwise.
See EnableEditing() for more information about
controlling the editing status of grid cells.
*/
bool IsEditable();
bool IsEditable() const;
//@{
/**
Is this cell currently selected.
*/
bool IsInSelection(int row, int col);
bool IsInSelection(const wxGridCellCoords& coords);
bool IsInSelection(int row, int col) const;
const bool IsInSelection(const wxGridCellCoords& coords) const;
//@}
/**
Returns @true if the cell at the specified location can't be edited.
See also IsReadOnly().
*/
bool IsReadOnly(int row, int col);
bool IsReadOnly(int row, int col) const;
/**
Returns @true if there are currently rows, columns or blocks of cells selected.
*/
bool IsSelection();
bool IsSelection() const;
//@{
/**
@ -2042,9 +2042,9 @@ public:
partially
visible in the grid window.
*/
bool IsVisible(int row, int col, bool wholeCellVisible = true);
bool IsVisible(const wxGridCellCoords& coords,
bool wholeCellVisible = true);
bool IsVisible(int row, int col, bool wholeCellVisible = true) const;
const bool IsVisible(const wxGridCellCoords& coords,
bool wholeCellVisible = true) const;
//@}
//@{
@ -2261,7 +2261,7 @@ public:
This function returns the rectangle that encloses the selected cells
in device coords and clipped to the client size of the grid window.
*/
wxRect SelectionToDeviceRect();
wxRect SelectionToDeviceRect() const;
//@{
/**
@ -2685,26 +2685,26 @@ public:
If @true, rather than returning wxNOT_FOUND, it returns either the first or
last column depending on whether x is too far to the left or right respectively.
*/
int XToCol(int x, bool clipToMinMax = false);
int XToCol(int x, bool clipToMinMax = false) const;
/**
Returns the column whose right hand edge is close to the given logical x
position.
If no column edge is near to this position @c wxNOT_FOUND is returned.
*/
int XToEdgeOfCol(int x);
int XToEdgeOfCol(int x) const;
/**
Returns the row whose bottom edge is close to the given logical y position.
If no row edge is near to this position @c wxNOT_FOUND is returned.
*/
int YToEdgeOfRow(int y);
int YToEdgeOfRow(int y) const;
/**
Returns the grid row that corresponds to the logical y coordinate. Returns
@c wxNOT_FOUND if there is no row at the y position.
*/
int YToRow(int y);
int YToRow(int y) const;
};
@ -2737,13 +2737,13 @@ public:
static bool IsTrueValue(const wxString& value);
/**
, @b const wxString&@e valueFalse = _T(""))
, wxString&@e valueFalse = _T(""))
This method allows to customize the values returned by GetValue() method for
the cell using this editor. By default, the default values of the arguments are
used, i.e. @c "1" is returned if the cell is checked and an empty string
otherwise, using this method allows to change this.
*/
static void UseStringValues();
static void UseStringValues() const;
};

2
interface/hash.h
View File

@ -76,7 +76,7 @@ public:
/**
Returns the number of elements in the hash table.
*/
size_t GetCount();
size_t GetCount() const;
/**
Makes an integer key out of a string. An application may wish to make a key

14
interface/hashmap.h
View File

@ -35,7 +35,7 @@ public:
Please remember that hash maps do not guarantee ordering.
*/
const_iterator begin();
iterator begin();
const iterator begin();
//@}
/**
@ -47,12 +47,12 @@ public:
Counts the number of elements with the given key present in the map.
This function returns only 0 or 1.
*/
size_type count(const key_type& key);
size_type count(const key_type& key) const;
/**
Returns @true if the hash map does not contain any elements, @false otherwise.
*/
bool empty();
bool empty() const;
//@{
/**
@ -60,7 +60,7 @@ public:
Please remember that hash maps do not guarantee ordering.
*/
const_iterator end();
iterator end();
const iterator end();
//@}
//@{
@ -79,8 +79,8 @@ public:
an iterator pointing at that element, otherwise an invalid iterator
is returned (i.e. hashmap.find( non_existent_key ) == hashmap.end()).
*/
iterator find(const key_type& key);
const_iterator find(const key_type& key);
iterator find(const key_type& key) const;
const_iterator find(const key_type& key) const;
//@}
/**
@ -101,5 +101,5 @@ public:
/**
Returns the number of elements in the map.
*/
size_type size();
size_type size() const;
};

14
interface/hashset.h
View File

@ -35,7 +35,7 @@ public:
Please remember that hash sets do not guarantee ordering.
*/
const_iterator begin();
iterator begin();
const iterator begin();
//@}
/**
@ -47,12 +47,12 @@ public:
Counts the number of elements with the given key present in the set.
This function returns only 0 or 1.
*/
size_type count(const key_type& key);
size_type count(const key_type& key) const;
/**
Returns @true if the hash set does not contain any elements, @false otherwise.
*/
bool empty();
bool empty() const;
//@{
/**
@ -60,7 +60,7 @@ public:
Please remember that hash sets do not guarantee ordering.
*/
const_iterator end();
iterator end();
const iterator end();
//@}
//@{
@ -79,8 +79,8 @@ public:
an iterator pointing at that element, otherwise an invalid iterator
is returned (i.e. hashset.find( non_existent_key ) == hashset.end()).
*/
iterator find(const key_type& key);
const_iterator find(const key_type& key);
iterator find(const key_type& key) const;
const_iterator find(const key_type& key) const;
//@}
/**
@ -94,5 +94,5 @@ public:
/**
Returns the number of elements in the set.
*/
size_type size();
size_type size() const;
};

2
interface/help.h
View File

@ -162,7 +162,7 @@ public:
used
by wxCHMHelpController, wxWinHelpController and wxHtmlHelpController.
*/
virtual wxWindow* GetParentWindow();
virtual wxWindow* GetParentWindow() const;
//@{
/**

2
interface/html/helpdlg.h
View File

@ -52,7 +52,7 @@ public:
/**
Returns the help controller associated with the dialog.
*/
wxHtmlHelpController* GetController();
wxHtmlHelpController* GetController() const;
/**
Reads the user's settings for this dialog see

2
interface/html/helpfrm.h
View File

@ -52,7 +52,7 @@ public:
/**
Returns the help controller associated with the frame.
*/
wxHtmlHelpController* GetController();
wxHtmlHelpController* GetController() const;
/**
Reads the user's settings for this frame see

26
interface/html/htmlcell.h
View File

@ -178,7 +178,7 @@ public:
Returns descent value of the cell (m_Descent member).
See explanation:
*/
int GetDescent();
int GetDescent() const;
/**
Returns pointer to the first cell in the list.
@ -193,12 +193,12 @@ public:
/**
Returns height of the cell (m_Height member).
*/
int GetHeight();
int GetHeight() const;
/**
Returns unique cell identifier if there is any, empty string otherwise.
*/
virtual wxString GetId();
virtual wxString GetId() const;
/**
Returns hypertext link if associated with this cell or @NULL otherwise.
@ -210,7 +210,7 @@ public:
These coordinates are used e.g. by COLORMAP. Values are relative to the
upper left corner of THIS cell (i.e. from 0 to m_Width or m_Height)
*/
virtual wxHtmlLinkInfo* GetLink(int x = 0, int y = 0);
virtual wxHtmlLinkInfo* GetLink(int x = 0, int y = 0) const;
/**
Returns cursor to show when mouse pointer is over the cell.
@ -224,31 +224,31 @@ public:
Returns pointer to the next cell in list (see htmlcell.h if you're
interested in details).
*/
wxHtmlCell* GetNext();
wxHtmlCell* GetNext() const;
/**
Returns pointer to parent container.
*/
wxHtmlContainerCell* GetParent();
wxHtmlContainerCell* GetParent() const;
/**
Returns X position within parent (the value is relative to parent's
upper left corner). The returned value is meaningful only if
parent's Layout() was called before!
*/
int GetPosX();
int GetPosX() const;
/**
Returns Y position within parent (the value is relative to parent's
upper left corner). The returned value is meaningful only if
parent's Layout() was called before!
*/
int GetPosY();
int GetPosY() const;
/**
Returns width of the cell (m_Width member).
*/
int GetWidth();
int GetWidth() const;
/**
This method performs two actions:
@ -336,12 +336,12 @@ public:
/**
Returns container's horizontal alignment.
*/
int GetAlignHor();
int GetAlignHor() const;
/**
Returns container's vertical alignment.
*/
int GetAlignVer();
int GetAlignVer() const;
/**
Returns the background colour of the container or @c wxNullColour if no
@ -357,13 +357,13 @@ public:
value.
It is NOT always in pixels!
*/
int GetIndent(int ind);
int GetIndent(int ind) const;
/**
Returns the units of indentation for @a ind where @a ind is one
of the @b wxHTML_INDENT_* constants.
*/
int GetIndentUnits(int ind);
int GetIndentUnits(int ind) const;
/**
Inserts new cell into the container.

2
interface/html/htmlpars.h
View File

@ -150,7 +150,7 @@ public:
reference to it is parent parser it can easily request the file by
calling
*/
wxFileSystem* GetFS();
wxFileSystem* GetFS() const;
/**
Returns product of parsing. Returned value is result of parsing

22
interface/html/htmltag.h
View File

@ -33,35 +33,35 @@ public:
Example : tag contains @c FONT SIZE=+2 COLOR="#000000". Call to
tag.GetAllParams() would return @c SIZE=+2 COLOR="#000000".
*/
const wxString GetAllParams();
const wxString GetAllParams() const;
/**
Returns beginning position of the text @e between this tag and paired
ending tag.
See explanation (returned position is marked with '|'):
*/
int GetBeginPos();
int GetBeginPos() const;
/**
Returns ending position of the text @e between this tag and paired
ending tag.
See explanation (returned position is marked with '|'):
*/
int GetEndPos1();
int GetEndPos1() const;
/**
Returns ending position 2 of the text @e between this tag and paired
ending tag.
See explanation (returned position is marked with '|'):
*/
int GetEndPos2();
int GetEndPos2() const;
/**
Returns tag's name. The name is always in uppercase and it doesn't contain
'' or '/' characters. (So the name of @c FONT SIZE=+2 tag is "FONT"
and name of @c /table is "TABLE")
*/
wxString GetName();
wxString GetName() const;
/**
Returns the value of the parameter. You should check whether the
@ -72,7 +72,7 @@ public:
@param with_quotes
@true if you want to get quotes as well. See example.
*/
wxString GetParam(const wxString& par, bool with_quotes = false);
wxString GetParam(const wxString& par, bool with_quotes = false) const;
/**
Interprets tag parameter @a par as colour specification and saves its value
@ -80,7 +80,7 @@ public:
Returns @true on success and @false if @a par is not colour specification or
if the tag has no such parameter.
*/
bool GetParamAsColour(const wxString& par, wxColour* clr);
bool GetParamAsColour(const wxString& par, wxColour* clr) const;
/**
Interprets tag parameter @a par as an integer and saves its value
@ -88,7 +88,7 @@ public:
Returns @true on success and @false if @a par is not an integer or
if the tag has no such parameter.
*/
bool GetParamAsInt(const wxString& par, int* value);
bool GetParamAsInt(const wxString& par, int* value) const;
/**
Returns @true if this tag is paired with ending tag, @false otherwise.
@ -98,7 +98,7 @@ public:
doesn't have ending tag while the second P has. The third P tag (which
is ending itself) of course doesn't have ending tag.
*/
bool HasEnding();
bool HasEnding() const;
/**
Returns @true if the tag has a parameter of the given name.
@ -108,7 +108,7 @@ public:
@param par
the parameter you're looking for.
*/
bool HasParam(const wxString& par);
bool HasParam(const wxString& par) const;
/**
This method scans the given parameter. Usage is exactly the same as sscanf's
@ -125,5 +125,5 @@ public:
pointer to a variable to store the value in
*/
wxString ScanParam(const wxString& par, const wxChar* format,
void* value);
void* value) const;
};

12
interface/html/htmlwin.h
View File

@ -82,7 +82,7 @@ public:
See also: @ref overview_cells "Cells Overview",
@ref overview_printing
*/
wxHtmlContainerCell* GetInternalRepresentation();
wxHtmlContainerCell* GetInternalRepresentation() const;
/**
Returns anchor within currently opened page
@ -108,7 +108,7 @@ public:
/**
Returns the related frame.
*/
wxFrame* GetRelatedFrame();
wxFrame* GetRelatedFrame() const;
/**
Moves back to the previous page. (each page displayed using
@ -416,7 +416,7 @@ public:
Returns the wxHtmlLinkInfo which contains info about the cell clicked and the
hyperlink it contains.
*/
const wxHtmlLinkInfo GetLinkInfo();
const wxHtmlLinkInfo GetLinkInfo() const;
};
@ -442,19 +442,19 @@ public:
/**
Returns the wxHtmlCellEvent associated with the event.
*/
wxHtmlCell* GetCell();
wxHtmlCell* GetCell() const;
/**
Returns @true if @ref setlinkclicked() SetLinkClicked(@true) has previously
been called;
@false otherwise.
*/
bool GetLinkClicked();
bool GetLinkClicked() const;
/**
Returns the wxPoint associated with the event.
*/
wxPoint GetPoint();
wxPoint GetPoint() const;
/**
Call this function with @c linkclicked set to @true if the cell which has

2
interface/html/htmprint.h
View File

@ -128,7 +128,7 @@ public:
/**
Gets the parent window for dialogs.
*/
wxWindow* GetParentWindow();
wxWindow* GetParentWindow() const;
/**
Returns pointer to wxPrintData instance used by this class. You can

32
interface/html/winpars.h
View File

@ -115,12 +115,12 @@ public:
/**
Returns actual text colour.
*/
const wxColour GetActualColor();
const wxColour GetActualColor() const;
/**
Returns default horizontal alignment.
*/
int GetAlign();
int GetAlign() const;
/**
Returns (average) char height in standard font. It is used as DC-independent
@ -128,7 +128,7 @@ public:
@b Note: This function doesn't return the @e actual height. If you want to
know the height of the current font, call @c GetDC - GetCharHeight().
*/
int GetCharHeight();
int GetCharHeight() const;
/**
Returns average char width in standard font. It is used as DC-independent
@ -136,13 +136,13 @@ public:
@b Note: This function doesn't return the @e actual width. If you want to
know the height of the current font, call @c GetDC - GetCharWidth()
*/
int GetCharWidth();
int GetCharWidth() const;
/**
Returns pointer to the currently opened container (see Overview).
Common use:
*/
wxHtmlContainerCell* GetContainer();
wxHtmlContainerCell* GetContainer() const;
/**
Returns pointer to the DC used during parsing.
@ -154,42 +154,42 @@ public:
to do conversion between @ref getinputencoding() "input encoding"
and @ref getoutputencoding() "output encoding".
*/
wxEncodingConverter* GetEncodingConverter();
wxEncodingConverter* GetEncodingConverter() const;
/**
Returns @true if actual font is bold, @false otherwise.
*/
int GetFontBold();
int GetFontBold() const;
/**
Returns actual font face name.
*/
wxString GetFontFace();
wxString GetFontFace() const;
/**
Returns @true if actual font is fixed face, @false otherwise.
*/
int GetFontFixed();
int GetFontFixed() const;
/**
Returns @true if actual font is italic, @false otherwise.
*/
int GetFontItalic();
int GetFontItalic() const;
/**
Returns actual font size (HTML size varies from -2 to +4)
*/
int GetFontSize();
int GetFontSize() const;
/**
Returns @true if actual font is underlined, @false otherwise.
*/
int GetFontUnderlined();
int GetFontUnderlined() const;
/**
Returns input encoding.
*/
wxFontEncoding GetInputEncoding();
wxFontEncoding GetInputEncoding() const;
/**
Returns actual hypertext link. (This value has a non-empty
@ -197,18 +197,18 @@ public:
if the parser is between @c A and @c /A tags,
wxEmptyString otherwise.)
*/
const wxHtmlLinkInfo GetLink();
const wxHtmlLinkInfo GetLink() const;
/**
Returns the colour of hypertext link text.
*/
const wxColour GetLinkColor();
const wxColour GetLinkColor() const;
/**
Returns output encoding, i.e. closest match to document's input encoding
that is supported by operating system.
*/
wxFontEncoding GetOutputEncoding();
wxFontEncoding GetOutputEncoding() const;
/**
Returns associated window (wxHtmlWindow). This may be @NULL! (You should always

12
interface/htmllbox.h
View File

@ -66,8 +66,8 @@ public:
wxFileSystem::ChangePathTo if you use
relative paths for the images or other resources embedded in your HTML.
*/
wxFileSystem GetFileSystem();
const wxFileSystem GetFileSystem();
wxFileSystem GetFileSystem() const;
const wxFileSystem GetFileSystem() const;
//@}
/**
@ -81,7 +81,7 @@ public:
@see GetSelectedTextColour()
*/
wxColour GetSelectedTextBgColour(const wxColour& colBg);
wxColour GetSelectedTextBgColour(const wxColour& colBg) const;
/**
This virtual function may be overridden to customize the appearance of the
@ -93,7 +93,7 @@ public:
@see GetSelectedTextBgColour(),
wxVListBox::SetSelectionBackground, wxSystemSettings::GetColour
*/
wxColour GetSelectedTextColour(const wxColour& colFg);
wxColour GetSelectedTextColour(const wxColour& colFg) const;
/**
This method must be implemented in the derived class and should return
@ -107,13 +107,13 @@ public:
that the returned HTML fragment will render with the same height or else you'll
see some artifacts when the user selects an item.
*/
wxString OnGetItem(size_t n);
wxString OnGetItem(size_t n) const;
/**
This function may be overridden to decorate HTML returned by
OnGetItem().
*/
wxString OnGetItemMarkup(size_t n);
wxString OnGetItemMarkup(size_t n) const;
/**
Called when the user clicks on hypertext link. Does nothing by default.

12
interface/hyperlink.h
View File

@ -28,7 +28,7 @@ public:
/**
Returns the URL of the hyperlink where the user has just clicked.
*/
wxString GetURL();
wxString GetURL() const;
/**
Sets the URL associated with the event.
@ -114,25 +114,25 @@ public:
Returns the colour used to print the label of the hyperlink when the mouse is
over the control.
*/
wxColour GetHoverColour();
wxColour GetHoverColour() const;
/**
Returns the colour used to print the label when the link has never been clicked
before
(i.e. the link has not been @e visited) and the mouse is not over the control.
*/
wxColour GetNormalColour();
wxColour GetNormalColour() const;
/**
Returns the URL associated with the hyperlink.
*/
wxString GetURL();
wxString GetURL() const;
/**
Returns @true if the hyperlink has already been clicked by the user at least
one time.
*/
bool GetVisited();
bool GetVisited() const;
/**
Returns the colour used to print the label when the mouse is not over the
@ -140,7 +140,7 @@ public:
and the link has already been clicked before (i.e. the link has been @e
visited).
*/
wxColour GetVisitedColour();
wxColour GetVisitedColour() const;
/**
Sets the colour used to print the label of the hyperlink when the mouse is over

8
interface/icon.h
View File

@ -184,24 +184,24 @@ public:
Gets the colour depth of the icon. A value of 1 indicates a
monochrome icon.
*/
int GetDepth();
int GetDepth() const;
/**
Gets the height of the icon in pixels.
*/
int GetHeight();
int GetHeight() const;
/**
Gets the width of the icon in pixels.
@see GetHeight()
*/
int GetWidth();
int GetWidth() const;
/**
Returns @true if icon data is present.
*/
bool IsOk();
bool IsOk() const;
/**
Loads an icon from a file or resource.

8
interface/iconbndl.h
View File

@ -52,22 +52,22 @@ public:
/**
Same as GetIcon( wxSize( size, size ) ).
*/
wxIcon GetIcon(const wxSize& size);
wxIcon GetIcon(wxCoord size = -1);
wxIcon GetIcon(const wxSize& size) const;
const wxIcon GetIcon(wxCoord size = -1) const;
//@}
/**
Returns the icon with exactly the given size or @c wxNullIcon if this
size is not available.
*/
wxIcon GetIconOfExactSize(const wxSize& size);
wxIcon GetIconOfExactSize(const wxSize& size) const;
/**
Returns @true if the bundle doesn't contain any icons, @false otherwise (in
which case a call to GetIcon() with default
parameter should return a valid icon).
*/
bool IsEmpty();
bool IsEmpty() const;
/**
Assignment operator, using @ref overview_trefcount "reference counting".

2
interface/iconloc.h
View File

@ -35,5 +35,5 @@ public:
Returns @true if the object is valid, i.e. was properly initialized, and
@false otherwise.
*/
bool IsOk();
bool IsOk() const;
};

81
interface/image.h
View File

@ -42,7 +42,7 @@ public:
/**
Gets the file extension associated with this handler.
*/
const wxString GetExtension();
const wxString GetExtension() const;
/**
If the image file contains more than one image and the image handler is capable
@ -61,17 +61,17 @@ public:
/**
Gets the MIME type associated with this handler.
*/
const wxString GetMimeType();
const wxString GetMimeType() const;
/**
Gets the name of this handler.
*/
const wxString GetName();
const wxString GetName() const;
/**
Gets the image type associated with this handler.
*/
long GetType();
long GetType() const;
/**
Loads a image from a stream, putting the resulting data into @e image. If the
@ -416,7 +416,7 @@ public:
@returns Returns number of colours in the histogram.
*/
unsigned long ComputeHistogram(wxImageHistogram& histogram);
unsigned long ComputeHistogram(wxImageHistogram& histogram) const;
/**
If the image has alpha channel, this method converts it to mask. All pixels
@ -434,7 +434,7 @@ public:
Deprecated, use equivalent @ref wxBitmap::ctor "wxBitmap constructor"
(which takes wxImage and depth as its arguments) instead.
*/
wxBitmap ConvertToBitmap();
wxBitmap ConvertToBitmap() const;
/**
Returns a greyscale version of the image. The returned image uses the luminance
@ -443,7 +443,7 @@ public:
(R * @e lr) + (G * @e lg) + (B * @e lb).
*/
wxImage ConvertToGreyscale(double lr = 0.299, double lg = 0.587,
double lb = 0.114);
double lb = 0.114) const;
/**
Returns monochromatic version of the image. The returned image has white
@ -451,12 +451,12 @@ public:
everywhere else.
*/
wxImage ConvertToMono(unsigned char r, unsigned char g,
unsigned char b);
unsigned char b) const;
/**
Returns an identical copy of the image.
*/
wxImage Copy();
wxImage Copy() const;
/**
Creates a fresh image. If @a clear is @true, the new image will be initialized
@ -523,14 +523,14 @@ public:
does have it, this pointer may be used to directly manipulate the alpha values
which are stored as the @ref getdata() RGB ones.
*/
unsigned char GetAlpha(int x, int y);
unsigned char* GetAlpha();
unsigned char GetAlpha(int x, int y) const;
const unsigned char * GetAlpha() const;
//@}
/**
Returns the blue intensity at the given coordinate.
*/
unsigned char GetBlue(int x, int y);
unsigned char GetBlue(int x, int y) const;
/**
Returns the image data as an array. This is most often used when doing
@ -543,12 +543,12 @@ public:
You should not delete the returned pointer nor pass it to
SetData().
*/
unsigned char* GetData();
unsigned char* GetData() const;
/**
Returns the green intensity at the given coordinate.
*/
unsigned char GetGreen(int x, int y);
unsigned char GetGreen(int x, int y) const;
/**
Returns the static list of image format handlers.
@ -560,7 +560,7 @@ public:
/**
Gets the height of the image in pixels.
*/
int GetHeight();
int GetHeight() const;
//@{
/**
@ -733,17 +733,17 @@ public:
/**
Gets the blue value of the mask colour.
*/
unsigned char GetMaskBlue();
unsigned char GetMaskBlue() const;
/**
Gets the green value of the mask colour.
*/
unsigned char GetMaskGreen();
unsigned char GetMaskGreen() const;
/**
Gets the red value of the mask colour.
*/
unsigned char GetMaskRed();
unsigned char GetMaskRed() const;
/**
Gets a user-defined option. The function is case-insensitive to @e name.
@ -752,7 +752,7 @@ public:
@see SetOption(), GetOptionInt(), HasOption()
*/
wxString GetOption(const wxString& name);
wxString GetOption(const wxString& name) const;
/**
Gets a user-defined option as an integer. The function is case-insensitive to
@ -786,14 +786,14 @@ public:
@see SetOption(), GetOption()
*/
int GetOptionInt(const wxString& name);
int GetOptionInt(const wxString& name) const;
/**
Get the current mask colour or find a suitable unused colour that could be
used as a mask colour. Returns @true if the image currently has a mask.
*/
bool GetOrFindMaskColour(unsigned char r, unsigned char g,
unsigned char b);
unsigned char b) const;
/**
Returns the palette associated with the image. Currently the palette is only
@ -801,25 +801,25 @@ public:
have been modified to set the palette if one exists in the image file (usually
256 or less colour images in GIF or PNG format).
*/
const wxPalette GetPalette();
const wxPalette GetPalette() const;
/**
Returns the red intensity at the given coordinate.
*/
unsigned char GetRed(int x, int y);
unsigned char GetRed(int x, int y) const;
/**
Returns a sub image of the current one as long as the rect belongs entirely to
the image.
*/
wxImage GetSubImage(const wxRect& rect);
wxImage GetSubImage(const wxRect& rect) const;
/**
Gets the width of the image in pixels.
@see GetHeight()
*/
int GetWidth();
int GetWidth() const;
/**
Constructor for HSVValue, an object that contains values for hue, saturation
@ -840,12 +840,12 @@ public:
@see GetAlpha(), SetAlpha()
*/
bool HasAlpha();
bool HasAlpha() const;
/**
Returns @true if there is a mask active, @false otherwise.
*/
bool HasMask();
bool HasMask() const;
/**
Returns @true if the given option is present. The function is case-insensitive
@ -853,7 +853,7 @@ public:
@see SetOption(), GetOption(), GetOptionInt()
*/
bool HasOption(const wxString& name);
bool HasOption(const wxString& name) const;
/**
Initializes the image alpha channel data. It is an error to call it
@ -887,14 +887,14 @@ public:
/**
Returns @true if image data is present.
*/
bool IsOk();
bool IsOk() const;
/**
Returns @true if the given pixel is transparent, i.e. either has the mask
colour if this image has a mask or if this image has alpha channel and alpha
value of this pixel is strictly less than @e threshold.
*/
bool IsTransparent(int x, int y, unsigned char threshold = 128);
bool IsTransparent(int x, int y, unsigned char threshold = 128) const;
//@{
/**
@ -1077,7 +1077,7 @@ public:
Returns a mirrored copy of the image. The parameter @e horizontally
indicates the orientation.
*/
wxImage Mirror(bool horizontally = true);
wxImage Mirror(bool horizontally = true) const;
/**
Copy the data of the given @a image to the specified position in this image.
@ -1162,7 +1162,7 @@ public:
Returns a copy of the image rotated 90 degrees in the direction
indicated by @e clockwise.
*/
wxImage Rotate90(bool clockwise = true);
wxImage Rotate90(bool clockwise = true) const;
/**
Rotates the hue of each pixel in the image by @e angle, which is a double in
@ -1294,12 +1294,13 @@ public:
@see LoadFile()
*/
bool SaveFile(const wxString& name, int type);
bool SaveFile(const wxString& name, const wxString& mimetype);
bool SaveFile(const wxString& name);
bool SaveFile(wxOutputStream& stream, int type);
bool SaveFile(wxOutputStream& stream,
const wxString& mimetype);
bool SaveFile(const wxString& name, int type) const;
const bool SaveFile(const wxString& name,
const wxString& mimetype) const;
const bool SaveFile(const wxString& name) const;
const bool SaveFile(wxOutputStream& stream, int type) const;
const bool SaveFile(wxOutputStream& stream,
const wxString& mimetype) const;
//@}
/**
@ -1352,7 +1353,7 @@ public:
@see Rescale()
*/
wxImage Scale(int width, int height,
int quality = wxIMAGE_QUALITY_NORMAL);
int quality = wxIMAGE_QUALITY_NORMAL) const;
//@{
/**
@ -1448,7 +1449,7 @@ public:
@see Resize()
*/
wxImage Size(const wxSize& size, const wxPoint pos, int red = -1,
int green = -1, int blue = -1);
int green = -1, int blue = -1) const;
/**
Assignment operator, using @ref overview_trefcount "reference counting".

8
interface/imaglist.h
View File

@ -147,17 +147,17 @@ public:
/**
Returns the bitmap corresponding to the given index.
*/
wxBitmap GetBitmap(int index);
wxBitmap GetBitmap(int index) const;
/**
Returns the icon corresponding to the given index.
*/
wxIcon GetIcon(int index);
wxIcon GetIcon(int index) const;
/**
Returns the number of images in the list.
*/
int GetImageCount();
int GetImageCount() const;
/**
Retrieves the size of the images in the list. Currently, the @a index
@ -173,7 +173,7 @@ public:
@returns @true if the function succeeded, @false if it failed (for example,
if the image list was not yet initialized).
*/
bool GetSize(int index, int& width, int& height);
bool GetSize(int index, int& width, int& height) const;
/**
Removes the image at the given position.

38
interface/intl.h
View File

@ -165,7 +165,7 @@ public:
This form is internally used when looking up message catalogs.
Compare GetSysName().
*/
wxString GetCanonicalName();
wxString GetCanonicalName() const;
/**
Returns the header value for header @e header. The search for @a header is case
@ -175,14 +175,14 @@ public:
The return value is the value of the header if found. Else this will be empty.
*/
wxString GetHeaderValue(const wxString& header,
const wxString& domain = wxEmptyString);
const wxString& domain = wxEmptyString) const;
/**
Returns wxLanguage constant of current language.
Note that you can call this function only if you used the form of
Init() that takes wxLanguage argument.
*/
int GetLanguage();
int GetLanguage() const;
/**
Returns a pointer to wxLanguageInfo structure containing information about the
@ -194,7 +194,7 @@ public:
special meaning if passed as an argument to this function and in this case the
result of GetSystemLanguage() is used.
*/
static wxLanguageInfo* GetLanguageInfo(int lang);
static wxLanguageInfo* GetLanguageInfo(int lang) const;
/**
Returns English name of the given language or empty string if this
@ -202,20 +202,20 @@ public:
See GetLanguageInfo() for a remark about
special meaning of @c wxLANGUAGE_DEFAULT.
*/
static wxString GetLanguageName(int lang);
static wxString GetLanguageName(int lang) const;
/**
Returns the locale name as passed to the constructor or
Init(). This is full, human-readable name,
e.g. "English" or "French".
*/
const wxString GetLocale();
const wxString GetLocale() const;
/**
Returns the current short name for the locale (as given to the constructor or
the Init() function).
*/
const wxString GetName();
const wxString GetName() const;
//@{
/**
@ -241,25 +241,25 @@ public:
added later override those added before.
*/
const wxString GetString(const wxString& origString,
const wxString& domain = wxEmptyString);
const wxString GetString(const wxString& origString,
const wxString& origString2,
size_t n,
const wxString& domain = NULL);
const wxString& domain = wxEmptyString) const;
const const wxString& GetString(const wxString& origString,
const wxString& origString2,
size_t n,
const wxString& domain = NULL) const;
//@}
/**
Returns current platform-specific locale name as passed to setlocale().
Compare GetCanonicalName().
*/
wxString GetSysName();
wxString GetSysName() const;
/**
Tries to detect the user's default font encoding.
Returns wxFontEncoding value or
@b wxFONTENCODING_SYSTEM if it couldn't be determined.
*/
static wxFontEncoding GetSystemEncoding();
static wxFontEncoding GetSystemEncoding() const;
/**
Tries to detect the name of the user's default font encoding. This string isn't
@ -269,14 +269,14 @@ public:
Returns a user-readable string value or an empty string if it couldn't be
determined.
*/
static wxString GetSystemEncodingName();
static wxString GetSystemEncodingName() const;
/**
Tries to detect the user's default language setting.
Returns wxLanguage value or
@b wxLANGUAGE_UNKNOWN if the language-guessing algorithm failed.
*/
static int GetSystemLanguage();
static int GetSystemLanguage() const;
//@{
/**
@ -374,12 +374,12 @@ public:
normally corresponds to 'domain' which is more or less the application name.
See also: AddCatalog()
*/
bool IsLoaded(const char* domain);
bool IsLoaded(const char* domain) const;
/**
Returns @true if the locale could be set successfully.
*/
bool IsOk();
bool IsOk() const;
/**
See @ref overview_languagecodes "list of recognized language constants".
@ -516,7 +516,7 @@ public:
or
@false otherwise.
*/
bool IsOk();
bool IsOk() const;
/**
Currently the following @c _l-functions are available:

76
interface/joystick.h
View File

@ -40,31 +40,31 @@ public:
@param id
The button id to report, from 0 to GetNumberButtons() - 1
*/
int GetButtonState();
bool GetButtonState(unsigned id);
int GetButtonState() const;
const bool GetButtonState(unsigned id) const;
//@}
/**
Returns the manufacturer id.
*/
int GetManufacturerId();
int GetManufacturerId() const;
/**
Returns the movement threshold, the number of steps outside which the joystick
is deemed to have
moved.
*/
int GetMovementThreshold();
int GetMovementThreshold() const;
/**
Returns the number of axes for this joystick.
*/
int GetNumberAxes();
int GetNumberAxes() const;
/**
Returns the number of buttons for this joystick.
*/
int GetNumberButtons();
int GetNumberButtons() const;
/**
Returns the number of joysticks currently attached to the computer.
@ -76,7 +76,7 @@ public:
degree units.
Returns -1 on error.
*/
int GetPOVCTSPosition();
int GetPOVCTSPosition() const;
/**
Returns the point-of-view position, expressed in continuous, one-hundredth of a
@ -84,17 +84,17 @@ public:
but limited to return 0, 9000, 18000 or 27000.
Returns -1 on error.
*/
int GetPOVPosition();
int GetPOVPosition() const;
/**
Returns the maximum polling frequency.
*/
int GetPollingMax();
int GetPollingMax() const;
/**
Returns the minimum polling frequency.
*/
int GetPollingMin();
int GetPollingMin() const;
//@{
/**
@ -103,140 +103,140 @@ public:
@param axis
The joystick axis to report, from 0 to GetNumberAxes() - 1.
*/
wxPoint GetPosition();
int GetPosition(unsigned axis);
wxPoint GetPosition() const;
const int GetPosition(unsigned axis) const;
//@}
/**
Returns the product id for the joystick.
*/
int GetProductId();
int GetProductId() const;
/**
Returns the product name for the joystick.
*/
wxString GetProductName();
wxString GetProductName() const;
/**
Returns the maximum rudder position.
*/
int GetRudderMax();
int GetRudderMax() const;
/**
Returns the minimum rudder position.
*/
int GetRudderMin();
int GetRudderMin() const;
/**
Returns the rudder position.
*/
int GetRudderPosition();
int GetRudderPosition() const;
/**
Returns the maximum U position.
*/
int GetUMax();
int GetUMax() const;
/**
Returns the minimum U position.
*/
int GetUMin();
int GetUMin() const;
/**
Gets the position of the fifth axis of the joystick, if it exists.
*/
int GetUPosition();
int GetUPosition() const;
/**
Returns the maximum V position.
*/
int GetVMax();
int GetVMax() const;
/**
Returns the minimum V position.
*/
int GetVMin();
int GetVMin() const;
/**
Gets the position of the sixth axis of the joystick, if it exists.
*/
int GetVPosition();
int GetVPosition() const;
/**
Returns the maximum x position.
*/
int GetXMax();
int GetXMax() const;
/**
Returns the minimum x position.
*/
int GetXMin();
int GetXMin() const;
/**
Returns the maximum y position.
*/
int GetYMax();
int GetYMax() const;
/**
Returns the minimum y position.
*/
int GetYMin();
int GetYMin() const;
/**
Returns the maximum z position.
*/
int GetZMax();
int GetZMax() const;
/**
Returns the minimum z position.
*/
int GetZMin();
int GetZMin() const;
/**
Returns the z position of the joystick.
*/
int GetZPosition();
int GetZPosition() const;
/**
Returns @true if the joystick has a point of view control.
*/
bool HasPOV();
bool HasPOV() const;
/**
Returns @true if the joystick point-of-view supports discrete values (centered,
forward, backward, left, and right).
*/
bool HasPOV4Dir();
bool HasPOV4Dir() const;
/**
Returns @true if the joystick point-of-view supports continuous degree bearings.
*/
#define bool HasPOVCTS() /* implementation is private */
#define bool HasPOVCTS() const /* implementation is private */
/**
Returns @true if there is a rudder attached to the computer.
*/
bool HasRudder();
bool HasRudder() const;
/**
Returns @true if the joystick has a U axis.
*/
bool HasU();
bool HasU() const;
/**
Returns @true if the joystick has a V axis.
*/
bool HasV();
bool HasV() const;
/**
Returns @true if the joystick has a Z axis.
*/
bool HasZ();
bool HasZ() const;
/**
Returns @true if the joystick is functioning.
*/
bool IsOk();
bool IsOk() const;
/**
Releases the capture set by @b SetCapture.

24
interface/laywin.h
View File

@ -111,7 +111,7 @@ public:
remaining space.
This function simply calls LayoutWindow().
*/
bool LayoutFrame(wxFrame* frame, wxWindow* mainWindow = NULL);
bool LayoutFrame(wxFrame* frame, wxWindow* mainWindow = NULL) const;
/**
Lays out the children of an MDI parent frame. If @a rect is non-@NULL, the
@ -119,7 +119,7 @@ public:
area.
The MDI client window is set to occupy the remaining space.
*/
bool LayoutMDIFrame(wxMDIParentFrame* frame, wxRect* rect = NULL);
bool LayoutMDIFrame(wxMDIParentFrame* frame, wxRect* rect = NULL) const;
/**
Lays out the children of a normal frame or other window.
@ -131,7 +131,7 @@ public:
and the window will be set
to the remaining size).
*/
bool LayoutWindow(wxWindow* parent, wxWindow* mainWindow = NULL);
bool LayoutWindow(wxWindow* parent, wxWindow* mainWindow = NULL) const;
};
@ -223,13 +223,13 @@ public:
Returns the alignment of the window: one of wxLAYOUT_TOP, wxLAYOUT_LEFT,
wxLAYOUT_RIGHT, wxLAYOUT_BOTTOM.
*/
wxLayoutAlignment GetAlignment();
wxLayoutAlignment GetAlignment() const;
/**
Returns the orientation of the window: one of wxLAYOUT_HORIZONTAL,
wxLAYOUT_VERTICAL.
*/
wxLayoutOrientation GetOrientation();
wxLayoutOrientation GetOrientation() const;
/**
The default handler for the event that is generated by wxLayoutAlgorithm. The
@ -305,32 +305,32 @@ public:
the window sticks to). One of wxLAYOUT_TOP, wxLAYOUT_LEFT, wxLAYOUT_RIGHT,
wxLAYOUT_BOTTOM.
*/
void GetAlignment();
void GetAlignment() const;
/**
Returns the flags associated with this event. Not currently used.
*/
int GetFlags();
int GetFlags() const;
/**
Returns the orientation that the event handler specified to the event object.
May be one of wxLAYOUT_HORIZONTAL,
wxLAYOUT_VERTICAL.
*/
wxLayoutOrientation GetOrientation();
wxLayoutOrientation GetOrientation() const;
/**
Returns the requested length of the window in the direction of the window
orientation. This information
is not yet used.
*/
int GetRequestedLength();
int GetRequestedLength() const;
/**
Returns the size that the event handler specified to the event object as being
the requested size of the window.
*/
wxSize GetSize();
wxSize GetSize() const;
/**
Call this to specify the alignment of the window (which side of the remaining
@ -391,7 +391,7 @@ public:
/**
Returns the flags associated with this event. Not currently used.
*/
int GetFlags();
int GetFlags() const;
/**
Before the event handler is entered, returns the remaining parent client area
@ -400,7 +400,7 @@ public:
parent client rectangle,
after the event handler has subtracted the area that its window occupies.
*/
wxRect GetRect();
wxRect GetRect() const;
/**
Sets the flags associated with this event. Not currently used.

54
interface/list.h
View File

@ -96,28 +96,28 @@ public:
/**
Returns the iterator refering to @a object or @NULL if none found.
*/
wxListT::compatibility_iterator Find(T* object);
wxListT::compatibility_iterator Find(T* object) const;
/**
Returns the number of elements in the list.
*/
size_t GetCount();
size_t GetCount() const;
/**
Returns the first iterator in the list (@NULL if the list is empty).
*/
wxListT::compatibility_iterator GetFirst();
wxListT::compatibility_iterator GetFirst() const;
/**
Returns the last iterator in the list (@NULL if the list is empty).
*/
wxListT::compatibility_iterator GetLast();
wxListT::compatibility_iterator GetLast() const;
/**
Returns the index of @a obj within the list or @c wxNOT_FOUND if
@a obj is not found in the list.
*/
int IndexOf(T* obj);
int IndexOf(T* obj) const;
//@{
/**
@ -133,18 +133,18 @@ public:
/**
Returns @true if the list is empty, @false otherwise.
*/
bool IsEmpty();
bool IsEmpty() const;
/**
Returns the iterator refering to the object at the given
@c index in the list.
*/
wxListT::compatibility_iterator Item(size_t index);
wxListT::compatibility_iterator Item(size_t index) const;
/**
@b NB: This function is deprecated, use wxList::Find instead.
*/
wxListT::compatibility_iterator Member(T* object);
wxListT::compatibility_iterator Member(T* object) const;
/**
@b NB: This function is deprecated, use @ref wxList::itemfunc Item instead.
@ -152,13 +152,13 @@ public:
empty
or the nth node could not be found).
*/
wxListT::compatibility_iterator Nth(int n);
wxListT::compatibility_iterator Nth(int n) const;
/**
@b NB: This function is deprecated, use wxList::GetCount instead.
Returns the number of elements in the list.
*/
int Number();
int Number() const;
/**
Allows the sorting of arbitrary lists by giving a function to compare
@ -179,16 +179,16 @@ public:
/**
Returns the last item of the list.
*/
reference back();
const_reference back();
reference back() const;
const_reference back() const;
//@}
//@{
/**
Returns a (const) iterator pointing to the beginning of the list.
*/
iterator begin();
const_iterator begin();
iterator begin() const;
const_iterator begin() const;
//@}
/**
@ -199,14 +199,14 @@ public:
/**
Returns @e @true if the list is empty.
*/
bool empty();
bool empty() const;
//@{
/**
Returns a (const) iterator pointing at the end of the list.
*/
iterator end();
const_iterator end();
iterator end() const;
const_iterator end() const;
//@}
//@{
@ -222,8 +222,8 @@ public:
/**
Returns the first item in the list.
*/
reference front();
const_reference front();
reference front() const;
const_reference front() const;
//@}
//@{
@ -239,7 +239,7 @@ public:
/**
Returns the largest possible size of the list.
*/
size_type max_size();
size_type max_size() const;
/**
Removes the last item from the list.
@ -268,8 +268,8 @@ public:
Returns a (const) reverse iterator pointing to the beginning of the
reversed list.
*/
reverse_iterator rbegin();
const_reverse_iterator rbegin();
reverse_iterator rbegin() const;
const_reverse_iterator rbegin() const;
//@}
/**
@ -282,8 +282,8 @@ public:
Returns a (const) reverse iterator pointing to the end of the
reversed list.
*/
reverse_iterator rend();
const_reverse_iterator rend();
reverse_iterator rend() const;
const_reverse_iterator rend() const;
//@}
/**
@ -301,7 +301,7 @@ public:
/**
Returns the size of the list.
*/
size_type size();
size_type size() const;
};
@ -336,12 +336,12 @@ public:
/**
Retrieves the client data pointer associated with the node.
*/
T* GetData();
T* GetData() const;
/**
Retrieves the next node or @NULL if this node is the last one.
*/
wxNodeT* GetNext();
wxNodeT* GetNext() const;
/**
Retrieves the previous node or @NULL if this node is the first one in the list.

6
interface/listbox.h
View File

@ -158,7 +158,7 @@ public:
@see wxControlWithItems::GetSelection, wxControlWithItems::GetStringSelection,
wxControlWithItems::SetSelection
*/
int GetSelections(wxArrayInt& selections);
int GetSelections(wxArrayInt& selections) const;
/**
Returns the item located at @e point, or @c wxNOT_FOUND if there
@ -173,7 +173,7 @@ public:
@returns Item located at point, or wxNOT_FOUND if unimplemented or the
item does not exist.
*/
int HitTest(const wxPoint point);
int HitTest(const wxPoint point) const;
//@{
/**
@ -202,7 +202,7 @@ public:
@returns @true if the given item is selected, @false otherwise.
*/
bool IsSelected(int n);
bool IsSelected(int n) const;
//@{
/**

134
interface/listctrl.h
View File

@ -237,33 +237,33 @@ public:
Gets information about this column. See SetItem() for more
information.
*/
bool GetColumn(int col, wxListItem& item);
bool GetColumn(int col, wxListItem& item) const;
/**
Returns the number of columns.
*/
int GetColumnCount();
int GetColumnCount() const;
/**
Gets the column number by visual order index (report view only).
*/
int GetColumnIndexFromOrder(int order);
int GetColumnIndexFromOrder(int order) const;
/**
Gets the column visual order index (valid in report view only).
*/
int GetColumnOrder(int col);
int GetColumnOrder(int col) const;
/**
Gets the column width (report view only).
*/
int GetColumnWidth(int col);
int GetColumnWidth(int col) const;
/**
Returns the array containing the orders of all columns. On error, an empty
array is returned.
*/
wxArrayInt GetColumnsOrder();
wxArrayInt GetColumnsOrder() const;
/**
Gets the number of items that can fit vertically in the
@ -271,7 +271,7 @@ public:
or the total number of items in the list control (icon
or small icon view).
*/
int GetCountPerPage();
int GetCountPerPage() const;
/**
Returns the edit control being currently used to edit a label. Returns @NULL
@ -279,7 +279,7 @@ public:
@b NB: It is currently only implemented for wxMSW and the generic version,
not for the native Mac OS X version.
*/
wxTextCtrl* GetEditControl();
wxTextCtrl* GetEditControl() const;
/**
Returns the specified image list. @a which may be one of:
@ -296,7 +296,7 @@ public:
The user-defined state image list (unimplemented).
*/
wxImageList* GetImageList(int which);
wxImageList* GetImageList(int which) const;
/**
Gets information about the item. See SetItem() for more
@ -304,7 +304,7 @@ public:
You must call @e info.SetId() to the ID of item you're interested in
before calling this method.
*/
bool GetItem(wxListItem& info);
bool GetItem(wxListItem& info) const;
/**
Returns the colour for this item. If the item has no specific colour, returns
@ -313,27 +313,27 @@ public:
@see GetItemTextColour()
*/
wxColour GetItemBackgroundColour(long item);
wxColour GetItemBackgroundColour(long item) const;
/**
Returns the number of items in the list control.
*/
int GetItemCount();
int GetItemCount() const;
/**
Gets the application-defined data associated with this item.
*/
long GetItemData(long item);
long GetItemData(long item) const;
/**
Returns the item's font.
*/
wxFont GetItemFont(long item);
wxFont GetItemFont(long item) const;
/**
Returns the position of the item, in icon or small icon view.
*/
bool GetItemPosition(long item, wxPoint& pos);
bool GetItemPosition(long item, wxPoint& pos) const;
/**
Returns the rectangle representing the item's size and position, in physical
@ -341,25 +341,25 @@ public:
@a code is one of wxLIST_RECT_BOUNDS, wxLIST_RECT_ICON, wxLIST_RECT_LABEL.
*/
bool GetItemRect(long item, wxRect& rect,
int code = wxLIST_RECT_BOUNDS);
int code = wxLIST_RECT_BOUNDS) const;
/**
Retrieves the spacing between icons in pixels: horizontal spacing is returned
as @c x component of the wxSize object and the vertical
spacing as its @c y component.
*/
wxSize GetItemSpacing();
wxSize GetItemSpacing() const;
/**
Gets the item state. For a list of state flags, see SetItem().
The @b stateMask indicates which state flags are of interest.
*/
int GetItemState(long item, long stateMask);
int GetItemState(long item, long stateMask) const;
/**
Gets the item text for this item.
*/
wxString GetItemText(long item);
wxString GetItemText(long item) const;
/**
Returns the colour for this item. If the item has no specific colour, returns
@ -368,7 +368,7 @@ public:
the current control foreground and items with default colour which, hence, have
always the same colour as the control).
*/
wxColour GetItemTextColour(long item);
wxColour GetItemTextColour(long item) const;
/**
Searches for an item with the given geometry or state, starting from
@ -425,12 +425,12 @@ public:
The item is selected as part of a cut and paste operation.
*/
long GetNextItem(long item, int geometry = wxLIST_NEXT_ALL,
int state = wxLIST_STATE_DONTCARE);
int state = wxLIST_STATE_DONTCARE) const;
/**
Returns the number of selected items in the list control.
*/
int GetSelectedItemCount();
int GetSelectedItemCount() const;
/**
Returns the rectangle representing the size and position, in physical
@ -445,18 +445,18 @@ public:
This function is new since wxWidgets version 2.7.0
*/
bool GetSubItemRect(long item, long subItem, wxRect& rect,
int code = wxLIST_RECT_BOUNDS);
int code = wxLIST_RECT_BOUNDS) const;
/**
Gets the text colour of the list control.
*/
wxColour GetTextColour();
wxColour GetTextColour() const;
/**
Gets the index of the topmost visible item when in
list or report view.
*/
long GetTopItem();
long GetTopItem() const;
/**
Returns the rectangle taken by all items in the control. In other words, if the
@ -465,7 +465,7 @@ public:
Note that this function only works in the icon and small icon views, not in
list or report views (this is a limitation of the native Win32 control).
*/
wxRect GetViewRect();
wxRect GetViewRect() const;
/**
Determines which item (if any) is at the specified point,
@ -523,7 +523,7 @@ public:
commctrl.h of version 4.70 that is provided by Microsoft.
*/
long HitTest(const wxPoint& point, int& flags,
long* ptrSubItem);
long* ptrSubItem) const;
//@{
/**
@ -567,7 +567,7 @@ public:
@see OnGetItemImage(), OnGetItemColumnImage(),
OnGetItemText()
*/
virtual wxListItemAttr* OnGetItemAttr(long item);
virtual wxListItemAttr* OnGetItemAttr(long item) const;
/**
Overload this function in the derived class for a control with
@ -579,7 +579,7 @@ public:
@see OnGetItemText(), OnGetItemImage(),
OnGetItemAttr()
*/
virtual int OnGetItemColumnImage(long item, long column);
virtual int OnGetItemColumnImage(long item, long column) const;
/**
This function must be overloaded in the derived class for a control with
@ -594,7 +594,7 @@ public:
@see OnGetItemText(), OnGetItemColumnImage(),
OnGetItemAttr()
*/
virtual int OnGetItemImage(long item);
virtual int OnGetItemImage(long item) const;
/**
This function @b must be overloaded in the derived class for a control with
@ -604,7 +604,7 @@ public:
@see SetItemCount(), OnGetItemImage(),
OnGetItemColumnImage(), OnGetItemAttr()
*/
virtual wxString OnGetItemText(long item, long column);
virtual wxString OnGetItemText(long item, long column) const;
/**
Redraws the given @e item. This is only useful for the virtual list controls
@ -663,7 +663,7 @@ public:
once.
This function is valid in report view only.
*/
bool SetColumnOrder(const wxArrayInt& orders);
bool SetColumnOrder(const wxArrayInt& orders) const;
/**
Sets the image list associated with the control. @a which is one of
@ -956,13 +956,13 @@ public:
For @c EVT_LIST_CACHE_HINT event only: return the first item which the
list control advises us to cache.
*/
long GetCacheFrom();
long GetCacheFrom() const;
/**
For @c EVT_LIST_CACHE_HINT event only: return the last item (inclusive)
which the list control advises us to cache.
*/
long GetCacheTo();
long GetCacheTo() const;
/**
The column position: it is only used with @c COL events. For the column
@ -970,52 +970,52 @@ public:
the column click events it may be -1 if the user clicked in the list control
header outside any column.
*/
int GetColumn();
int GetColumn() const;
/**
The data.
*/
long GetData();
long GetData() const;
/**
The image.
*/
int GetImage();
int GetImage() const;
/**
The item index.
*/
long GetIndex();
long GetIndex() const;
/**
An item object, used by some events. See also wxListCtrl::SetItem.
*/
const wxListItem GetItem();
const wxListItem GetItem() const;
/**
Key code if the event is a keypress event.
*/
int GetKeyCode();
int GetKeyCode() const;
/**
The (new) item label for @c EVT_LIST_END_LABEL_EDIT event.
*/
const wxString GetLabel();
const wxString GetLabel() const;
/**
The mask.
*/
long GetMask();
long GetMask() const;
/**
The position of the mouse pointer if the event is a drag event.
*/
wxPoint GetPoint();
wxPoint GetPoint() const;
/**
The text.
*/
const wxString GetText();
const wxString GetText() const;
/**
This method only makes sense for @c EVT_LIST_END_LABEL_EDIT message
@ -1025,7 +1025,7 @@ public:
the edit and
the admittedly rare case when the user wants to rename it to an empty string).
*/
bool IsEditCancelled();
bool IsEditCancelled() const;
};
@ -1059,32 +1059,32 @@ public:
/**
Returns the currently set background color.
*/
const wxColour GetBackgroundColour();
const wxColour GetBackgroundColour() const;
/**
Returns the currently set font.
*/
const wxFont GetFont();
const wxFont GetFont() const;
/**
Returns the currently set text color.
*/
const wxColour GetTextColour();
const wxColour GetTextColour() const;
/**
Returns @true if the currently set background color is valid.
*/
bool HasBackgroundColour();
bool HasBackgroundColour() const;
/**
Returns @true if the currently set font is valid.
*/
bool HasFont();
bool HasFont() const;
/**
Returns @true if the currently set text color is valid.
*/
bool HasTextColour();
bool HasTextColour() const;
/**
Sets a new background color.
@ -1149,14 +1149,14 @@ public:
@returns The first selected item, if any, -1 otherwise.
*/
long GetFirstSelected();
long GetFirstSelected() const;
/**
Returns the currently focused item or -1 if none.
@see IsSelected(), Focus()
*/
long GetFocusedItem();
long GetFocusedItem() const;
/**
Used together with GetFirstSelected() to
@ -1165,7 +1165,7 @@ public:
@returns Returns the next selected item or -1 if there are no more of
them.
*/
long GetNextSelected(long item);
long GetNextSelected(long item) const;
/**
Returns @true if the item with the given @a index is selected,
@ -1173,7 +1173,7 @@ public:
@see GetFirstSelected(), GetNextSelected()
*/
bool IsSelected(long index);
bool IsSelected(long index) const;
/**
Selects or unselects the given item.
@ -1226,39 +1226,39 @@ public:
Returns the alignment for this item. Can be one of
wxLIST_FORMAT_LEFT, wxLIST_FORMAT_RIGHT or wxLIST_FORMAT_CENTRE.
*/
wxListColumnFormat GetAlign();
wxListColumnFormat GetAlign() const;
/**
Returns the background colour for this item.
*/
wxColour GetBackgroundColour();
wxColour GetBackgroundColour() const;
/**
Returns the zero-based column; meaningful only in report mode.
*/
int GetColumn();
int GetColumn() const;
/**
Returns client data associated with the control. Please note that
client data is associated with the item and not with subitems.
*/
long GetData();
long GetData() const;
/**
Returns the font used to display the item.
*/
wxFont GetFont();
wxFont GetFont() const;
/**
Returns the zero-based item position.
*/
long GetId();
long GetId() const;
/**
Returns the zero-based index of the image
associated with the item into the image list.
*/
int GetImage();
int GetImage() const;
/**
Returns a bit mask indicating which fields of the structure are valid;
@ -1288,7 +1288,7 @@ public:
@b GetFormat is valid.
*/
long GetMask();
long GetMask() const;
/**
Returns a bit field representing the state of the item. Can be any
@ -1314,22 +1314,22 @@ public:
The item is in the cut state. Win32 only.
*/
long GetState();
long GetState() const;
/**
Returns the label/header text.
*/
const wxString GetText();
const wxString GetText() const;
/**
Returns the text colour.
*/
wxColour GetTextColour();
wxColour GetTextColour() const;
/**
Meaningful only for column headers in report mode. Returns the column width.
*/
int GetWidth();
int GetWidth() const;
/**
Sets the alignment for the item. See also

6
interface/log.h
View File

@ -47,7 +47,7 @@ public:
Returns the associated log frame window. This may be used to position or resize
it but use Show() to show or hide it.
*/
wxFrame* GetFrame();
wxFrame* GetFrame() const;
/**
Called if the user closes the window interactively, will not be
@ -157,14 +157,14 @@ public:
/**
Returns the pointer to the previously active log target (which may be @NULL).
*/
wxLog* GetOldLog();
wxLog* GetOldLog() const;
/**
Returns @true if the messages are passed to the previously active log
target (default) or @false if PassMessages()
had been called.
*/
bool IsPassingMessages();
bool IsPassingMessages() const;
/**
By default, the log messages are passed to the previously active log target.

18
interface/longlong.h
View File

@ -53,7 +53,7 @@ public:
or modifying it in place (the second one). Not in wxULongLong.
*/
wxLongLong Abs();
wxLongLong Abs();
const wxLongLong& Abs();
//@}
/**
@ -66,39 +66,39 @@ public:
/**
Returns the high 32 bits of 64 bit integer.
*/
long GetHi();
long GetHi() const;
/**
Returns the low 32 bits of 64 bit integer.
*/
unsigned long GetLo();
unsigned long GetLo() const;
/**
Convert to native long long (only for compilers supporting it)
*/
wxLongLong_t GetValue();
wxLongLong_t GetValue() const;
/**
Returns the value as @c double.
*/
double ToDouble();
double ToDouble() const;
/**
Truncate wxLongLong to long. If the conversion loses data (i.e. the wxLongLong
value is outside the range of built-in long type), an assert will be triggered
in debug mode.
*/
long ToLong();
long ToLong() const;
/**
Returns the string representation of a wxLongLong.
*/
wxString ToString();
wxString ToString() const;
/**
Adds 2 wxLongLongs together and returns the result.
*/
wxLongLong operator+(const wxLongLong& ll);
wxLongLong operator+(const wxLongLong& ll) const;
//@{
/**
@ -116,7 +116,7 @@ public:
/**
Subtracts 2 wxLongLongs and returns the result.
*/
wxLongLong operator-(const wxLongLong& ll);
wxLongLong operator-(const wxLongLong& ll) const;
//@{
/**

10
interface/mdi.h
View File

@ -196,7 +196,7 @@ public:
/**
Returns a pointer to the active MDI child, if there is one.
*/
wxMDIChildFrame* GetActiveChild();
wxMDIChildFrame* GetActiveChild() const;
/**
This gets the size of the frame 'client area' in pixels.
@ -213,28 +213,28 @@ public:
@see GetToolBar(), SetToolBar(),
wxMDIClientWindow
*/
virtual void GetClientSize(int* width, int* height);
virtual void GetClientSize(int* width, int* height) const;
/**
Returns a pointer to the client window.
@see OnCreateClient()
*/
wxMDIClientWindow* GetClientWindow();
wxMDIClientWindow* GetClientWindow() const;
/**
Returns the window being used as the toolbar for this frame.
@see SetToolBar()
*/
virtual wxWindow* GetToolBar();
virtual wxWindow* GetToolBar() const;
/**
Returns the current Window menu (added by wxWidgets to the menubar). This
function
is available under Windows only.
*/
wxMenu* GetWindowMenu();
wxMenu* GetWindowMenu() const;
/**
Override this to return a different kind of client window. If you override this

Some files were not shown because too many files have changed in this diff Show More