git.maemo.org Git - pkg-perl/blob - deb-src/libwx-perl/libwx-perl-0.96/blib/man3/Wx::Perl::SplashFast.3pm

   1 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sh \" Subsection heading
   6 .br
   7 .if t .Sp
   8 .ne 5
   9 .PP
  10 \fB\\$1\fR
  11 .PP
  12 ..
  13 .de Sp \" Vertical space (when we can't use .PP)
  14 .if t .sp .5v
  15 .if n .sp
  16 ..
  17 .de Vb \" Begin verbatim text
  18 .ft CW
  19 .nf
  20 .ne \\$1
  21 ..
  22 .de Ve \" End verbatim text
  23 .ft R
  24 .fi
  25 ..
  26 .\" Set up some character translations and predefined strings.  \*(-- will
  27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  28 .\" double quote, and \*(R" will give a right double quote.  | will give a
  29 .\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
  30 .\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
  31 .\" expand to `' in nroff, nothing in troff, for use with C<>.
  32 .tr \(*W-|\(bv\*(Tr
  33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  34 .ie n \{\
  35 .    ds -- \(*W-
  36 .    ds PI pi
  37 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  38 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  39 .    ds L" ""
  40 .    ds R" ""
  41 .    ds C` ""
  42 .    ds C' ""
  43 'br\}
  44 .el\{\
  45 .    ds -- \|\(em\|
  46 .    ds PI \(*p
  47 .    ds L" ``
  48 .    ds R" ''
  49 'br\}
  50 .\"
  51 .\" If the F register is turned on, we'll generate index entries on stderr for
  52 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
  53 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  54 .\" output yourself in some meaningful fashion.
  55 .if \nF \{\
  56 .    de IX
  57 .    tm Index:\\$1\t\\n%\t"\\$2"
  58 ..
  59 .    nr % 0
  60 .    rr F
  61 .\}
  62 .\"
  63 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
  64 .\" way too many mistakes in technical documents.
  65 .hy 0
  66 .if n .na
  67 .\"
  68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  70 .    \" fudge factors for nroff and troff
  71 .if n \{\
  72 .    ds #H 0
  73 .    ds #V .8m
  74 .    ds #F .3m
  75 .    ds #[ \f1
  76 .    ds #] \fP
  77 .\}
  78 .if t \{\
  79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  80 .    ds #V .6m
  81 .    ds #F 0
  82 .    ds #[ \&
  83 .    ds #] \&
  84 .\}
  85 .    \" simple accents for nroff and troff
  86 .if n \{\
  87 .    ds ' \&
  88 .    ds ` \&
  89 .    ds ^ \&
  90 .    ds , \&
  91 .    ds ~ ~
  92 .    ds /
  93 .\}
  94 .if t \{\
  95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 101 .\}
 102 .    \" troff and (daisy-wheel) nroff accents
 103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 110 .ds ae a\h'-(\w'a'u*4/10)'e
 111 .ds Ae A\h'-(\w'A'u*4/10)'E
 112 .    \" corrections for vroff
 113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 115 .    \" for low resolution devices (crt and lpr)
 116 .if \n(.H>23 .if \n(.V>19 \
 117 \{\
 118 .    ds : e
 119 .    ds 8 ss
 120 .    ds o a
 121 .    ds d- d\h'-1'\(ga
 122 .    ds D- D\h'-1'\(hy
 123 .    ds th \o'bp'
 124 .    ds Th \o'LP'
 125 .    ds ae ae
 126 .    ds Ae AE
 127 .\}
 128 .rm #[ #] #H #V #F C
 129 .\" ========================================================================
 130 .\"
 131 .IX Title "SplashFast 3"
 132 .TH SplashFast 3 "2009-12-25" "perl v5.8.3" "User Contributed Perl Documentation"
 133 .SH "NAME"
 134 Wx::Perl::SplashFast \- Fast splash screen for the Wx module.
 135 .SH "SYNOPSIS"
 136 .IX Header "SYNOPSIS"
 137 .Vb 2
 138 \&  use Wx::Perl::SplashFast ('/path/to/logo.jpg',3000);
 139 \&  # timeout in milliseconds
 140 .Ve
 141 .PP
 142 .Vb 2
 143 \&  package myApp ;
 144 \&  # subclass Wx::App ...
 145 .Ve
 146 .PP
 147 .Vb 2
 148 \&  package myFrame;
 149 \&  # subclass Wx::Frame ...
 150 .Ve
 151 .PP
 152 .Vb 1
 153 \&  package main;
 154 .Ve
 155 .PP
 156 .Vb 2
 157 \&  my $myApp = myApp->new();
 158 \&  my $frame = myFrame->new();
 159 .Ve
 160 .PP
 161 .Vb 1
 162 \&  $myApp->MainLoop();
 163 .Ve
 164 .SH "DESCRIPTION"
 165 .IX Header "DESCRIPTION"
 166 Using Wx::SplashScreen from Wx::App::OnInit may cause a high delay
 167 before the splash screen is shown on low end machines.
 168 .PP
 169 This module works around this limitation; you just need to follow the
 170 example.
 171 .SH "USAGE"
 172 .IX Header "USAGE"
 173 Just put the code inside the '\s-1BEGIN\s0 {}' of your main app, like:
 174 .PP
 175 .Vb 4
 176 \&  sub BEGIN {
 177 \&    use Wx::Perl::SplashFast ;
 178 \&    Wx::Perl::SplashFast->new("./logo.jpg",5000);
 179 \&  }
 180 .Ve
 181 .PP
 182 or load the module before any other:
 183 .PP
 184 .Vb 3
 185 \&  use Wx::Perl::SplashFast ("./logo.jpg",5000) ;
 186 \&  use Wx ;
 187 \&  ...
 188 .Ve
 189 .Sh "import ( \s-1IMG_FILE\s0, \s-1SPLASH_TIMEOUT\s0 )"
 190 .IX Subsection "import ( IMG_FILE, SPLASH_TIMEOUT )"
 191 .IP "\s-1IMG_FILE\s0" 10
 192 .IX Item "IMG_FILE"
 193 Path of the image file to show.
 194 .IP "\s-1SPLASH_TIMEOUT\s0" 10
 195 .IX Item "SPLASH_TIMEOUT"
 196 Timeout of the splash screen in milliseconds.
 197 .PP
 198 If you \f(CW\*(C`use Wx::Perl::SplashFast './logo.jpg', 1000;\*(C'\fR this has the same
 199 affetc as.
 200 .PP
 201 .Vb 4
 202 \&  BEGIN {
 203 \&    require Wx::Perl::SplashFast;
 204 \&    Wx::Perl::SplashFast->new( './logo.jpg', 1000 );
 205 \&  }
 206 .Ve
 207 .Sh "new ( \s-1IMG_FILE\s0 , \s-1SPLASH_TIMEOUT\s0 )"
 208 .IX Subsection "new ( IMG_FILE , SPLASH_TIMEOUT )"
 209 Show the splash screen.
 210 .IP "\s-1IMG_FILE\s0" 10
 211 .IX Item "IMG_FILE"
 212 Path of the image file to show.
 213 .IP "\s-1SPLASH_TIMEOUT\s0" 10
 214 .IX Item "SPLASH_TIMEOUT"
 215 Timeout of the splash screen in milliseconds.
 216 .SH "EXAMPLE"
 217 .IX Header "EXAMPLE"
 218 .Vb 2
 219 \&  use Wx::Perl::SplashFast ("./logo.jpg",5000) ;
 220 \&  # Don't forget to put your own image in the same path. Duh
 221 .Ve
 222 .PP
 223 .Vb 3
 224 \&  package myApp ;
 225 \&  use base 'Wx::App';
 226 \&  sub OnInit { return(@_[0]) ;}
 227 .Ve
 228 .PP
 229 .Vb 3
 230 \&  package myFrame ;
 231 \&  use base 'Wx::Frame';
 232 \&  use Wx qw( wxDEFAULT_FRAME_STYLE );
 233 .Ve
 234 .PP
 235 .Vb 6
 236 \&  sub new {
 237 \&    my $app = shift ;
 238 \&    my( $frame ) = $app->SUPER::new( @_[0] , -1, 'wxPerl Test' ,
 239 \&                                     [0,0] , [400,300] ) ;
 240 \&    return( $frame ) ;
 241 \&  }
 242 .Ve
 243 .PP
 244 .Vb 2
 245 \&  package main ;
 246 \&  use Wx ;
 247 .Ve
 248 .PP
 249 .Vb 1
 250 \&  my $myApp = myApp->new() ;
 251 .Ve
 252 .PP
 253 .Vb 3
 254 \&  print "window\en" ;
 255 \&  my $win = myFrame->new() ;
 256 \&  $win->Show(1) ;
 257 .Ve
 258 .PP
 259 .Vb 2
 260 \&  $myApp->SetTopWindow( $win ) ;
 261 \&  $myApp->MainLoop();
 262 .Ve
 263 .SH "SEE ALSO"
 264 .IX Header "SEE ALSO"
 265 Wx, <Wx:SplashScreen>
 266 .SH "AUTHOR"
 267 .IX Header "AUTHOR"
 268 Graciliano M. P. <gm@virtuasites.com.br>
 269 Thanks to wxWidgets people and Mattia Barbon for wxPerl! :P
 270 .SH "COPYRIGHT"
 271 .IX Header "COPYRIGHT"
 272 This program is free software; you can redistribute it and/or
 273 modify it under the same terms as Perl itself.