This member function is not normally called in application code.
Instead, it can be implemented in a derived class to return
default wxComboPopup, incase @c popup is @NULL.
- @b Note: If you have implemented OnButtonClick to do
+ @note If you have implemented OnButtonClick to do
something else than show the popup, then DoSetPopupControl
must always return @NULL.
*/
/**
Returns the insertion point for the combo control's text field.
- @b Note: Under wxMSW, this function always returns 0 if the combo control
+ @note Under wxMSW, this function always returns 0 if the combo control
doesn't have the focus.
*/
long GetInsertionPoint() const;
Implement in a derived class to define what happens on
dropdown button click.
Default action is to show the popup.
- @b Note: If you implement this to do something else than
+ @note If you implement this to do something else than
show the popup, you must then also implement
DoSetPopupControl() to always
return @NULL.
/**
Returns the insertion point for the combobox's text field.
- @b Note: Under wxMSW, this function always returns 0 if the combobox
+ @note Under wxMSW, this function always returns 0 if the combobox
doesn't have the focus.
*/
long GetInsertionPoint() const;
you may forget about calling @e Set(). When @e Get() is called and there
is no current object, it will create one using @e Create() function. To
disable this behaviour @e DontCreateOnDemand() is provided.
- @b Note: You should use either @e Set() or @e Get() because wxWidgets
+ @note You should use either @e Set() or @e Get() because wxWidgets
library itself would take advantage of it and could save various information
in it. For example wxFontMapper or Unix version
of wxFileDialog have the ability to use wxConfig class.
@class wxControl
@wxheader{control.h}
- This is the base class for a control or "widget''.
+ This is the base class for a control or "widget".
A control is generally a small window which processes user input and/or
displays one or more item of data.
@a circleCenter are the relative coordinates of centre of the circle in
the specified @e rect. If not specified, the cercle is placed at the
centre of rect.
- @b Note: Currently this function is very slow, don't use it for
+ @note Currently this function is very slow, don't use it for
real-time drawing.
*/
void GradientFillConcentric(const wxRect& rect,
message and this member is called. The application should derive a
member to intercept this message and return a connection object of
either the standard wxDDEConnection type, or of a user-derived type. If the
- topic is "STDIO'', the application may wish to refuse the connection.
+ topic is "STDIO", the application may wish to refuse the connection.
Under UNIX, when a server is created the OnAcceptConnection message is
always sent for standard input and output, but in the context of DDE
messages it doesn't make a lot of sense.
wxDocManager* GetDocumentManager() const;
/**
- Gets the frame associated with the view (if any). Note that this "frame'' is
+ Gets the frame associated with the view (if any). Note that this "frame" is
not a wxFrame at all in the generic MDI implementation which uses the notebook
pages instead of the frames and this is why this method returns a wxWindow and
not a wxFrame.
Sets the frame associated with this view. The application should call this
if possible, to tell the view about the frame.
See GetFrame() for the explanation about the mismatch
- between the "Frame'' in the method name and the type of its parameter.
+ between the "Frame" in the method name and the type of its parameter.
*/
void SetFrame(wxWindow* frame);
without leading dot. All three of them may be empty if the corresponding
component is. The old contents of the strings pointed to by these parameters
will be overwritten in any case (if the pointers are not @NULL).
- Note that for a filename "foo.'' the extension is present, as indicated by the
+ Note that for a filename "foo." the extension is present, as indicated by the
trailing dot, but empty. If you need to cope with such cases, you should use
@a hasExt instead of relying on testing whether @a ext is empty or not.
*/
It provides more information than wxWindow's input stream
(stream, filename, mime type, anchor).
- @b Note: Any pointer returned by a method of wxFSFile is valid
+ @note Any pointer returned by a method of wxFSFile is valid
only as long as the wxFSFile object exists. For example a call to GetStream()
doesn't @e create the stream but only returns the pointer to it. In
other words after 10 calls to GetStream() you will have obtained ten identical
Returns the anchor if present in the location.
See @ref wxFSFile::getanchor wxFSFile for details.
Example: GetAnchor("index.htm#chapter2") == "chapter2"
- @b Note: the anchor is NOT part of the left location.
+ @note the anchor is NOT part of the left location.
*/
wxString GetAnchor(const wxString& location) const;
rectangle thus change by 2*@a dx and 2*@e dy, respectively.) If one or
both of @a dx and @a dy are negative, the opposite happens: the rectangle
size decreases in the respective direction.
- Inflating and deflating behaves "naturally''. Defined more precisely, that
+ Inflating and deflating behaves "naturally". Defined more precisely, that
means:
- "Real'' inflates (that is, @a dx and/or @a dy = 0) are not
+ "Real" inflates (that is, @a dx and/or @a dy = 0) are not
constrained. Thus inflating a rectangle can cause its upper left corner
to move into the negative numbers. (the versions prior to 2.5.4 forced
the top left coordinate to not fall below (0, 0), which implied a
@wxheader{gdicmn.h}
wxWidgets maintains a database of standard RGB colours for a predefined
- set of named colours (such as "BLACK'', "LIGHT GREY''). The
+ set of named colours (such as "BLACK", "LIGHT GREY"). The
application may add to this set if desired by using
wxColourDatabase::AddColour and may use it to look up
colours by names using wxColourDatabase::Find or find the names
Returns pointer to the first cell in the list.
You can then use child's GetNext()
method to obtain pointer to the next cell in list.
- @b Note: This shouldn't be used by the end user. If you need some way of
+ @note This shouldn't be used by the end user. If you need some way of
finding particular cell in the list, try Find() method
instead.
*/
/**
Returns the indentation. @a ind is one of the @b wxHTML_INDENT_* constants.
- @b Note: You must call GetIndentUnits()
+ @note You must call GetIndentUnits()
with same @a ind parameter in order to correctly interpret the returned integer
value.
It is NOT always in pixels!
/**
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"
+ " or '/' characters. (So the name of @c FONT SIZE=+2 tag is "FONT"
and name of @c /table is "TABLE")
*/
wxString GetName() const;
/**
Returns (average) char height in standard font. It is used as DC-independent
metrics.
- @b Note: This function doesn't return the @e actual height. If you want to
+ @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() const;
/**
Returns average char width in standard font. It is used as DC-independent
metrics.
- @b Note: This function doesn't return the @e actual width. If you want to
+ @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() const;
# ....
# use the functions
- print gettext( ``Panic!'' );
+ print gettext( "Panic!" );
- button = Wx::Button-new( window, -1, gettext( ``Label'' ) );
+ button = Wx::Button-new( window, -1, gettext( "Label" ) );
@endcode
If you need to translate a lot of strings, then adding gettext( ) around
# ...
# use the functions
- print t( ``Panic!!'' );
+ print t( "Panic!!" );
# ...
@endcode
compatibility only and usage of this class is strongly deprecated.
In the documentation below, the type @c T should be thought of as a
- "template'' parameter: this is the type of data stored in the linked list or,
+ "template" parameter: this is the type of data stored in the linked list or,
in other words, the first argument of WX_DECLARE_LIST macro. Also, wxNode is
written as wxNodeT even though it isn't really a template class -- but it
helps to think of it as if it were.
public:
/**
Constructs a wxMenuItem object.
- Menu items can be standard, or "stock menu items'', or custom. For the
+ Menu items can be standard, or "stock menu items", or custom. For the
standard menu items (such as commands to open a file, exit the program and so
on, see @ref overview_stockitems "stock items" for the full list) it is enough
to
Identifier for this menu item, or wxID_SEPARATOR to indicate a separator.
@param text
Text for the menu item, as shown on the menu. An accelerator
- key can be specified using the ampersand '' character. In order to embed an
+ key can be specified using the ampersand " character. In order to embed an
ampersand character in the menu item text, the ampersand must be doubled.
@param helpString
Optional help string that will be shown on the status bar.
An example of mini frame can be seen in the @ref overview_sampledialogs
"dialogs sample"
- using the "Mini frame'' command of the "Generic dialogs'' submenu.
+ using the "Mini frame" command of the "Generic dialogs" submenu.
@beginStyleTable
@style{wxICONIZE}:
deleted when the smart pointer goes out of scope. This class is different from
the @c std::auto_ptr in so far as it doesn't provide copy constructor
nor assignment operator. This limits what you can do with it but is much less
- surprizing than the "destructive copy'' behaviour of the standard class.
+ surprizing than the "destructive copy" behaviour of the standard class.
@library{wxbase}
@category{FIXME}
@wxheader{ptr_scpd.h}
This is a variation on the topic of wxScopedPtr. This
- class is also a smart pointer but in addition it "ties'' the pointer value to
+ class is also a smart pointer but in addition it "ties" the pointer value to
another variable. In other words, during the life time of this class the value
of that variable is set to be the same as the value of the pointer itself and
it is reset to its old value when the object is destroyed. This class is
~wxRecursionGuard();
/**
- Returns @true if we're already inside the code block "protected'' by this
+ Returns @true if we're already inside the code block "protected" by this
wxRecursionGuard (i.e. between this line and the end of current scope). Usually
the function using wxRecursionGuard takes some specific actions in such case
(may be simply returning) to prevent reentrant calls to itself.
thus allowing you to only modify some of its methods -- without having to
reimplement all of them.
- Note that the "normal'', inheritance-based approach, doesn't work with the
+ Note that the "normal", inheritance-based approach, doesn't work with the
renderers as it is impossible to derive from a class unknown at compile-time
and the renderer is only chosen at run-time. So suppose that you want to only
add something to the drawing of the tree control buttons but leave all the
Except for the constructor, it has exactly the same methods as
wxRendererNative and their implementation is
- trivial: they are simply forwarded to the real renderer. Note that the "real''
+ trivial: they are simply forwarded to the real renderer. Note that the "real"
renderer may, in turn, be a wxDelegateRendererNative as well and that there may
be arbitrarily many levels like this -- but at the end of the chain there must
be a real renderer which does the drawing.
First, a brief introduction to wxRenderer and why it is needed.
Usually wxWidgets uses the underlying low level GUI system to draw all the
- controls - this is what we mean when we say that it is a "native'' framework.
+ controls - this is what we mean when we say that it is a "native" framework.
However not all controls exist under all (or even any) platforms and in this
case wxWidgets provides a default, generic, implementation of them written in
wxWidgets itself.
message and this member is called. The application should derive a
member to intercept this message and return a connection object of
either the standard wxTCPConnection type, or of a user-derived type. If the
- topic is "STDIO'', the application may wish to refuse the connection.
+ topic is "STDIO", the application may wish to refuse the connection.
Under Unix, when a server is created the OnAcceptConnection message is
always sent for standard input and output.
*/
wxString GetExecutablePath() const;
/**
- @b Note: This function is only available under Unix.
+ @note This function is only available under Unix.
Return the program installation prefix, e.g. @c /usr, @c /opt or
@c /home/zeitlin.
If the prefix had been previously by
wxString GetUserLocalDataDir() const;
/**
- @b Note: This function is only available under Unix.
+ @note This function is only available under Unix.
Lets wxStandardPaths know about the real program installation prefix on a Unix
system. By default, the value returned by
GetInstallPrefix() is used.
after constructing it before it actually starts sending notifications. It can
be stopped later with wxTimer::Stop.
- @b Note: A timer can only be used from the main thread.
+ @note A timer can only be used from the main thread.
@library{wxbase}
@category{misc}
In this mode, the empty tokens in the
middle of the string will be returned, i.e. @c "a::b:" will be tokenized in
- three tokens 'a', '' and 'b'. Notice that all trailing delimiters are ignored
+ three tokens 'a', " and 'b'. Notice that all trailing delimiters are ignored
in this mode, not just the last one, i.e. a string @c "a::b::" would
still result in the same set of tokens.
/**
Obtains the fragment of this URI.
The fragment of a URI is the last value of the URI,
- and is the value after a '' character after the path
+ and is the value after a " character after the path
of the URI.
@c http://mysite.com/mypath#fragment
*/
have a little better run-time performance. The role of wxWeakRefDynamic
is to handle objects which derived type one does not know.
- @b Note: wxWeakRefT selects an implementation based on the static type
+ @note wxWeakRefT selects an implementation based on the static type
of T. If T does not have wxTrackable statically, it defaults to to a mixed-
mode operation, where it uses @c dynamic_cast as the last measure (if
available from the compiler and enabled when building wxWidgets).
ignore under other platforms. Under Mac, it will change the size of the
returned font. See SetWindowVariant()
for more about this.
- This static method is "overridden'' in many derived classes and so calling,
+ This static method is "overridden" in many derived classes and so calling,
for example, wxButton::GetClassDefaultAttributes() will typically
return the values appropriate for a button which will be normally different
from those returned by, say, wxListCtrl::GetClassDefaultAttributes().
the call is automatically dispatched to the correct class (as usual with
virtual functions) and you don't have to specify the class name explicitly.
The other one is that in the future this function could return different
- results, for example it might return a different font for an "Ok'' button
+ results, for example it might return a different font for an "Ok" button
than for a generic button if the users GUI is configured to show such buttons
in bold font. Of course, the down side is that it is impossible to call this
function without actually having an object to apply it to whereas the static
This function is (or should be, in case of custom controls) called during
window creation to intelligently set up the window visual attributes, that is
the font and the foreground and background colours.
- By "intelligently'' the following is meant: by default, all windows use their
+ By "intelligently" the following is meant: by default, all windows use their
own @ref getclassdefaultattributes() default attributes. However
if some of the parents attributes are explicitly (that is, using
SetFont() and not
}
@endcode
- @b Note: if you want to preserve the original formatting of the loaded file
+ @note if you want to preserve the original formatting of the loaded file
including whitespaces
and indentation, you need to turn off whitespace-only textnode removal and
automatic indentation:
projects / wxWidgets.git / commitdiff
