wxWindow

wxPython note: In place of a single overloaded method name, wxPython implements the following methods:

ConvertDialogPointToPixels(point)	Accepts and returns a wxPoint
ConvertDialogSizeToPixels(size)	Accepts and returns a wxSize

Additionally, the following helper functions are defined:

wxDLG_PNT(win, point)	Converts a wxPoint from dialog units to pixels
wxDLG_SZE(win, size)	Converts a wxSize from dialog units to pixels

wxWindow::ConvertPixelsToDialog

wxPoint ConvertPixelsToDialog(const wxPoint& pt)

wxSize ConvertPixelsToDialog(const wxSize& sz)

Converts a point or size from pixels to dialog units.

For the x dimension, the pixels are multiplied by 4 and then divided by the average character width.

For the y dimension, the pixels are multiplied by 8 and then divided by the average character height.

Remarks

Dialog units are used for maintaining a dialog's proportions even if the font changes.

See also

wxPython note: In place of a single overloaded method name, wxPython implements the following methods:

ConvertDialogPointToPixels(point)	Accepts and returns a wxPoint
ConvertDialogSizeToPixels(size)	Accepts and returns a wxSize

wxWindow::Destroy

virtual bool Destroy()

Destroys the window safely. Use this function instead of the delete operator, since different window classes can be destroyed differently. Frames and dialogs are not destroyed immediately when this function is called -- they are added to a list of windows to be deleted on idle time, when all the window's events have been processed. This prevents problems with events being sent to non-existent windows.

Return value

true if the window has either been successfully deleted, or it has been added to the list of windows pending real deletion.

wxWindow::DestroyChildren

virtual void DestroyChildren()

Destroys all children of a window. Called automatically by the destructor.

wxWindow::Disable

bool Disable()

Disables the window, same as Enable(false).

Return value

Returns true if the window has been disabled, false if it had been already disabled before the call to this function.

wxWindow::DoGetBestSize

virtual wxSize DoGetBestSize() const

Gets the size which best suits the window: for a control, it would be the minimal size which doesn't truncate the control, for a panel - the same size as it would have after a call to Fit().

wxWindow::DoUpdateWindowUI

virtual void DoUpdateWindowUI(wxUpdateUIEvent& event)

Does the window-specific updating after processing the update event. This function is called by wxWindow::UpdateWindowUI in order to check return values in the wxUpdateUIEvent and act appropriately. For example, to allow frame and dialog title updating, wxWidgets implements this function as follows:

// do the window-specific processing after processing the update event
void wxTopLevelWindowBase::DoUpdateWindowUI(wxUpdateUIEvent& event)
{
    if ( event.GetSetEnabled() )
        Enable(event.GetEnabled());

    if ( event.GetSetText() )
    {
        if ( event.GetText() != GetTitle() )
            SetTitle(event.GetText());
    }
}

wxWindow::DragAcceptFiles

virtual void DragAcceptFiles(bool accept)

Enables or disables eligibility for drop file events (OnDropFiles).

Parameters

accept

true

false

Remarks

Windows only.

wxWindow::Enable

virtual bool Enable(bool enable = true)

Enable or disable the window for user input. Note that when a parent window is disabled, all of its children are disabled as well and they are reenabled again when the parent is.

Parameters

enable

true

false

Return value

Returns true if the window has been enabled or disabled, false if nothing was done, i.e. if the window had already been in the specified state.

wxWindow::FindFocus

static wxWindow* FindFocus()

Finds the window or control which currently has the keyboard focus.

Remarks

Note that this is a static function, so it can be called without needing a wxWindow pointer.

See also

wxWindow::FindWindow

wxWindow* FindWindow(long id) const

Find a child of this window, by identifier.

wxWindow* FindWindow(const wxString& name) const

Find a child of this window, by name.

wxPython note: In place of a single overloaded method name, wxPython implements the following methods:

FindWindowById(id)	Accepts an integer
FindWindowByName(name)	Accepts a string

wxWindow::FindWindowById

static wxWindow* FindWindowById(long id, wxWindow* parent = NULL)

Find the first window with the given id.

If parent is NULL, the search will start from all top-level frames and dialog boxes; if non-NULL, the search will be limited to the given window hierarchy. The search is recursive in both cases.

See also

wxWindow::FindWindowByName

static wxWindow* FindWindowByName(const wxString& name, wxWindow* parent = NULL)

Find a window by its name (as given in a window constructor or Create function call). If parent is NULL, the search will start from all top-level frames and dialog boxes; if non-NULL, the search will be limited to the given window hierarchy. The search is recursive in both cases.

If no window with such name is found, FindWindowByLabel is called.

See also

wxWindow::FindWindowByLabel

static wxWindow* FindWindowByLabel(const wxString& label, wxWindow* parent = NULL)

Find a window by its label. Depending on the type of window, the label may be a window title or panel item label. If parent is NULL, the search will start from all top-level frames and dialog boxes; if non-NULL, the search will be limited to the given window hierarchy. The search is recursive in both cases.

See also

wxWindow::Fit

virtual void Fit()

Sizes the window so that it fits around its subwindows. This function won't do anything if there are no subwindows and will only really work correctly if the sizers are used for the subwindows layout. Also, if the window has exactly one subwindow it is better (faster and the result is more precise as Fit adds some margin to account for fuzziness of its calculations) to call

    window->SetClientSize(child->GetSize());

instead of calling Fit.

wxWindow::FitInside

virtual void FitInside()

Similar to Fit, but sizes the interior (virtual) size of a window. Mainly useful with scrolled windows to reset scrollbars after sizing changes that do not trigger a size event, and/or scrolled windows without an interior sizer. This function similarly won't do anything if there are no subwindows.

wxWindow::Freeze

virtual void Freeze()

Freezes the window or, in other words, prevents any updates from taking place on screen, the window is not redrawn at all. Thaw must be called to reenable window redrawing. Calls to these two functions may be nested.

This method is useful for visual appearance optimization (for example, it is a good idea to use it before doing many large text insertions in a row into a wxTextCtrl under wxDT FACE="Arial, Lucida, Helvetica"> Accepts and returns a wxPoint ClientToScreenXY(x, y) Returns a 2-tuple, (x, y)

wxWindow::Close

bool Close(bool force = false)

This function simply generates a wxCloseEvent whose handler usually tries to close the window. It doesn't close the window itself, however.

Parameters

force

false

true

Remarks

The close handler should check whether the window is being deleted forcibly, using wxCloseEvent::CanVeto, in which case it should destroy the window using wxWindow::Destroy.

To guarantee that the window will be destroyed, call wxWindow::Destroy instead

wxWindow::ConvertDialogToPixels

wxPoint ConvertDialogToPixels(const wxPoint& pt)

wxSize ConvertDialogToPixels(const wxSize& sz)

Converts a point or size from dialog units to pixels.

For the x dimension, the dialog units are multiplied by the average character width and then divided by 4.

For the y dimension, the dialog units are multiplied by the average character height and then divided by 8.

Remarks

Dialog units are used for maintaining a dialog's proportions even if the font changes.

You can also use these functions programmatically. A convenience macro is defined:

#define wxDLG_UNIT(parent, pt) parent->ConvertDialogToPixels(pt)

See also

wxPython note: In place of a single overloaded method name, wxPython implements the following methods:

ConvertDialogPointToPixels(point)	Accepts and returns a wxPoint
ConvertDialogSizeToPixels(size)	Accepts and returns a wxSize

Additionally, the following helper functions are defined:

wxDLG_PNT(win, point)	Converts a wxPoint from dialog units to pixels
wxDLG_SZE(win, size)	Converts a wxSize from dialog units to pixels

wxWindow::ConvertPixelsToDialog

wxPoint ConvertPixelsToDialog(const wxPoint& pt)

wxSize ConvertPixelsToDialog(const wxSize& sz)

Converts a point or size from pixels to dialog units.

For the x dimension, the pixels are multiplied by 4 and then divided by the average character width.

For the y dimension, the pixels are multiplied by 8 and then divided by the average character height.

Remarks

Dialog units are used for maintaining a dialog's proportions even if the font changes.

See also

wxPython note: In place of a single overloaded method name, wxPython implements the following methods:

ConvertDialogPointToPixels(point)	Accepts and returns a wxPoint
ConvertDialogSizeToPixels(size)	Accepts and returns a wxSize

wxWindow::Destroy

virtual bool Destroy()

Return value

true if the window has either been successfully deleted, or it has been added to the list of windows pending real deletion.

wxWindow::DestroyChildren

virtual void DestroyChildren()

Destroys all children of a window. Called automatically by the destructor.

wxWindow::Disable

bool Disable()

Disables the window, same as Enable(false).

Return value

Returns true if the window has been disabled, false if it had been already disabled before the call to this function.

wxWindow::DoGetBestSize

virtual wxSize DoGetBestSize() const

Gets the size which best suits the window: for a control, it would be the minimal size which doesn't truncate the control, for a panel - the same size as it would have after a call to Fit().

wxWindow::DoUpdateWindowUI

virtual void DoUpdateWindowUI(wxUpdateUIEvent& event)

// do the window-specific processing after processing the update event
void wxTopLevelWindowBase::DoUpdateWindowUI(wxUpdateUIEvent& event)
{
    if ( event.GetSetEnabled() )
        Enable(event.GetEnabled());

    if ( event.GetSetText() )
    {
        if ( event.GetText() != GetTitle() )
            SetTitle(event.GetText());
    }
}

wxWindow::DragAcceptFiles

virtual void DragAcceptFiles(bool accept)

Enables or disables eligibility for drop file events (OnDropFiles).

Parameters

accept

true

false

Remarks

Windows only.

wxWindow::Enable

virtual bool Enable(bool enable = true)

Enable or disable the window for user input. Note that when a parent window is disabled, all of its children are disabled as well and they are reenabled again when the parent is.

Parameters

enable

true

false

Return value

Returns true if the window has been enabled or disabled, false if nothing was done, i.e. if the window had already been in the specified state.

wxWindow::FindFocus

static wxWindow* FindFocus()

Finds the window or control which currently has the keyboard focus.

Remarks

Note that this is a static function, so it can be called without needing a wxWindow pointer.

See also

wxWindow::FindWindow

wxWindow* FindWindow(long id) const

Find a child of this window, by identifier.

wxWindow* FindWindow(const wxString& name) const

Find a child of this window, by name.

wxPython note: In place of a single overloaded method name, wxPython implements the following methods:

FindWindowById(id)	Accepts an integer
FindWindowByName(name)	Accepts a string

wxWindow::FindWindowById

static wxWindow* FindWindowById(long id, wxWindow* parent = NULL)

Find the first window with the given id.

If parent is NULL, the search will start from all top-level frames and dialog boxes; if non-NULL, the search will be limited to the given window hierarchy. The search is recursive in both cases.

See also

wxWindow::FindWindowByName

static wxWindow* FindWindowByName(const wxString& name, wxWindow* parent = NULL)

If no window with such name is found, FindWindowByLabel is called.

See also

wxWindow::FindWindowByLabel

static wxWindow* FindWindowByLabel(const wxString& label, wxWindow* parent = NULL)

See also

wxWindow::Fit

virtual void Fit()

    window->SetClientSize(child->GetSize());

instead of calling Fit.

wxWindow::FitInside

virtual void FitInside()

wxWindow::Freeze

virtual void Freeze()

wxWindow::Close

bool Close(bool force = false)

This function simply generates a wxCloseEvent whose handler usually tries to close the window. It doesn't close the window itself, however.

Parameters

force

false

true

Remarks

The close handler should check whether the window is being deleted forcibly, using wxCloseEvent::CanVeto, in which case it should destroy the window using wxWindow::Destroy.

To guarantee that the window will be destroyed, call wxWindow::Destroy instead

wxWindow::ConvertDialogToPixels

wxPoint ConvertDialogToPixels(const wxPoint& pt)

wxSize ConvertDialogToPixels(const wxSize& sz)

Converts a point or size from dialog units to pixels.

For the x dimension, the dialog units are multiplied by the average character width and then divided by 4.

For the y dimension, the dialog units are multiplied by the average character height and then divided by 8.

Remarks

Dialog units are used for maintaining a dialog's proportions even if the font changes.

You can also use these functions programmatically. A convenience macro is defined:

#define wxDLG_UNIT(parent, pt) parent->ConvertDialogToPixels(pt)

See also

wxPython note: In place of a single overloaded method name, wxPython implements the following methods:

ConvertDialogPointToPixels(point)	Accepts and returns a wxPoint
ConvertDialogSizeToPixels(size)	Accepts and returns a wxSize

Additionally, the following helper functions are defined:

wxDLG_PNT(win, point)	Converts a wxPoint from dialog units to pixels
wxDLG_SZE(win, size)	Converts a wxSize from dialog units to pixels

wxWindow::ConvertPixelsToDialog

wxPoint ConvertPixelsToDialog(const wxPoint& pt)

wxSize ConvertPixelsToDialog(const wxSize& sz)

Converts a point or size from pixels to dialog units.

For the x dimension, the pixels are multiplied by 4 and then divided by the average character width.

For the y dimension, the pixels are multiplied by 8 and then divided by the average character height.

Remarks

Dialog units are used for maintaining a dialog's proportions even if the font changes.

See also

wxPython note: In place of a single overloaded method name, wxPython implements the following methods:

ConvertDialogPointToPixels(point)	Accepts and returns a wxPoint
ConvertDialogSizeToPixels(size)	Accepts and returns a wxSize

wxWindow::Destroy

virtual bool Destroy()

Return value

true if the window has either been successfully deleted, or it has been added to the list of windows pending real deletion.

wxWindow::DestroyChildren

virtual void DestroyChildren()

Destroys all children of a window. Called automatically by the destructor.

wxWindow::Disable

bool Disable()

Disables the window, same as Enable(false).

Return value

Returns true if the window has been disabled, false if it had been already disabled before the call to this function.

wxWindow::DoGetBestSize

virtual wxSize DoGetBestSize() const

Gets the size which best suits the window: for a control, it would be the minimal size which doesn't truncate the control, for a panel - the same size as it would have after a call to Fit().

wxWindow::DoUpdateWindowUI

virtual void DoUpdateWindowUI(wxUpdateUIEvent& event)

// do the window-specific processing after processing the update event
void wxTopLevelWindowBase::DoUpdateWindowUI(wxUpdateUIEvent& event)
{
    if ( event.GetSetEnabled() )
        Enable(event.GetEnabled());

    if ( event.GetSetText() )
    {
        if ( event.GetText() != GetTitle() )
            SetTitle(event.GetText());
    }
}

wxWindow::DragAcceptFiles

virtual void DragAcceptFiles(bool accept)

Enables or disables eligibility for drop file events (OnDropFiles).

Parameters

accept

true

false

Remarks

Windows only.

wxWindow::Enable

virtual bool Enable(bool enable = true)

Enable or disable the window for user input. Note that when a parent window is disabled, all of its children are disabled as well and they are reenabled again when the parent is.

Parameters

enable

true

false

Return value

Returns true if the window has been enabled or disabled, false if nothing was done, i.e. if the window had already been in the specified state.

wxWindow::FindFocus

static wxWindow* FindFocus()

Finds the window or control which currently has the keyboard focus.

Remarks

Note that this is a static function, so it can be called without needing a wxWindow pointer.

See also

wxWindow::FindWindow

wxWindow* FindWindow(long id) const

Find a child of this window, by identifier.

wxWindow* FindWindow(const wxString& name) const

Find a child of this window, by name.

wxPython note: In place of a single overloaded method name, wxPython implements the following methods:

FindWindowById(id)	Accepts an integer
FindWindowByName(name)	Accepts a string

wxWindow::FindWindowById

static wxWindow* FindWindowById(long id, wxWindow* parent = NULL)

Find the first window with the given id.

If parent is NULL, the search will start from all top-level frames and dialog boxes; if non-NULL, the search will be limited to the given window hierarchy. The search is recursive in both cases.

See also

wxWindow::FindWindowByName

static wxWindow* FindWindowByName(const wxString& name, wxWindow* parent = NULL)

If no window with such name is found, FindWindowByLabel is called.

See also

wxWindow::FindWindowByLabel

static wxWindow* FindWindowByLabel(const wxString& label, wxWindow* parent = NULL)

See also

wxWindow::Fit

virtual void Fit()

    window->SetClientSize(child->GetSize());

instead of calling Fit.

wxWindow::FitInside

virtual void FitInside()

wxWindow::Freeze

virtual void Freeze()

wxWindow::Close

bool Close(bool force = false)

This function simply generates a wxCloseEvent whose handler usually tries to close the window. It doesn't close the window itself, however.

Parameters

force

false

true

Remarks

The close handler should check whether the window is being deleted forcibly, using wxCloseEvent::CanVeto, in which case it should destroy the window using wxWindow::Destroy.

To guarantee that the window will be destroyed, call wxWindow::Destroy instead

wxWindow::ConvertDialogToPixels

wxPoint ConvertDialogToPixels(const wxPoint& pt)

wxSize ConvertDialogToPixels(const wxSize& sz)

Converts a point or size from dialog units to pixels.

For the x dimension, the dialog units are multiplied by the average character width and then divided by 4.

For the y dimension, the dialog units are multiplied by the average character height and then divided by 8.

Remarks

Dialog units are used for maintaining a dialog's proportions even if the font changes.

You can also use these functions programmatically. A convenience macro is defined:

#define wxDLG_UNIT(parent, pt) parent->ConvertDialogToPixels(pt)

See also

wxPython note: In place of a single overloaded method name, wxPython implements the following methods:

ConvertDialogPointToPixels(point)	Accepts and returns a wxPoint
ConvertDialogSizeToPixels(size)	Accepts and returns a wxSize

Additionally, the following helper functions are defined:

wxDLG_PNT(win, point)	Converts a wxPoint from dialog units to pixels
wxDLG_SZE(win, size)	Converts a wxSize from dialog units to pixels

wxWindow::ConvertPixelsToDialog

wxPoint ConvertPixelsToDialog(const wxPoint& pt)

wxSize ConvertPixelsToDialog(const wxSize& sz)

Converts a point or size from pixels to dialog units.

For the x dimension, the pixels are multiplied by 4 and then divided by the average character width.

For the y dimension, the pixels are multiplied by 8 and then divided by the average character height.

Remarks

Dialog units are used for maintaining a dialog's proportions even if the font changes.

See also

wxPython note: In place of a single overloaded method name, wxPython implements the following methods:

ConvertDialogPointToPixels(point)	Accepts and returns a wxPoint
ConvertDialogSizeToPixels(size)	Accepts and returns a wxSize

wxWindow::Destroy

virtual bool Destroy()

Return value

true if the window has either been successfully deleted, or it has been added to the list of windows pending real deletion.

wxWindow::DestroyChildren

virtual void DestroyChildren()

Destroys all children of a window. Called automatically by the destructor.

wxWindow::Disable

bool Disable()

Disables the window, same as Enable(false).

Return value

Returns true if the window has been disabled, false if it had been already disabled before the call to this function.

wxWindow::DoGetBestSize

virtual wxSize DoGetBestSize() const

Gets the size which best suits the window: for a control, it would be the minimal size which doesn't truncate the control, for a panel - the same size as it would have after a call to Fit().

wxWindow::DoUpdateWindowUI

virtual void DoUpdateWindowUI(wxUpdateUIEvent& event)

// do the window-specific processing after processing the update event
void wxTopLevelWindowBase::DoUpdateWindowUI(wxUpdateUIEvent& event)
{
    if ( event.GetSetEnabled() )
        Enable(event.GetEnabled());

    if ( event.GetSetText() )
    {
        if ( event.GetText() != GetTitle() )
            SetTitle(event.GetText());
    }
}

wxWindow::DragAcceptFiles

virtual void DragAcceptFiles(bool accept)

Enables or disables eligibility for drop file events (OnDropFiles).

Parameters

accept

true

false

Remarks

Windows only.

wxWindow::Enable

virtual bool Enable(bool enable = true)

Enable or disable the window for user input. Note that when a parent window is disabled, all of its children are disabled as well and they are reenabled again when the parent is.

Parameters

enable

true

false

Return value

Returns true if the window has been enabled or disabled, false if nothing was done, i.e. if the window had already been in the specified state.

wxWindow::FindFocus

static wxWindow* FindFocus()

Finds the window or control which currently has the keyboard focus.

Remarks

Note that this is a static function, so it can be called without needing a wxWindow pointer.

See also

wxWindow::FindWindow

wxWindow* FindWindow(long id) const

Find a child of this window, by identifier.

wxWindow* FindWindow(const wxString& name) const

Find a child of this window, by name.

wxPython note: In place of a single overloaded method name, wxPython implements the following methods:

FindWindowById(id)	Accepts an integer
FindWindowByName(name)	Accepts a string

wxWindow::FindWindowById

static wxWindow* FindWindowById(long id, wxWindow* parent = NULL)

Find the first window with the given id.

If parent is NULL, the search will start from all top-level frames and dialog boxes; if non-NULL, the search will be limited to the given window hierarchy. The search is recursive in both cases.

See also

wxWindow::FindWindowByName

static wxWindow* FindWindowByName(const wxString& name, wxWindow* parent = NULL)

If no window with such name is found, FindWindowByLabel is called.

See also

wxWindow::FindWindowByLabel

static wxWindow* FindWindowByLabel(const wxString& label, wxWindow* parent = NULL)

See also

wxWindow::Fit

virtual void Fit()

    window->SetClientSize(child->GetSize());

instead of calling Fit.

wxWindow::FitInside

virtual void FitInside()

wxWindow::Freeze

virtual void Freeze()

wxWindow::Close

bool Close(bool force = false)

This function simply generates a wxCloseEvent whose handler usually tries to close the window. It doesn't close the window itself, however.

Parameters

force

false

true

Remarks

The close handler should check whether the window is being deleted forcibly, using wxCloseEvent::CanVeto, in which case it should destroy the window using wxWindow::Destroy.

To guarantee that the window will be destroyed, call wxWindow::Destroy instead

wxWindow::ConvertDialogToPixels

wxPoint ConvertDialogToPixels(const wxPoint& pt)

wxSize ConvertDialogToPixels(const wxSize& sz)

Converts a point or size from dialog units to pixels.

For the x dimension, the dialog units are multiplied by the average character width and then divided by 4.

For the y dimension, the dialog units are multiplied by the average character height and then divided by 8.

Remarks

Dialog units are used for maintaining a dialog's proportions even if the font changes.

You can also use these functions programmatically. A convenience macro is defined:

#define wxDLG_UNIT(parent, pt) parent->ConvertDialogToPixels(pt)

See also

wxPython note: In place of a single overloaded method name, wxPython implements the following methods:

ConvertDialogPointToPixels(point)	Accepts and returns a wxPoint
ConvertDialogSizeToPixels(size)	Accepts and returns a wxSize

Additionally, the following helper functions are defined:

wxDLG_PNT(win, point)	Converts a wxPoint from dialog units to pixels
wxDLG_SZE(win, size)	Converts a wxSize from dialog units to pixels

wxWindow::ConvertPixelsToDialog

wxPoint ConvertPixelsToDialog(const wxPoint& pt)

wxSize ConvertPixelsToDialog(const wxSize& sz)

Converts a point or size from pixels to dialog units.

For the x dimension, the pixels are multiplied by 4 and then divided by the average character width.

For the y dimension, the pixels are multiplied by 8 and then divided by the average character height.

Remarks

Dialog units are used for maintaining a dialog's proportions even if the font changes.

See also

wxPython note: In place of a single overloaded method name, wxPython implements the following methods:

ConvertDialogPointToPixels(point)	Accepts and returns a wxPoint
ConvertDialogSizeToPixels(size)	Accepts and returns a wxSize

wxWindow::Destroy

virtual bool Destroy()

Return value

true if the window has either been successfully deleted, or it has been added to the list of windows pending real deletion.

wxWindow::DestroyChildren

virtual void DestroyChildren()

Destroys all children of a window. Called automatically by the destructor.

wxWindow::Disable

bool Disable()

Disables the window, same as Enable(false).

Return value

Returns true if the window has been disabled, false if it had been already disabled before the call to this function.

wxWindow::DoGetBestSize

virtual wxSize DoGetBestSize() const

Gets the size which best suits the window: for a control, it would be the minimal size which doesn't truncate the control, for a panel - the same size as it would have after a call to Fit().

wxWindow::DoUpdateWindowUI

virtual void DoUpdateWindowUI(wxUpdateUIEvent& event)

// do the window-specific processing after processing the update event
void wxTopLevelWindowBase::DoUpdateWindowUI(wxUpdateUIEvent& event)
{
    if ( event.GetSetEnabled() )
        Enable(event.GetEnabled());

    if ( event.GetSetText() )
    {
        if ( event.GetText() != GetTitle() )
            SetTitle(event.GetText());
    }
}

wxWindow::DragAcceptFiles

virtual void DragAcceptFiles(bool accept)

Enables or disables eligibility for drop file events (OnDropFiles).

Parameters

accept

true

false

Remarks

Windows only.

wxWindow::Enable

virtual bool Enable(bool enable = true)

Enable or disable the window for user input. Note that when a parent window is disabled, all of its children are disabled as well and they are reenabled again when the parent is.

Parameters

enable

true

false

Return value

Returns true if the window has been enabled or disabled, false if nothing was done, i.e. if the window had already been in the specified state.

wxWindow::FindFocus

static wxWindow* FindFocus()

Finds the window or control which currently has the keyboard focus.

Remarks

Note that this is a static function, so it can be called without needing a wxWindow pointer.

See also

wxWindow::FindWindow

wxWindow* FindWindow(long id) const

Find a child of this window, by identifier.

wxWindow* FindWindow(const wxString& name) const

Find a child of this window, by name.

wxPython note: In place of a single overloaded method name, wxPython implements the following methods:

FindWindowById(id)	Accepts an integer
FindWindowByName(name)	Accepts a string

wxWindow::FindWindowById

static wxWindow* FindWindowById(long id, wxWindow* parent = NULL)

Find the first window with the given id.

If parent is NULL, the search will start from all top-level frames and dialog boxes; if non-NULL, the search will be limited to the given window hierarchy. The search is recursive in both cases.

See also

wxWindow::FindWindowByName

static wxWindow* FindWindowByName(const wxString& name, wxWindow* parent = NULL)

If no window with such name is found, FindWindowByLabel is called.

See also

wxWindow::FindWindowByLabel

static wxWindow* FindWindowByLabel(const wxString& label, wxWindow* parent = NULL)

See also

wxWindow::Fit

virtual void Fit()

    window->SetClientSize(child->GetSize());

instead of calling Fit.

wxWindow::FitInside

virtual void FitInside()

wxWindow::Freeze

virtual void Freeze()

wxWindow::Close

bool Close(bool force = false)

This function simply generates a wxCloseEvent whose handler usually tries to close the window. It doesn't close the window itself, however.

Parameters

force

false

true

Remarks

The close handler should check whether the window is being deleted forcibly, using wxCloseEvent::CanVeto, in which case it should destroy the window using wxWindow::Destroy.

To guarantee that the window will be destroyed, call wxWindow::Destroy instead

wxWindow::ConvertDialogToPixels

wxPoint ConvertDialogToPixels(const wxPoint& pt)

wxSize ConvertDialogToPixels(const wxSize& sz)

Converts a point or size from dialog units to pixels.

For the x dimension, the dialog units are multiplied by the average character width and then divided by 4.

For the y dimension, the dialog units are multiplied by the average character height and then divided by 8.

Remarks

Dialog units are used for maintaining a dialog's proportions even if the font changes.

You can also use these functions programmatically. A convenience macro is defined:

#define wxDLG_UNIT(parent, pt) parent->ConvertDialogToPixels(pt)

See also

wxPython note: In place of a single overloaded method name, wxPython implements the following methods:

ConvertDialogPointToPixels(point)	Accepts and returns a wxPoint
ConvertDialogSizeToPixels(size)	Accepts and returns a wxSize

Additionally, the following helper functions are defined:

wxDLG_PNT(win, point)	Converts a wxPoint from dialog units to pixels
wxDLG_SZE(win, size)	Converts a wxSize from dialog units to pixels

wxWindow::ConvertPixelsToDialog

wxPoint ConvertPixelsToDialog(const wxPoint& pt)

wxSize ConvertPixelsToDialog(const wxSize& sz)

Converts a point or size from pixels to dialog units.

For the x dimension, the pixels are multiplied by 4 and then divided by the average character width.

For the y dimension, the pixels are multiplied by 8 and then divided by the average character height.

Remarks

Dialog units are used for maintaining a dialog's proportions even if the font changes.

See also

wxPython note: In place of a single overloaded method name, wxPython implements the following methods:

ConvertDialogPointToPixels(point)	Accepts and returns a wxPoint
ConvertDialogSizeToPixels(size)	Accepts and returns a wxSize

wxWindow::Destroy

virtual bool Destroy()

Return value

true if the window has either been successfully deleted, or it has been added to the list of windows pending real deletion.

wxWindow::DestroyChildren

virtual void DestroyChildren()

Destroys all children of a window. Called automatically by the destructor.

wxWindow::Disable

bool Disable()

Disables the window, same as Enable(false).

Return value

Returns true if the window has been disabled, false if it had been already disabled before the call to this function.

wxWindow::DoGetBestSize

virtual wxSize DoGetBestSize() const

Gets the size which best suits the window: for a control, it would be the minimal size which doesn't truncate the control, for a panel - the same size as it would have after a call to Fit().

wxWindow::DoUpdateWindowUI

virtual void DoUpdateWindowUI(wxUpdateUIEvent& event)

// do the window-specific processing after processing the update event
void wxTopLevelWindowBase::DoUpdateWindowUI(wxUpdateUIEvent& event)
{
    if ( event.GetSetEnabled() )
        Enable(event.GetEnabled());

    if ( event.GetSetText() )
    {
        if ( event.GetText() != GetTitle() )
            SetTitle(event.GetText());
    }
}

wxWindow::DragAcceptFiles

virtual void DragAcceptFiles(bool accept)

Enables or disables eligibility for drop file events (OnDropFiles).

Parameters

accept

true

false

Remarks

Windows only.

wxWindow::Enable

virtual bool Enable(bool enable = true)

Enable or disable the window for user input. Note that when a parent window is disabled, all of its children are disabled as well and they are reenabled again when the parent is.

Parameters

enable

true

false

Return value

Returns true if the window has been enabled or disabled, false if nothing was done, i.e. if the window had already been in the specified state.

wxWindow::FindFocus

static wxWindow* FindFocus()

Finds the window or control which currently has the keyboard focus.

Remarks

Note that this is a static function, so it can be called without needing a wxWindow pointer.

See also

wxWindow::FindWindow

wxWindow* FindWindow(long id) const

Find a child of this window, by identifier.

wxWindow* FindWindow(const wxString& name) const

Find a child of this window, by name.

wxPython note: In place of a single overloaded method name, wxPython implements the following methods:

FindWindowById(id)	Accepts an integer
FindWindowByName(name)	Accepts a string

wxWindow::FindWindowById

static wxWindow* FindWindowById(long id, wxWindow* parent = NULL)

Find the first window with the given id.

If parent is NULL, the search will start from all top-level frames and dialog boxes; if non-NULL, the search will be limited to the given window hierarchy. The search is recursive in both cases.

See also

wxWindow::FindWindowByName

static wxWindow* FindWindowByName(const wxString& name, wxWindow* parent = NULL)

If no window with such name is found, FindWindowByLabel is called.

See also

wxWindow::FindWindowByLabel

static wxWindow* FindWindowByLabel(const wxString& label, wxWindow* parent = NULL)

See also

wxWindow::Fit

virtual void Fit()

    window->SetClientSize(child->GetSize());

instead of calling Fit.

wxWindow::FitInside

virtual void FitInside()

wxWindow::Freeze

virtual void Freeze()

wxWindow::Close

bool Close(bool force = false)

This function simply generates a wxCloseEvent whose handler usually tries to close the window. It doesn't close the window itself, however.

Parameters

force

false

true

Remarks

The close handler should check whether the window is being deleted forcibly, using wxCloseEvent::CanVeto, in which case it should destroy the window using wxWindow::Destroy.

To guarantee that the window will be destroyed, call wxWindow::Destroy instead

wxWindow::ConvertDialogToPixels

wxPoint ConvertDialogToPixels(const wxPoint& pt)

wxSize ConvertDialogToPixels(const wxSize& sz)

Converts a point or size from dialog units to pixels.

For the x dimension, the dialog units are multiplied by the average character width and then divided by 4.

For the y dimension, the dialog units are multiplied by the average character height and then divided by 8.

Remarks

Dialog units are used for maintaining a dialog's proportions even if the font changes.

You can also use these functions programmatically. A convenience macro is defined:

#define wxDLG_UNIT(parent, pt) parent->ConvertDialogToPixels(pt)

See also

wxPython note: In place of a single overloaded method name, wxPython implements the following methods:

ConvertDialogPointToPixels(point)	Accepts and returns a wxPoint
ConvertDialogSizeToPixels(size)	Accepts and returns a wxSize

Additionally, the following helper functions are defined:

wxDLG_PNT(win, point)	Converts a wxPoint from dialog units to pixels
wxDLG_SZE(win, size)	Converts a wxSize from dialog units to pixels

wxWindow::ConvertPixelsToDialog

wxPoint ConvertPixelsToDialog(const wxPoint& pt)

wxSize ConvertPixelsToDialog(const wxSize& sz)

Converts a point or size from pixels to dialog units.

For the x dimension, the pixels are multiplied by 4 and then divided by the average character width.

For the y dimension, the pixels are multiplied by 8 and then divided by the average character height.

Remarks

Dialog units are used for maintaining a dialog's proportions even if the font changes.

See also

wxPython note: In place of a single overloaded method name, wxPython implements the following methods:

ConvertDialogPointToPixels(point)	Accepts and returns a wxPoint
ConvertDialogSizeToPixels(size)	Accepts and returns a wxSize

wxWindow::Destroy

virtual bool Destroy()

Return value

true if the window has either been successfully deleted, or it has been added to the list of windows pending real deletion.

wxWindow::DestroyChildren

virtual void DestroyChildren()

Destroys all children of a window. Called automatically by the destructor.

wxWindow::Disable

bool Disable()

Disables the window, same as Enable(false).

Return value

Returns true if the window has been disabled, false if it had been already disabled before the call to this function.

wxWindow::DoGetBestSize

virtual wxSize DoGetBestSize() const

Gets the size which best suits the window: for a control, it would be the minimal size which doesn't truncate the control, for a panel - the same size as it would have after a call to Fit().

wxWindow::DoUpdateWindowUI

virtual void DoUpdateWindowUI(wxUpdateUIEvent& event)

// do the window-specific processing after processing the update event
void wxTopLevelWindowBase::DoUpdateWindowUI(wxUpdateUIEvent& event)
{
    if ( event.GetSetEnabled() )
        Enable(event.GetEnabled());

    if ( event.GetSetText() )
    {
        if ( event.GetText() != GetTitle() )
            SetTitle(event.GetText());
    }
}

wxWindow::DragAcceptFiles

virtual void DragAcceptFiles(bool accept)

Enables or disables eligibility for drop file events (OnDropFiles).

Parameters

accept

true

false

Remarks

Windows only.

wxWindow::Enable

virtual bool Enable(bool enable = true)

Enable or disable the window for user input. Note that when a parent window is disabled, all of its children are disabled as well and they are reenabled again when the parent is.

Parameters

enable

true

false

Return value

Returns true if the window has been enabled or disabled, false if nothing was done, i.e. if the window had already been in the specified state.

wxWindow::FindFocus

static wxWindow* FindFocus()

Finds the window or control which currently has the keyboard focus.

Remarks

Note that this is a static function, so it can be called without needing a wxWindow pointer.

See also

wxWindow::FindWindow

wxWindow* FindWindow(long id) const

Find a child of this window, by identifier.

wxWindow* FindWindow(const wxString& name) const

Find a child of this window, by name.

wxPython note: In place of a single overloaded method name, wxPython implements the following methods:

FindWindowById(id)	Accepts an integer
FindWindowByName(name)	Accepts a string

wxWindow::FindWindowById

static wxWindow* FindWindowById(long id, wxWindow* parent = NULL)

Find the first window with the given id.

If parent is NULL, the search will start from all top-level frames and dialog boxes; if non-NULL, the search will be limited to the given window hierarchy. The search is recursive in both cases.

See also

wxWindow::FindWindowByName

static wxWindow* FindWindowByName(const wxString& name, wxWindow* parent = NULL)

If no window with such name is found, FindWindowByLabel is called.

See also

wxWindow::FindWindowByLabel

static wxWindow* FindWindowByLabel(const wxString& label, wxWindow* parent = NULL)

See also

wxWindow::Fit

virtual void Fit()

    window->SetClientSize(child->GetSize());

instead of calling Fit.

wxWindow::FitInside

virtual void FitInside()

wxWindow::Freeze

virtual void Freeze()

wxWindow::Close

bool Close(bool force = false)

This function simply generates a wxCloseEvent whose handler usually tries to close the window. It doesn't close the window itself, however.

Parameters

force

false

true

Remarks

The close handler should check whether the window is being deleted forcibly, using wxCloseEvent::CanVeto, in which case it should destroy the window using wxWindow::Destroy.

To guarantee that the window will be destroyed, call wxWindow::Destroy instead

wxWindow::ConvertDialogToPixels

wxPoint ConvertDialogToPixels(const wxPoint& pt)

wxSize ConvertDialogToPixels(const wxSize& sz)

Converts a point or size from dialog units to pixels.

For the x dimension, the dialog units are multiplied by the average character width and then divided by 4.

For the y dimension, the dialog units are multiplied by the average character height and then divided by 8.

Remarks

Dialog units are used for maintaining a dialog's proportions even if the font changes.

You can also use these functions programmatically. A convenience macro is defined:

#define wxDLG_UNIT(parent, pt) parent->ConvertDialogToPixels(pt)

See also

wxPython note: In place of a single overloaded method name, wxPython implements the following methods:

ConvertDialogPointToPixels(point)	Accepts and returns a wxPoint
ConvertDialogSizeToPixels(size)	Accepts and returns a wxSize

Additionally, the following helper functions are defined:

wxDLG_PNT(win, point)	Converts a wxPoint from dialog units to pixels
wxDLG_SZE(win, size)	Converts a wxSize from dialog units to pixels

wxWindow::ConvertPixelsToDialog

wxPoint ConvertPixelsToDialog(const wxPoint& pt)

wxSize ConvertPixelsToDialog(const wxSize& sz)

Converts a point or size from pixels to dialog units.

For the x dimension, the pixels are multiplied by 4 and then divided by the average character width.

For the y dimension, the pixels are multiplied by 8 and then divided by the average character height.

Remarks

Dialog units are used for maintaining a dialog's proportions even if the font changes.

See also