//
// NB: we provide implementation for this pure virtual function, derived
// classes should call it
- virtual bool EnableMonthChange(bool enable) = 0;
+ virtual bool EnableMonthChange(bool enable = true) = 0;
// an item without custom attributes is drawn with the default colours and
style bit directly. It enables or disables the special highlighting of
the holidays.
*/
- void EnableHolidayDisplay(bool display = true);
+ virtual void EnableHolidayDisplay(bool display = true);
/**
This function should be used instead of changing
@return @true if the value of this option really changed or @false if
it was already set to the requested value.
*/
- bool EnableMonthChange(bool enable = true);
+ virtual bool EnableMonthChange(bool enable = true);
/**
@deprecated
@c wxCAL_NO_YEAR_CHANGE style bit directly. It allows or disallows the
user to change the year interactively. Only in generic wxCalendarCtrl.
*/
- void EnableYearChange(bool enable = true);
+ virtual void EnableYearChange(bool enable = true);
/**
Returns the attribute for the given date (should be in the range
1...31). The returned pointer may be @NULL. Only in generic
wxCalendarCtrl.
*/
- wxCalendarDateAttr* GetAttr(size_t day) const;
+ virtual wxCalendarDateAttr* GetAttr(size_t day) const;
/**
Gets the currently selected date.
*/
- const wxDateTime GetDate() const;
+ virtual wxDateTime GetDate() const;
/**
Gets the background colour of the header part of the calendar window.
@see SetHeaderColours()
*/
- const wxColour GetHeaderColourBg() const;
+ virtual const wxColour& GetHeaderColourBg() const;
/**
Gets the foreground colour of the header part of the calendar window.
@see SetHeaderColours()
*/
- const wxColour GetHeaderColourFg() const;
+ virtual const wxColour& GetHeaderColourFg() const;
/**
Gets the background highlight colour. Only in generic wxCalendarCtrl.
@see SetHighlightColours()
*/
- const wxColour GetHighlightColourBg() const;
+ virtual const wxColour& GetHighlightColourBg() const;
/**
Gets the foreground highlight colour. Only in generic wxCalendarCtrl.
@see SetHighlightColours()
*/
- const wxColour GetHighlightColourFg() const;
+ virtual const wxColour& GetHighlightColourFg() const;
/**
Return the background colour currently used for holiday highlighting.
@see SetHolidayColours()
*/
- const wxColour GetHolidayColourBg() const;
+ virtual const wxColour& GetHolidayColourBg() const;
/**
Return the foreground colour currently used for holiday highlighting.
@see SetHolidayColours()
*/
- const wxColour GetHolidayColourFg() const;
+ virtual const wxColour& GetHolidayColourFg() const;
/**
Returns one of wxCalendarHitTestResult constants and fills either
@a date or @a wd pointer with the corresponding value depending on the
hit test code.
-
+
Not implemented in wxGTK currently.
*/
- wxCalendarHitTestResult HitTest(const wxPoint& pos,
- wxDateTime* date = NULL,
- wxDateTime::WeekDay* wd = NULL);
+ virtual wxCalendarHitTestResult HitTest(const wxPoint& pos,
+ wxDateTime* date = NULL,
+ wxDateTime::WeekDay* wd = NULL);
/**
Clears any attributes associated with the given day (in the range
1...31). Only in generic wxCalendarCtrl.
*/
- void ResetAttr(size_t day);
+ virtual void ResetAttr(size_t day);
/**
Associates the attribute with the specified date (in the range 1...31).
If the pointer is @NULL, the items attribute is cleared. Only in
generic wxCalendarCtrl.
*/
- void SetAttr(size_t day, wxCalendarDateAttr* attr);
+ virtual void SetAttr(size_t day, wxCalendarDateAttr* attr);
/**
Sets the current date.
The @a date parameter must be valid.
*/
- void SetDate(const wxDateTime& date);
+ virtual void SetDate(const wxDateTime& date);
/**
Set the colours used for painting the weekdays at the top of the
This method is currently only implemented in generic wxCalendarCtrl and
does nothing in the native versions.
*/
- void SetHeaderColours(const wxColour& colFg,
- const wxColour& colBg);
+ virtual void SetHeaderColours(const wxColour& colFg,
+ const wxColour& colBg);
/**
Set the colours to be used for highlighting the currently selected
This method is currently only implemented in generic wxCalendarCtrl and
does nothing in the native versions.
*/
- void SetHighlightColours(const wxColour& colFg,
- const wxColour& colBg);
+ virtual void SetHighlightColours(const wxColour& colFg,
+ const wxColour& colBg);
/**
Marks the specified day as being a holiday in the current month.
This method is only implemented in the generic version of the control
and does nothing in the native ones.
*/
- void SetHoliday(size_t day);
+ virtual void SetHoliday(size_t day);
/**
Sets the colours to be used for the holidays highlighting.
-
+
This method is only implemented in the generic version of the control
and does nothing in the native ones. It should also only be called if
the window style includes @c wxCAL_SHOW_HOLIDAYS flag or
EnableHolidayDisplay() had been called.
*/
- void SetHolidayColours(const wxColour& colFg,
- const wxColour& colBg);
+ virtual void SetHolidayColours(const wxColour& colFg,
+ const wxColour& colBg);
/**
Mark or unmark the day. This day of month will be marked in every
month. In generic wxCalendarCtrl,
*/
- void Mark(size_t day, bool mark);
+ virtual void Mark(size_t day, bool mark);
/**
@name Date Range Functions
*/
wxBufferedDC(wxDC* dc, const wxSize& area,
int style = wxBUFFER_CLIENT_AREA);
+
/**
Creates a buffer for the provided dc. Init() must not be called when
using this constructor.
Copies everything drawn on the DC so far to the underlying DC
associated with this object, if any.
*/
- ~wxBufferedDC();
+ virtual ~wxBufferedDC();
//@{
/**
Copies everything drawn on the DC so far to the window associated with
this object, using a wxPaintDC.
*/
- ~wxBufferedPaintDC();
+ virtual ~wxBufferedPaintDC();
};
wxStdDialogButtonSizer();
/**
- Adds a button to the wxStdDialogButtonSizer. The @a button must have
+ Adds a button to the wxStdDialogButtonSizer. The @a button must have
one of the following identifiers:
wxID_OK
wxID_YES
Calculates the minimum desired size for the item, including any space
needed by borders.
*/
- wxSize CalcMin();
+ virtual wxSize CalcMin();
/**
Destroy the window or the windows in a subsizer, depending on the type
This method is abstract and has to be overwritten by any derived class.
Here, the sizer will do the actual calculation of its children's minimal sizes.
*/
- wxSize CalcMin();
+ virtual wxSize CalcMin();
/**
Detaches all children from the sizer. If @a delete_windows is @true then
/**
Detach the child @a window from the sizer without destroying it.
-
+
This method does not cause any layout or resizing to take place, call Layout()
to update the layout "on screen" after detaching a child from the sizer.
-
+
Returns @true if the child item was found and detached, @false otherwise.
@see Remove()
/**
Detach the child @a sizer from the sizer without destroying it.
-
+
This method does not cause any layout or resizing to take place, call Layout()
to update the layout "on screen" after detaching a child from the sizer.
-
+
Returns @true if the child item was found and detached, @false otherwise.
-
+
@see Remove()
*/
bool Detach(wxSizer* sizer);
/**
Detach a item at position @a index from the sizer without destroying it.
-
+
This method does not cause any layout or resizing to take place, call Layout()
to update the layout "on screen" after detaching a child from the sizer.
Returns @true if the child item was found and detached, @false otherwise.
@ref wxSizerItem "wxSizerItem".
*/
wxSizerItemList& GetChildren();
-
+
/**
Returns the list of the items in this sizer. The elements of type-safe
wxList @a wxSizerItemList are pointers to objects of type
Returns pointer to item or @NULL.
*/
wxSizerItem* GetItem(wxWindow* window, bool recursive = false);
-
+
/**
Finds wxSizerItem which holds the given @a sizer
Use parameter @a recursive to search in subsizers too.
Returns pointer to item or @NULL.
*/
-
+
wxSizerItem* GetItem(wxSizer* sizer, bool recursive = false);
/**
Finds wxSizerItem which is located in the sizer at position
/**
Hides the child @a window.
-
+
To make a sizer item disappear, use Hide() followed by Layout().
-
+
Use parameter @a recursive to hide elements found in subsizers.
Returns @true if the child item was found, @false otherwise.
/**
Hides the child @a sizer.
-
+
To make a sizer item disappear, use Hide() followed by Layout().
-
+
Use parameter @a recursive to hide elements found in subsizers.
Returns @true if the child item was found, @false otherwise.
/**
Hides the item at position @a index.
-
+
To make a sizer item disappear, use Hide() followed by Layout().
-
+
Use parameter @a recursive to hide elements found in subsizers.
Returns @true if the child item was found, @false otherwise.
Here, the sizer will do the actual calculation of its children's
positions and sizes.
*/
- void RecalcSizes();
+ virtual void RecalcSizes();
/**
Removes a child window from the sizer, but does @b not destroy it
replaces it with the given @a newwin. The detached
child window is @b not deleted (because windows are
owned by their parent window, not the sizer).
-
+
Use parameter @a recursive to search the given element recursively in subsizers.
This method does not cause any layout or resizing to take place,
call Layout() to update the layout "on screen" after replacing a
child from the sizer.
-
+
Returns @true if the child item was found and removed, @false otherwise.
*/
bool Replace(wxWindow* oldwin, wxWindow* newwin,
bool recursive = false);
-
+
/**
Detaches the given @a oldsz from the sizer and
replaces it with the given @a newsz. The detached
- child sizer is deleted.
-
+ child sizer is deleted.
+
Use parameter @a recursive to search the given element recursively in subsizers.
This method does not cause any layout or resizing to take place,
call Layout() to update the layout "on screen" after replacing a
child from the sizer.
-
+
Returns @true if the child item was found and removed, @false otherwise.
*/
bool Replace(wxSizer* oldsz, wxSizer* newsz,
bool recursive = false);
-
+
/**
Detaches the given item at position @a index from the sizer and
replaces it with the given wxSizerItem @a newitem.
-
+
The detached child is deleted @b only if it is a sizer or a spacer
(but not if it is a wxWindow because windows are owned by their
parent window, not the sizer).
-
+
This method does not cause any layout or resizing to take place,
call Layout() to update the layout "on screen" after replacing a
child from the sizer.
-
+
Returns @true if the child item was found and removed, @false otherwise.
*/
bool Replace(size_t index, wxSizerItem* newitem);
rules defined by the parameter in the Add() and Prepend() methods.
*/
void SetDimension(int x, int y, int width, int height);
-
+
/**
@overload
*/
/**
Shows or hides the @a window.
To make a sizer item disappear or reappear, use Show() followed by Layout().
-
+
Use parameter @a recursive to show or hide elements found in subsizers.
-
+
Returns @true if the child item was found, @false otherwise.
@see Hide(), IsShown()
/**
Shows or hides @a sizer.
To make a sizer item disappear or reappear, use Show() followed by Layout().
-
+
Use parameter @a recursive to show or hide elements found in subsizers.
-
+
Returns @true if the child item was found, @false otherwise.
@see Hide(), IsShown()
/**
Shows the item at @a index.
To make a sizer item disappear or reappear, use Show() followed by Layout().
-
+
Returns @true if the child item was found, @false otherwise.
@see Hide(), IsShown()
@library{wxcore}
@category{winlayout}
- @see wxSizer, wxStaticBox, wxBoxSizer, @ref overview_sizer
+ @see wxSizer, wxStaticBox, wxBoxSizer, @ref overview_sizer
"Sizer Overview"
*/
class wxStaticBoxSizer : public wxBoxSizer
simple basic geometry, typically in a row or a column or several hierarchies of
either.
- For more information, please see @ref overview_sizer_box
+ For more information, please see @ref overview_sizer_box
"Programming with wxBoxSizer".
@library{wxcore}
Implements the calculation of a box sizer's minimal. It is used internally
only and must not be called by the user. Documented for information.
*/
- wxSize CalcMin();
+ virtual wxSize CalcMin();
/**
Returns the orientation of the box sizer, either wxVERTICAL
or wxHORIZONTAL.
*/
- int GetOrientation();
+ int GetOrientation() const;
/**
Implements the calculation of a box sizer's dimensions and then sets
{
public:
/**
- Creates a buffered stream using a buffer of a default size of 1024 bytes for
- cashing the stream @a parent.
+ @todo WRITE DESCRIPTION
*/
- wxBufferedOutputStream(const wxOutputStream& parent);
-
+ wxBufferedOutputStream(wxOutputStream& stream,
+ wxStreamBuffer *buffer = NULL);
/**
Destructor. Calls Sync() and destroys the internal buffer.
*/
- ~wxBufferedOutputStream();
+ virtual ~wxBufferedOutputStream();
/**
Calls Sync() and changes the stream position.
*/
- off_t SeekO(off_t pos, wxSeekMode mode);
+ virtual wxFileOffset SeekO(wxFileOffset pos, wxSeekMode mode = wxFromStart)
/**
Flushes the buffer and calls Sync() on the parent stream.
*/
- void Sync();
+ virtual void Sync();
};
Default constructor.
*/
wxToggleButton();
-
+
/**
Constructor, creating and showing a toggle button.
const wxSize& size = wxDefaultSize,
long style = 0,
const wxValidator& val = wxDefaultValidator,
- const wxString& name = "checkBox");
+ const wxString& name = wxCheckBoxNameStr);
/**
Destructor, destroying the toggle button.
const wxSize& size = wxDefaultSize,
long style = 0,
const wxValidator& val = wxDefaultValidator,
- const wxString& name = "checkBox");
+ const wxString& name = wxCheckBoxNameStr);
/**
Gets the state of the toggle button.
Default constructor.
*/
wxBitmapToggleButton();
-
+
/**
Constructor, creating and showing a toggle button with the bitmap @e label.
Internally calls Create().
const wxSize& size = wxDefaultSize,
long style = 0,
const wxValidator& val = wxDefaultValidator,
- const wxString& name = "checkBox");
+ const wxString& name = wxCheckBoxNameStr);
/**
Create method for two-step construction.
const wxSize& size = wxDefaultSize,
long style = 0,
const wxValidator& val = wxDefaultValidator,
- const wxString& name = "checkBox");
+ const wxString& name = wxCheckBoxNameStr);
/**
Gets the state of the toggle button.
/**
Constructs a busy cursor object, calling wxBeginBusyCursor().
*/
- wxBusyCursor(wxCursor* cursor = wxHOURGLASS_CURSOR);
+ wxBusyCursor(const wxCursor* cursor = wxHOURGLASS_CURSOR);
/**
Destroys the busy cursor object, calling wxEndBusyCursor().
projects / wxWidgets.git / commitdiff
