view release on metacpan or  search on metacpan

share/doc/wxwidgets.pod  view on Meta::CPAN

   bool Yield(bool onlyIfNeeded = false)

   Yields control to pending messages in the windowing system. This can
   be useful, for example, when a time-consuming process writes to a text
   window. Without an occasional yield, the text window will not be
   updated properly, and on systems with cooperative multitasking, such
   as Windows 3.1 other processes will not respond.

   Caution should be exercised, however, since yielding may allow the
   user to perform actions which are not compatible with the current
   task. Disabling menu items or whole menus during processing can avoid
   unwanted reentrance of code: see ::wxSafeYield for a better function.

   Note that Yield() will not flush the message logs. This is intentional
   as calling Yield() is usually done to quickly update the screen and
   popping up a message box dialog may be undesirable. If you do wish to
   flush the log messages immediately (otherwise it will be done during
   the next idle loop iteration), call wxLog::FlushActive.

   Calling Yield() recursively is normally an error and an assert failure
   is raised in debug build if such situation is detected. However if the
   onlyIfNeeded parameter is true, the method will just silently return
   false instead.

=head1 Wx::AppTraits

=head2 Wx::AppTraits::CreateFontMapper

   virtual wxFontMapper * CreateFontMapper()

   Creates the global font mapper object used for encodings/charset
   mapping.

=head2 Wx::AppTraits::CreateLogTarget

   virtual wxLog * CreateLogTarget()

   Creates the default log target for the application.

=head2 Wx::AppTraits::CreateMessageOutput

   virtual wxMessageOutput * CreateMessageOutput()

   Creates the global object used for printing out messages.

=head2 Wx::AppTraits::CreateRenderer

   virtual wxRendererNative * CreateRenderer()

   Returns the renderer to use for drawing the generic controls (return
   value may be NULL in which case the default renderer for the current
   platform is used); this is used in GUI mode only and always returns
   NULL in console.

   NOTE: returned pointer will be deleted by the caller.

=head2 Wx::AppTraits::GetDesktopEnvironment

   virtual wxString GetDesktopEnvironment() const

   This method returns the name of the desktop environment currently
   running in a Unix desktop. Currently only "KDE" or "GNOME" are
   supported and the code uses the X11 session protocol vendor name to
   figure out, which desktop environment is running. The method returns
   an empty string otherwise and on all other platforms.

=head2 Wx::AppTraits::GetStandardPaths

   virtual wxStandardPaths & GetStandardPaths()

   Returns the wxStandardPaths object for the application. It's normally
   the same for wxBase and wxGUI except in the case of wxMac and wxCocoa.

=head2 Wx::AppTraits::GetToolkitVersion

   virtual wxPortId GetToolkitVersion(int *major = NULL, int *minor =
   NULL)

   Returns the wxWidgets port ID used by the running program and
   eventually fills the given pointers with the values of the major and
   minor digits of the native toolkit currently used. The version numbers
   returned are thus detected at run-time and not compile-time (except
   when this is not possible e.g. wxMotif).

   E.g. if your program is using wxGTK port this function will return
   wxPORT_GTK and put in given pointers the versions of the GTK library
   in use.

   See wxPlatformInfo for more details.

=head2 Wx::AppTraits::HasStderr

   virtual bool HasStderr()

   Returns true if fprintf(stderr) goes somewhere, false otherwise.

=head2 Wx::AppTraits::IsUsingUniversalWidgets

   bool IsUsingUniversalWidgets() const

   Returns true if the library was built as wxUniversal. Always returns
   false for wxBase-only apps.

=head2 Wx::AppTraits::ShowAssertDialog

   virtual bool ShowAssertDialog(const wxString & msg)

   Shows the assert dialog with the specified message in GUI mode or just
   prints the string to stderr in console mode.

   Returns true to suppress subsequent asserts, false to continue as
   before.

=head1 Wx::ArchiveClassFactory

=head2 Wx::ArchiveClassFactory::Get/SetConv

   wxMBConv& GetConv() const

   void SetConv(wxMBConv& conv)

   The wxMBConv object that the created streams will use when translating
   meta-data. The initial default, set by the constructor, is
   wxConvLocal.

share/doc/wxwidgets.pod  view on Meta::CPAN

   The default constructor is private because you should never create
   objects of this type: they are only returned by wxMimeTypesManager
   methods.

=head2 Wx::FileType::DESTROY

   ~wxFileType()

   The destructor of this class is not virtual, so it should not be
   derived from.

=head2 Wx::FileType::GetMimeType

   bool GetMimeType(wxString* mimeType)

   If the function returns true, the string pointed to by mimeType is
   filled with full MIME type specification for this file type: for
   example, "text/plain".

=head2 Wx::FileType::GetMimeTypes

   bool GetMimeType(wxArrayString& mimeTypes)

   Same as GetMimeType but returns array of MIME types. This array will
   contain only one item in most cases but sometimes, notably under Unix
   with KDE, may contain more MIME types. This happens when one file
   extension is mapped to different MIME types by KDE, mailcap and
   mime.types.

=head2 Wx::FileType::GetExtensions

   bool GetExtensions(wxArrayString& extensions)

   If the function returns true, the array extensions is filled with all
   extensions associated with this file type: for example, it may contain
   the following two elements for the MIME type "text/html" (notice the
   absence of the leading dot): "html" and "htm".

   Windows: This function is currently not implemented: there is no
   (efficient) way to retrieve associated extensions from the given MIME
   type on this platform, so it will only return true if the wxFileType
   object was created by GetFileTypeFromExtension function in the first
   place.

=head2 Wx::FileType::GetIcon

   bool GetIcon(wxIconLocation * iconLoc)

   If the function returns true, the iconLoc is filled with the location
   of the icon for this MIME type. A wxIcon may be created from iconLoc
   later.

   Windows: The function returns the icon shown by Explorer for the files
   of the specified type.

   Mac: This function is not implemented and always returns false.

   Unix: MIME manager gathers information about icons from GNOME and KDE
   settings and thus GetIcon's success depends on availability of these
   desktop environments.

=head2 Wx::FileType::GetDescription

   bool GetDescription(wxString* desc)

   If the function returns true, the string pointed to by desc is filled
   with a brief description for this file type: for example, "text
   document" for the "text/plain" MIME type.

=head2 Wx::FileType::GetOpenCommand

   bool GetOpenCommand(wxString* command, MessageParameters& params)

   wxString GetOpenCommand(const wxString& filename)

   With the first version of this method, if the true is returned, the
   string pointed to by command is filled with the command which must be
   executed (see wxExecute) in order to open the file of the given type.
   In this case, the name of the file as well as any other parameters is
   retrieved from MessageParameters class.

   In the second case, only the filename is specified and the command to
   be used to open this kind of file is returned directly. An empty
   string is returned to indicate that an error occurred (typically
   meaning that there is no standard way to open this kind of files).

=head2 Wx::FileType::GetPrintCommand

   bool GetPrintCommand(wxString* command,MessageParameters& params)

   If the function returns true, the string pointed to by command is
   filled with the command which must be executed (see wxExecute) in
   order to print the file of the given type. The name of the file is
   retrieved from MessageParameters class.

=head2 Wx::FileType::ExpandCommand

   static wxString ExpandCommand(const wxString& command,
   MessageParameters& params)

   This function is primarily intended for GetOpenCommand and
   GetPrintCommand usage but may be also used by the application directly
   if, for example, you want to use some non-default command to open the
   file.

   The function replaces all occurrences of

=head1 Wx::FilterClassFactory

=head2 Wx::FilterClassFactory::CanHandle

   bool CanHandle(const wxChar* protocol, wxStreamProtocolType type =
   wxSTREAM_PROTOCOL) const

   Returns true if this factory can handle the given protocol, MIME type,
   HTTP encoding or file extension.

   When using wxSTREAM_FILEEXT for the second parameter, the first
   parameter can be a complete filename rather than just an extension.