Under Windows, puts a query button on the caption. When pressed,
Windows will go into a context-sensitive help mode and wxWidgets
will send a wxEVT_HELP event if the user clicked on an application window.
- This style cannot be used together with wxMAXIMIZE_BOX or wxMINIMIZE_BOX, so
- these two styles are automatically turned of if this one is used.
+ This style cannot be used (because of the underlying native behaviour)
+ together with @c wxMAXIMIZE_BOX or @c wxMINIMIZE_BOX, so these two styles
+ are automatically turned off if this one is used.
@style{wxWS_EX_PROCESS_IDLE}
This window should always process idle events, even if the mode set
by wxIdleEvent::SetMode is wxIDLE_PROCESS_SPECIFIED.
@see FindWindow()
*/
- static wxWindow* FindWindowById(long id, wxWindow* parent = NULL);
+ static wxWindow* FindWindowById(long id, const wxWindow* parent = 0);
/**
Find a window by its label.
@see FindWindow()
*/
static wxWindow* FindWindowByLabel(const wxString& label,
- wxWindow* parent = NULL);
+ const wxWindow* parent = 0);
/**
- Find a window by its name (as given in a window constructor or @b Create
+ Find a window by its name (as given in a window constructor or Create()
function call).
If @a parent is @NULL, the search will start from all top-level frames
@see FindWindow()
*/
static wxWindow* FindWindowByName(const wxString& name,
- wxWindow* parent = NULL);
+ const wxWindow* parent = 0);
/**
Sizes the window so that it fits around its subwindows.
*/
wxWindow* GetParent() const;
+ //@{
/**
This function shows a popup menu at the given position in this window and
- returns the selected id. It can be more convenient than the general purpose
- PopupMenu() function for simple menus proposing a choice in a list of
- strings to the user.
+ returns the selected id.
- @param menu
- The menu to show
- @param pos
- The position at which to show the menu in client coordinates
+ It can be more convenient than the general purpose PopupMenu() function
+ for simple menus proposing a choice in a list of strings to the user.
- @return The selected menu item id or wxID_NONE if none selected or an
- error occurred.
- */
- int GetPopupMenuSelectionFromUser(wxMenu& menu, const wxPoint& pos);
+ Notice that to avoid unexpected conflicts between the (usually
+ consecutive range of) ids used by the menu passed to this function and
+ the existing EVT_UPDATE_UI() handlers, this function temporarily
+ disables UI updates for the window, so you need to manually disable
+ (or toggle or ...) any items which should be disabled in the menu
+ before showing it.
- /**
- See the GetPopupMenuSelectionFromUser(wxMenu&, const wxPoint&) overload.
- This overload differs only because it takes two integers for the
- menu position instead of a wxPoint.
+ The parameter @a menu is the menu to show.
+ The parameter @a pos (or the parameters @a x and @a y) is the
+ position at which to show the menu in client coordinates.
+
+ @return
+ The selected menu item id or @c wxID_NONE if none selected or an
+ error occurred.
+
+ @since 2.9.0
*/
+ int GetPopupMenuSelectionFromUser(wxMenu& menu, const wxPoint& pos);
int GetPopupMenuSelectionFromUser(wxMenu& menu, int x, int y);
+ //@}
/**
This gets the position of the window in pixels, relative to the parent window
*/
virtual wxSize GetWindowBorderSize() const;
+ //@{
/**
- Gets the window style that was passed to the constructor or @b Create
- method. @b GetWindowStyle() is another name for the same function.
+ Gets the window style that was passed to the constructor or Create()
+ method. GetWindowStyle() is another name for the same function.
*/
virtual long GetWindowStyleFlag() const;
+ long GetWindowStyle() const;
+ //@}
/**
Returns the value previously passed to SetWindowVariant().
Invokes the constraint-based layout algorithm or the sizer-based algorithm
for this window.
- See SetAutoLayout(): when auto layout is on, this function gets called automatically
- when the window is resized.
+ This function does not get called automatically when the window is resized
+ because lots of windows deriving from wxWindow does not need this functionality.
+ If you want to have Layout() called automatically, you should derive
+ from wxPanel (see wxPanel::Layout).
@see @ref overview_windowsizing
*/
/**
Lowers the window to the bottom of the window hierarchy (Z-order).
+ @remarks
+ This function only works for wxTopLevelWindow-derived classes.
+
@see Raise()
*/
virtual void Lower();
/**
Raises the window to the top of the window hierarchy (Z-order).
- In current version of wxWidgets this works both for managed and child windows.
+
+ @remarks
+ This function only works for wxTopLevelWindow-derived classes.
@see Lower()
*/
updated when its size changes.
@param autoLayout
- Set this to @true if you wish the Layout function to be
- called automatically when the window is resized.
+ Set this to @true if you wish the Layout() function to be
+ called automatically when the window is resized
+ (really happens only if you derive from wxPanel or wxTopLevelWindow).
@see SetConstraints()
*/
@param thumbSize
The size of the thumb, or visible portion of the scrollbar, in scroll units.
@param range
- The maximum position of the scrollbar.
+ The maximum position of the scrollbar. Value of -1 can be used to
+ ask for the scrollbar to be shown but in the disabled state: this
+ can be used to avoid removing the scrollbar even when it is not
+ needed (currently this is only implemented in wxMSW port).
@param refresh
@true to redraw the scrollbar, @false otherwise.
virtual void SetSize(int width, int height);
//@}
+ /**
+ Use of this function for windows which are not toplevel windows
+ (such as wxDialog or wxFrame) is discouraged.
+ Please use SetMinSize() and SetMaxSize() instead.
+
+ @see wxTopLevelWindow::SetSizeHints
+ */
+ void SetSizeHints( const wxSize& minSize,
+ const wxSize& maxSize=wxDefaultSize,
+ const wxSize& incSize=wxDefaultSize);
+
/**
Sets the window to have the given layout sizer.
The window will then own the object, and will take care of its deletion.
void SetVirtualSize(const wxSize& size);
//@}
- /**
- Identical to SetWindowStyleFlag().
- */
- void SetWindowStyle(long style);
-
+ //@{
/**
Sets the style of the window. Please note that some styles cannot be changed
after the window creation and that Refresh() might need to be be called
@see GetWindowStyleFlag()
*/
virtual void SetWindowStyleFlag(long style);
+ void SetWindowStyle(long style);
+ //@}
/**
This function can be called under all platforms but only does anything under
// Global functions/macros
// ============================================================================
-/** @ingroup group_funcmacro_misc */
+/** @addtogroup group_funcmacro_misc */
//@{
/**
projects / wxWidgets.git / blobdiff